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 "BufferEncodings.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 (!parent() && !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         // Important: Keep the version formatting in sync with lyx2lyx and
1408         //            tex2lyx (bug 7951)
1409         ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1410             << " created this file. For more info see http://www.lyx.org/\n"
1411             << "\\lyxformat " << LYX_FORMAT << "\n"
1412             << "\\begin_document\n";
1413
1414         /// For each author, set 'used' to true if there is a change
1415         /// by this author in the document; otherwise set it to 'false'.
1416         AuthorList::Authors::const_iterator a_it = params().authors().begin();
1417         AuthorList::Authors::const_iterator a_end = params().authors().end();
1418         for (; a_it != a_end; ++a_it)
1419                 a_it->setUsed(false);
1420
1421         ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1422         ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1423         for ( ; it != end; ++it)
1424                 it->checkAuthors(params().authors());
1425
1426         // now write out the buffer parameters.
1427         ofs << "\\begin_header\n";
1428         params().writeFile(ofs);
1429         ofs << "\\end_header\n";
1430
1431         // write the text
1432         ofs << "\n\\begin_body\n";
1433         text().write(ofs);
1434         ofs << "\n\\end_body\n";
1435
1436         // Write marker that shows file is complete
1437         ofs << "\\end_document" << endl;
1438
1439         // Shouldn't really be needed....
1440         //ofs.close();
1441
1442         // how to check if close went ok?
1443         // Following is an attempt... (BE 20001011)
1444
1445         // good() returns false if any error occured, including some
1446         //        formatting error.
1447         // bad()  returns true if something bad happened in the buffer,
1448         //        which should include file system full errors.
1449
1450         bool status = true;
1451         if (!ofs) {
1452                 status = false;
1453                 lyxerr << "File was not closed properly." << endl;
1454         }
1455
1456         return status;
1457 }
1458
1459
1460 bool Buffer::makeLaTeXFile(FileName const & fname,
1461                            string const & original_path,
1462                            OutputParams const & runparams_in,
1463                            OutputWhat output) const
1464 {
1465         OutputParams runparams = runparams_in;
1466
1467         // This is necessary for LuaTeX/XeTeX with tex fonts.
1468         // See FIXME in BufferParams::encoding()
1469         if (runparams.isFullUnicode())
1470                 runparams.encoding = encodings.fromLyXName("utf8-plain");
1471
1472         string const encoding = runparams.encoding->iconvName();
1473         LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1474
1475         ofdocstream ofs;
1476         try { ofs.reset(encoding); }
1477         catch (iconv_codecvt_facet_exception const & e) {
1478                 lyxerr << "Caught iconv exception: " << e.what() << endl;
1479                 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1480                         "verify that the support software for your encoding (%1$s) is "
1481                         "properly installed"), from_ascii(encoding)));
1482                 return false;
1483         }
1484         if (!openFileWrite(ofs, fname))
1485                 return false;
1486
1487         //TexStream ts(ofs.rdbuf(), &texrow());
1488         ErrorList & errorList = d->errorLists["Export"];
1489         errorList.clear();
1490         bool failed_export = false;
1491         otexstream os(ofs, d->texrow);
1492
1493         // make sure we are ready to export
1494         // this needs to be done before we validate
1495         // FIXME Do we need to do this all the time? I.e., in children
1496         // of a master we are exporting?
1497         updateBuffer();
1498         updateMacroInstances(OutputUpdate);
1499
1500         try {
1501                 os.texrow().reset();
1502                 writeLaTeXSource(os, original_path, runparams, output);
1503         }
1504         catch (EncodingException const & e) {
1505                 odocstringstream ods;
1506                 ods.put(e.failed_char);
1507                 ostringstream oss;
1508                 oss << "0x" << hex << e.failed_char << dec;
1509                 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1510                                           " (code point %2$s)"),
1511                                           ods.str(), from_utf8(oss.str()));
1512                 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1513                                 "representable in the chosen encoding.\n"
1514                                 "Changing the document encoding to utf8 could help."),
1515                                 e.par_id, e.pos, e.pos + 1));
1516                 failed_export = true;
1517         }
1518         catch (iconv_codecvt_facet_exception const & e) {
1519                 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1520                         _(e.what()), -1, 0, 0));
1521                 failed_export = true;
1522         }
1523         catch (exception const & e) {
1524                 errorList.push_back(ErrorItem(_("conversion failed"),
1525                         _(e.what()), -1, 0, 0));
1526                 failed_export = true;
1527         }
1528         catch (...) {
1529                 lyxerr << "Caught some really weird exception..." << endl;
1530                 lyx_exit(1);
1531         }
1532
1533         ofs.close();
1534         if (ofs.fail()) {
1535                 failed_export = true;
1536                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1537         }
1538
1539         if (runparams_in.silent)
1540                 errorList.clear();
1541         else
1542                 errors("Export");
1543         return !failed_export;
1544 }
1545
1546
1547 void Buffer::writeLaTeXSource(otexstream & os,
1548                            string const & original_path,
1549                            OutputParams const & runparams_in,
1550                            OutputWhat output) const
1551 {
1552         // The child documents, if any, shall be already loaded at this point.
1553
1554         OutputParams runparams = runparams_in;
1555
1556         // If we are compiling a file standalone, even if this is the
1557         // child of some other buffer, let's cut the link here, so the
1558         // file is really independent and no concurring settings from
1559         // the master (e.g. branch state) interfere (see #8100).
1560         if (!runparams.is_child)
1561                 d->ignore_parent = true;
1562
1563         // Classify the unicode characters appearing in math insets
1564         BufferEncodings::initUnicodeMath(*this);
1565
1566         // validate the buffer.
1567         LYXERR(Debug::LATEX, "  Validating buffer...");
1568         LaTeXFeatures features(*this, params(), runparams);
1569         validate(features);
1570         // This is only set once per document (in master)
1571         if (!runparams.is_child)
1572                 runparams.use_polyglossia = features.usePolyglossia();
1573         LYXERR(Debug::LATEX, "  Buffer validation done.");
1574
1575         bool const output_preamble =
1576                 output == FullSource || output == OnlyPreamble;
1577         bool const output_body =
1578                 output == FullSource || output == OnlyBody;
1579
1580         // The starting paragraph of the coming rows is the
1581         // first paragraph of the document. (Asger)
1582         if (output_preamble && runparams.nice) {
1583                 os << "%% LyX " << lyx_version << " created this file.  "
1584                         "For more info, see http://www.lyx.org/.\n"
1585                         "%% Do not edit unless you really know what "
1586                         "you are doing.\n";
1587         }
1588         LYXERR(Debug::INFO, "lyx document header finished");
1589
1590         // There are a few differences between nice LaTeX and usual files:
1591         // usual files have \batchmode and special input@path to allow
1592         // inclusion of figures specified by an explicitly relative path
1593         // (i.e., a path starting with './' or '../') with either \input or
1594         // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1595         // input@path is set when the actual parameter original_path is set.
1596         // This is done for usual tex-file, but not for nice-latex-file.
1597         // (Matthias 250696)
1598         // Note that input@path is only needed for something the user does
1599         // in the preamble, included .tex files or ERT, files included by
1600         // LyX work without it.
1601         if (output_preamble) {
1602                 if (!runparams.nice) {
1603                         // code for usual, NOT nice-latex-file
1604                         os << "\\batchmode\n"; // changed from \nonstopmode
1605                 }
1606                 if (!original_path.empty()) {
1607                         // FIXME UNICODE
1608                         // We don't know the encoding of inputpath
1609                         docstring const inputpath = from_utf8(original_path);
1610                         docstring uncodable_glyphs;
1611                         Encoding const * const enc = runparams.encoding;
1612                         if (enc) {
1613                                 for (size_t n = 0; n < inputpath.size(); ++n) {
1614                                         if (!enc->encodable(inputpath[n])) {
1615                                                 docstring const glyph(1, inputpath[n]);
1616                                                 LYXERR0("Uncodable character '"
1617                                                         << glyph
1618                                                         << "' in input path!");
1619                                                 uncodable_glyphs += glyph;
1620                                         }
1621                                 }
1622                         }
1623
1624                         // warn user if we found uncodable glyphs.
1625                         if (!uncodable_glyphs.empty()) {
1626                                 frontend::Alert::warning(
1627                                         _("Uncodable character in file path"),
1628                                         support::bformat(
1629                                           _("The path of your document\n"
1630                                             "(%1$s)\n"
1631                                             "contains glyphs that are unknown "
1632                                             "in the current document encoding "
1633                                             "(namely %2$s). This may result in "
1634                                             "incomplete output, unless "
1635                                             "TEXINPUTS contains the document "
1636                                             "directory and you don't use "
1637                                             "explicitly relative paths (i.e., "
1638                                             "paths starting with './' or "
1639                                             "'../') in the preamble or in ERT."
1640                                             "\n\nIn case of problems, choose "
1641                                             "an appropriate document encoding\n"
1642                                             "(such as utf8) or change the "
1643                                             "file path name."),
1644                                           inputpath, uncodable_glyphs));
1645                         } else {
1646                                 string docdir =
1647                                         support::latex_path(original_path);
1648                                 if (contains(docdir, '#')) {
1649                                         docdir = subst(docdir, "#", "\\#");
1650                                         os << "\\catcode`\\#=11"
1651                                               "\\def\\#{#}\\catcode`\\#=6\n";
1652                                 }
1653                                 if (contains(docdir, '%')) {
1654                                         docdir = subst(docdir, "%", "\\%");
1655                                         os << "\\catcode`\\%=11"
1656                                               "\\def\\%{%}\\catcode`\\%=14\n";
1657                                 }
1658                                 os << "\\makeatletter\n"
1659                                    << "\\def\\input@path{{"
1660                                    << docdir << "/}}\n"
1661                                    << "\\makeatother\n";
1662                         }
1663                 }
1664
1665                 // get parent macros (if this buffer has a parent) which will be
1666                 // written at the document begin further down.
1667                 MacroSet parentMacros;
1668                 listParentMacros(parentMacros, features);
1669
1670                 // Write the preamble
1671                 runparams.use_babel = params().writeLaTeX(os, features,
1672                                                           d->filename.onlyPath());
1673
1674                 // Japanese might be required only in some children of a document,
1675                 // but once required, we must keep use_japanese true.
1676                 runparams.use_japanese |= features.isRequired("japanese");
1677
1678                 if (!output_body) {
1679                         // Restore the parenthood if needed
1680                         if (!runparams.is_child)
1681                                 d->ignore_parent = false;
1682                         return;
1683                 }
1684
1685                 // make the body.
1686                 os << "\\begin{document}\n";
1687
1688                 // output the parent macros
1689                 MacroSet::iterator it = parentMacros.begin();
1690                 MacroSet::iterator end = parentMacros.end();
1691                 for (; it != end; ++it) {
1692                         int num_lines = (*it)->write(os.os(), true);
1693                         os.texrow().newlines(num_lines);
1694                 }
1695
1696         } // output_preamble
1697
1698         os.texrow().start(paragraphs().begin()->id(), 0);
1699
1700         LYXERR(Debug::INFO, "preamble finished, now the body.");
1701
1702         // the real stuff
1703         latexParagraphs(*this, text(), os, runparams);
1704
1705         // Restore the parenthood if needed
1706         if (!runparams.is_child)
1707                 d->ignore_parent = false;
1708
1709         // add this just in case after all the paragraphs
1710         os << endl;
1711
1712         if (output_preamble) {
1713                 os << "\\end{document}\n";
1714                 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1715         } else {
1716                 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1717         }
1718         runparams_in.encoding = runparams.encoding;
1719
1720         // Just to be sure. (Asger)
1721         os.texrow().newline();
1722
1723         //for (int i = 0; i<d->texrow.rows(); i++) {
1724         // int id,pos;
1725         // if (d->texrow.getIdFromRow(i+1,id,pos) && id>0)
1726         //      lyxerr << i+1 << ":" << id << ":" << getParFromID(id).paragraph().asString()<<"\n";
1727         //}
1728
1729         LYXERR(Debug::INFO, "Finished making LaTeX file.");
1730         LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
1731 }
1732
1733
1734 void Buffer::makeDocBookFile(FileName const & fname,
1735                               OutputParams const & runparams,
1736                               OutputWhat output) const
1737 {
1738         LYXERR(Debug::LATEX, "makeDocBookFile...");
1739
1740         ofdocstream ofs;
1741         if (!openFileWrite(ofs, fname))
1742                 return;
1743
1744         // make sure we are ready to export
1745         // this needs to be done before we validate
1746         updateBuffer();
1747         updateMacroInstances(OutputUpdate);
1748
1749         writeDocBookSource(ofs, fname.absFileName(), runparams, output);
1750
1751         ofs.close();
1752         if (ofs.fail())
1753                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1754 }
1755
1756
1757 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1758                              OutputParams const & runparams,
1759                              OutputWhat output) const
1760 {
1761         LaTeXFeatures features(*this, params(), runparams);
1762         validate(features);
1763
1764         d->texrow.reset();
1765
1766         DocumentClass const & tclass = params().documentClass();
1767         string const top_element = tclass.latexname();
1768
1769         bool const output_preamble =
1770                 output == FullSource || output == OnlyPreamble;
1771         bool const output_body =
1772           output == FullSource || output == OnlyBody;
1773
1774         if (output_preamble) {
1775                 if (runparams.flavor == OutputParams::XML)
1776                         os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1777
1778                 // FIXME UNICODE
1779                 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1780
1781                 // FIXME UNICODE
1782                 if (! tclass.class_header().empty())
1783                         os << from_ascii(tclass.class_header());
1784                 else if (runparams.flavor == OutputParams::XML)
1785                         os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1786                             << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1787                 else
1788                         os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1789
1790                 docstring preamble = from_utf8(params().preamble);
1791                 if (runparams.flavor != OutputParams::XML ) {
1792                         preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1793                         preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1794                         preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1795                         preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1796                 }
1797
1798                 string const name = runparams.nice
1799                         ? changeExtension(absFileName(), ".sgml") : fname;
1800                 preamble += features.getIncludedFiles(name);
1801                 preamble += features.getLyXSGMLEntities();
1802
1803                 if (!preamble.empty()) {
1804                         os << "\n [ " << preamble << " ]";
1805                 }
1806                 os << ">\n\n";
1807         }
1808
1809         if (output_body) {
1810                 string top = top_element;
1811                 top += " lang=\"";
1812                 if (runparams.flavor == OutputParams::XML)
1813                         top += params().language->code();
1814                 else
1815                         top += params().language->code().substr(0, 2);
1816                 top += '"';
1817
1818                 if (!params().options.empty()) {
1819                         top += ' ';
1820                         top += params().options;
1821                 }
1822
1823                 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1824                                 << " file was created by LyX " << lyx_version
1825                                 << "\n  See http://www.lyx.org/ for more information -->\n";
1826
1827                 params().documentClass().counters().reset();
1828
1829                 sgml::openTag(os, top);
1830                 os << '\n';
1831                 docbookParagraphs(text(), *this, os, runparams);
1832                 sgml::closeTag(os, top_element);
1833         }
1834 }
1835
1836
1837 void Buffer::makeLyXHTMLFile(FileName const & fname,
1838                               OutputParams const & runparams) const
1839 {
1840         LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
1841
1842         ofdocstream ofs;
1843         if (!openFileWrite(ofs, fname))
1844                 return;
1845
1846         // make sure we are ready to export
1847         // this has to be done before we validate
1848         updateBuffer(UpdateMaster, OutputUpdate);
1849         updateMacroInstances(OutputUpdate);
1850
1851         writeLyXHTMLSource(ofs, runparams, FullSource);
1852
1853         ofs.close();
1854         if (ofs.fail())
1855                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1856 }
1857
1858
1859 void Buffer::writeLyXHTMLSource(odocstream & os,
1860                              OutputParams const & runparams,
1861                              OutputWhat output) const
1862 {
1863         LaTeXFeatures features(*this, params(), runparams);
1864         validate(features);
1865         d->bibinfo_.makeCitationLabels(*this);
1866
1867         bool const output_preamble =
1868                 output == FullSource || output == OnlyPreamble;
1869         bool const output_body =
1870           output == FullSource || output == OnlyBody || output == IncludedFile;
1871
1872         if (output_preamble) {
1873                 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
1874                    << "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1 plus MathML 2.0//EN\" \"http://www.w3.org/Math/DTD/mathml2/xhtml-math11-f.dtd\">\n"
1875                    // FIXME Language should be set properly.
1876                    << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
1877                    << "<head>\n"
1878                    << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
1879                    // FIXME Presumably need to set this right
1880                    << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
1881
1882                 docstring const & doctitle = features.htmlTitle();
1883                 os << "<title>"
1884                    << (doctitle.empty() ?
1885                          from_ascii("LyX Document") :
1886                          html::htmlize(doctitle, XHTMLStream::ESCAPE_ALL))
1887                    << "</title>\n";
1888
1889                 docstring styles = features.getTClassHTMLPreamble();
1890                 if (!styles.empty())
1891                         os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
1892
1893                 styles = from_utf8(features.getPreambleSnippets());
1894                 if (!styles.empty())
1895                         os << "\n<!-- Preamble Snippets -->\n" << styles << '\n';
1896
1897                 // we will collect CSS information in a stream, and then output it
1898                 // either here, as part of the header, or else in a separate file.
1899                 odocstringstream css;
1900                 styles = from_utf8(features.getCSSSnippets());
1901                 if (!styles.empty())
1902                         css << "/* LyX Provided Styles */\n" << styles << '\n';
1903
1904                 styles = features.getTClassHTMLStyles();
1905                 if (!styles.empty())
1906                         css << "/* Layout-provided Styles */\n" << styles << '\n';
1907
1908                 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
1909                 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
1910                 if (needfg || needbg) {
1911                                 css << "\nbody {\n";
1912                                 if (needfg)
1913                                    css << "  color: "
1914                                             << from_ascii(X11hexname(params().fontcolor))
1915                                             << ";\n";
1916                                 if (needbg)
1917                                    css << "  background-color: "
1918                                             << from_ascii(X11hexname(params().backgroundcolor))
1919                                             << ";\n";
1920                                 css << "}\n";
1921                 }
1922
1923                 docstring const dstyles = css.str();
1924                 if (!dstyles.empty()) {
1925                         bool written = false;
1926                         if (params().html_css_as_file) {
1927                                 // open a file for CSS info
1928                                 ofdocstream ocss;
1929                                 string const fcssname = addName(temppath(), "docstyle.css");
1930                                 FileName const fcssfile = FileName(fcssname);
1931                                 if (openFileWrite(ocss, fcssfile)) {
1932                                         ocss << dstyles;
1933                                         ocss.close();
1934                                         written = true;
1935                                         // write link to header
1936                                         os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
1937                                         // register file
1938                                         runparams.exportdata->addExternalFile("xhtml", fcssfile);
1939                                 }
1940                         }
1941                         // we are here if the CSS is supposed to be written to the header
1942                         // or if we failed to write it to an external file.
1943                         if (!written) {
1944                                 os << "<style type='text/css'>\n"
1945                                          << dstyles
1946                                          << "\n</style>\n";
1947                         }
1948                 }
1949                 os << "</head>\n";
1950         }
1951
1952         if (output_body) {
1953                 bool const output_body_tag = (output != IncludedFile);
1954                 if (output_body_tag)
1955                         os << "<body>\n";
1956                 XHTMLStream xs(os);
1957                 if (output != IncludedFile)
1958                         // if we're an included file, the counters are in the master.
1959                         params().documentClass().counters().reset();
1960                 xhtmlParagraphs(text(), *this, xs, runparams);
1961                 if (output_body_tag)
1962                         os << "</body>\n";
1963         }
1964
1965         if (output_preamble)
1966                 os << "</html>\n";
1967 }
1968
1969
1970 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1971 // Other flags: -wall -v0 -x
1972 int Buffer::runChktex()
1973 {
1974         setBusy(true);
1975
1976         // get LaTeX-Filename
1977         FileName const path(temppath());
1978         string const name = addName(path.absFileName(), latexName());
1979         string const org_path = filePath();
1980
1981         PathChanger p(path); // path to LaTeX file
1982         message(_("Running chktex..."));
1983
1984         // Generate the LaTeX file if neccessary
1985         OutputParams runparams(&params().encoding());
1986         runparams.flavor = OutputParams::LATEX;
1987         runparams.nice = false;
1988         runparams.linelen = lyxrc.plaintext_linelen;
1989         makeLaTeXFile(FileName(name), org_path, runparams);
1990
1991         TeXErrors terr;
1992         Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
1993         int const res = chktex.run(terr); // run chktex
1994
1995         if (res == -1) {
1996                 Alert::error(_("chktex failure"),
1997                              _("Could not run chktex successfully."));
1998         } else {
1999                 ErrorList & errlist = d->errorLists["ChkTeX"];
2000                 errlist.clear();
2001                 bufferErrors(terr, errlist);
2002         }
2003
2004         setBusy(false);
2005
2006         if (runparams.silent)
2007                 d->errorLists["ChkTeX"].clear();
2008         else
2009                 errors("ChkTeX");
2010
2011         return res;
2012 }
2013
2014
2015 void Buffer::validate(LaTeXFeatures & features) const
2016 {
2017         // Validate the buffer params, but not for included
2018         // files, since they also use the parent buffer's
2019         // params (# 5941)
2020         if (!features.runparams().is_child)
2021                 params().validate(features);
2022
2023         for_each(paragraphs().begin(), paragraphs().end(),
2024                  bind(&Paragraph::validate, _1, ref(features)));
2025
2026         if (lyxerr.debugging(Debug::LATEX)) {
2027                 features.showStruct();
2028         }
2029 }
2030
2031
2032 void Buffer::getLabelList(vector<docstring> & list) const
2033 {
2034         // If this is a child document, use the master's list instead.
2035         if (parent()) {
2036                 masterBuffer()->getLabelList(list);
2037                 return;
2038         }
2039
2040         list.clear();
2041         Toc & toc = d->toc_backend.toc("label");
2042         TocIterator toc_it = toc.begin();
2043         TocIterator end = toc.end();
2044         for (; toc_it != end; ++toc_it) {
2045                 if (toc_it->depth() == 0)
2046                         list.push_back(toc_it->str());
2047         }
2048 }
2049
2050
2051 void Buffer::updateBibfilesCache(UpdateScope scope) const
2052 {
2053         // FIXME This is probably unnecssary, given where we call this.
2054         // If this is a child document, use the parent's cache instead.
2055         if (parent() && scope != UpdateChildOnly) {
2056                 masterBuffer()->updateBibfilesCache();
2057                 return;
2058         }
2059
2060         d->bibfiles_cache_.clear();
2061         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2062                 if (it->lyxCode() == BIBTEX_CODE) {
2063                         InsetBibtex const & inset = static_cast<InsetBibtex const &>(*it);
2064                         support::FileNameList const bibfiles = inset.getBibFiles();
2065                         d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
2066                                 bibfiles.begin(),
2067                                 bibfiles.end());
2068                 } else if (it->lyxCode() == INCLUDE_CODE) {
2069                         InsetInclude & inset = static_cast<InsetInclude &>(*it);
2070                         Buffer const * const incbuf = inset.getChildBuffer();
2071                         if (!incbuf)
2072                                 continue;
2073                         support::FileNameList const & bibfiles =
2074                                         incbuf->getBibfilesCache(UpdateChildOnly);
2075                         if (!bibfiles.empty()) {
2076                                 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
2077                                         bibfiles.begin(),
2078                                         bibfiles.end());
2079                         }
2080                 }
2081         }
2082         d->bibfile_cache_valid_ = true;
2083         d->bibinfo_cache_valid_ = false;
2084         d->cite_labels_valid_ = false;
2085 }
2086
2087
2088 void Buffer::invalidateBibinfoCache() const
2089 {
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->invalidateBibinfoCache();
2096 }
2097
2098
2099 void Buffer::invalidateBibfileCache() const
2100 {
2101         d->bibfile_cache_valid_ = false;
2102         d->bibinfo_cache_valid_ = false;
2103         d->cite_labels_valid_ = false;
2104         // also invalidate the cache for the parent buffer
2105         Buffer const * const pbuf = d->parent();
2106         if (pbuf)
2107                 pbuf->invalidateBibfileCache();
2108 }
2109
2110
2111 support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const
2112 {
2113         // FIXME This is probably unnecessary, given where we call this.
2114         // If this is a child document, use the master's cache instead.
2115         Buffer const * const pbuf = masterBuffer();
2116         if (pbuf != this && scope != UpdateChildOnly)
2117                 return pbuf->getBibfilesCache();
2118
2119         if (!d->bibfile_cache_valid_)
2120                 this->updateBibfilesCache(scope);
2121
2122         return d->bibfiles_cache_;
2123 }
2124
2125
2126 BiblioInfo const & Buffer::masterBibInfo() const
2127 {
2128         Buffer const * const tmp = masterBuffer();
2129         if (tmp != this)
2130                 return tmp->masterBibInfo();
2131         return d->bibinfo_;
2132 }
2133
2134
2135 void Buffer::checkIfBibInfoCacheIsValid() const
2136 {
2137         // use the master's cache
2138         Buffer const * const tmp = masterBuffer();
2139         if (tmp != this) {
2140                 tmp->checkIfBibInfoCacheIsValid();
2141                 return;
2142         }
2143
2144         // compare the cached timestamps with the actual ones.
2145         FileNameList const & bibfiles_cache = getBibfilesCache();
2146         FileNameList::const_iterator ei = bibfiles_cache.begin();
2147         FileNameList::const_iterator en = bibfiles_cache.end();
2148         for (; ei != en; ++ ei) {
2149                 time_t lastw = ei->lastModified();
2150                 time_t prevw = d->bibfile_status_[*ei];
2151                 if (lastw != prevw) {
2152                         d->bibinfo_cache_valid_ = false;
2153                         d->cite_labels_valid_ = false;
2154                         d->bibfile_status_[*ei] = lastw;
2155                 }
2156         }
2157 }
2158
2159
2160 void Buffer::reloadBibInfoCache() const
2161 {
2162         // use the master's cache
2163         Buffer const * const tmp = masterBuffer();
2164         if (tmp != this) {
2165                 tmp->reloadBibInfoCache();
2166                 return;
2167         }
2168
2169         checkIfBibInfoCacheIsValid();
2170         if (d->bibinfo_cache_valid_)
2171                 return;
2172
2173         d->bibinfo_.clear();
2174         collectBibKeys();
2175         d->bibinfo_cache_valid_ = true;
2176 }
2177
2178
2179 void Buffer::collectBibKeys() const
2180 {
2181         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
2182                 it->collectBibKeys(it);
2183 }
2184
2185
2186 void Buffer::addBiblioInfo(BiblioInfo const & bi) const
2187 {
2188         Buffer const * tmp = masterBuffer();
2189         BiblioInfo & masterbi = (tmp == this) ?
2190                 d->bibinfo_ : tmp->d->bibinfo_;
2191         masterbi.mergeBiblioInfo(bi);
2192 }
2193
2194
2195 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const
2196 {
2197         Buffer const * tmp = masterBuffer();
2198         BiblioInfo & masterbi = (tmp == this) ?
2199                 d->bibinfo_ : tmp->d->bibinfo_;
2200         masterbi[key] = bi;
2201 }
2202
2203
2204 void Buffer::makeCitationLabels() const
2205 {
2206         Buffer const * const master = masterBuffer();
2207         return d->bibinfo_.makeCitationLabels(*master);
2208 }
2209
2210
2211 bool Buffer::citeLabelsValid() const
2212 {
2213         return masterBuffer()->d->cite_labels_valid_;
2214 }
2215
2216
2217 void Buffer::removeBiblioTempFiles() const
2218 {
2219         // We remove files that contain LaTeX commands specific to the
2220         // particular bibliographic style being used, in order to avoid
2221         // LaTeX errors when we switch style.
2222         FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2223         FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2224         LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2225         aux_file.removeFile();
2226         LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2227         bbl_file.removeFile();
2228         // Also for the parent buffer
2229         Buffer const * const pbuf = parent();
2230         if (pbuf)
2231                 pbuf->removeBiblioTempFiles();
2232 }
2233
2234
2235 bool Buffer::isDepClean(string const & name) const
2236 {
2237         DepClean::const_iterator const it = d->dep_clean.find(name);
2238         if (it == d->dep_clean.end())
2239                 return true;
2240         return it->second;
2241 }
2242
2243
2244 void Buffer::markDepClean(string const & name)
2245 {
2246         d->dep_clean[name] = true;
2247 }
2248
2249
2250 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2251 {
2252         if (isInternal()) {
2253                 // FIXME? if there is an Buffer LFUN that can be dispatched even
2254                 // if internal, put a switch '(cmd.action)' here.
2255                 return false;
2256         }
2257
2258         bool enable = true;
2259
2260         switch (cmd.action()) {
2261
2262         case LFUN_BUFFER_TOGGLE_READ_ONLY:
2263                 flag.setOnOff(isReadonly());
2264                 break;
2265
2266                 // FIXME: There is need for a command-line import.
2267                 //case LFUN_BUFFER_IMPORT:
2268
2269         case LFUN_BUFFER_AUTO_SAVE:
2270                 break;
2271
2272         case LFUN_BUFFER_EXPORT_CUSTOM:
2273                 // FIXME: Nothing to check here?
2274                 break;
2275
2276         case LFUN_BUFFER_EXPORT: {
2277                 docstring const arg = cmd.argument();
2278                 if (arg == "custom") {
2279                         enable = true;
2280                         break;
2281                 }
2282                 string format = to_utf8(arg);
2283                 size_t pos = format.find(' ');
2284                 if (pos != string::npos)
2285                         format = format.substr(0, pos);
2286                 enable = params().isExportable(format);
2287                 if (!enable)
2288                         flag.message(bformat(
2289                                              _("Don't know how to export to format: %1$s"), arg));
2290                 break;
2291         }
2292
2293         case LFUN_BUFFER_CHKTEX:
2294                 enable = params().isLatex() && !lyxrc.chktex_command.empty();
2295                 break;
2296
2297         case LFUN_BUILD_PROGRAM:
2298                 enable = params().isExportable("program");
2299                 break;
2300
2301         case LFUN_BRANCH_ACTIVATE:
2302         case LFUN_BRANCH_DEACTIVATE:
2303         case LFUN_BRANCH_MASTER_ACTIVATE:
2304         case LFUN_BRANCH_MASTER_DEACTIVATE: {
2305                 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2306                                      || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2307                 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2308                         : params().branchlist();
2309                 docstring const branchName = cmd.argument();
2310                 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2311                 break;
2312         }
2313
2314         case LFUN_BRANCH_ADD:
2315         case LFUN_BRANCHES_RENAME:
2316         case LFUN_BUFFER_PRINT:
2317                 // if no Buffer is present, then of course we won't be called!
2318                 break;
2319
2320         case LFUN_BUFFER_LANGUAGE:
2321                 enable = !isReadonly();
2322                 break;
2323
2324         default:
2325                 return false;
2326         }
2327         flag.setEnabled(enable);
2328         return true;
2329 }
2330
2331
2332 void Buffer::dispatch(string const & command, DispatchResult & result)
2333 {
2334         return dispatch(lyxaction.lookupFunc(command), result);
2335 }
2336
2337
2338 // NOTE We can end up here even if we have no GUI, because we are called
2339 // by LyX::exec to handled command-line requests. So we may need to check
2340 // whether we have a GUI or not. The boolean use_gui holds this information.
2341 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2342 {
2343         if (isInternal()) {
2344                 // FIXME? if there is an Buffer LFUN that can be dispatched even
2345                 // if internal, put a switch '(cmd.action())' here.
2346                 dr.dispatched(false);
2347                 return;
2348         }
2349         string const argument = to_utf8(func.argument());
2350         // We'll set this back to false if need be.
2351         bool dispatched = true;
2352         undo().beginUndoGroup();
2353
2354         switch (func.action()) {
2355         case LFUN_BUFFER_TOGGLE_READ_ONLY:
2356                 if (lyxvc().inUse()) {
2357                         string log = lyxvc().toggleReadOnly();
2358                         if (!log.empty())
2359                                 dr.setMessage(log);
2360                 }
2361                 else
2362                         setReadonly(!isReadonly());
2363                 break;
2364
2365         case LFUN_BUFFER_EXPORT: {
2366                 ExportStatus const status = doExport(argument, false);
2367                 dr.setError(status != ExportSuccess);
2368                 if (status != ExportSuccess)
2369                         dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2370                                               func.argument()));
2371                 break;
2372         }
2373
2374         case LFUN_BUILD_PROGRAM: {
2375                 ExportStatus const status = doExport("program", true);
2376                 dr.setError(status != ExportSuccess);
2377                 if (status != ExportSuccess)
2378                         dr.setMessage(_("Error generating literate programming code."));
2379                 break;
2380         }
2381
2382         case LFUN_BUFFER_CHKTEX:
2383                 runChktex();
2384                 break;
2385
2386         case LFUN_BUFFER_EXPORT_CUSTOM: {
2387                 string format_name;
2388                 string command = split(argument, format_name, ' ');
2389                 Format const * format = formats.getFormat(format_name);
2390                 if (!format) {
2391                         lyxerr << "Format \"" << format_name
2392                                 << "\" not recognized!"
2393                                 << endl;
2394                         break;
2395                 }
2396
2397                 // The name of the file created by the conversion process
2398                 string filename;
2399
2400                 // Output to filename
2401                 if (format->name() == "lyx") {
2402                         string const latexname = latexName(false);
2403                         filename = changeExtension(latexname,
2404                                 format->extension());
2405                         filename = addName(temppath(), filename);
2406
2407                         if (!writeFile(FileName(filename)))
2408                                 break;
2409
2410                 } else {
2411                         doExport(format_name, true, filename);
2412                 }
2413
2414                 // Substitute $$FName for filename
2415                 if (!contains(command, "$$FName"))
2416                         command = "( " + command + " ) < $$FName";
2417                 command = subst(command, "$$FName", filename);
2418
2419                 // Execute the command in the background
2420                 Systemcall call;
2421                 call.startscript(Systemcall::DontWait, command, filePath());
2422                 break;
2423         }
2424
2425         // FIXME: There is need for a command-line import.
2426         /*
2427         case LFUN_BUFFER_IMPORT:
2428                 doImport(argument);
2429                 break;
2430         */
2431
2432         case LFUN_BUFFER_AUTO_SAVE:
2433                 autoSave();
2434                 resetAutosaveTimers();
2435                 break;
2436
2437         case LFUN_BRANCH_ACTIVATE:
2438         case LFUN_BRANCH_DEACTIVATE:
2439         case LFUN_BRANCH_MASTER_ACTIVATE:
2440         case LFUN_BRANCH_MASTER_DEACTIVATE: {
2441                 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2442                                      || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2443                 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2444                                       : this;
2445
2446                 docstring const branch_name = func.argument();
2447                 // the case without a branch name is handled elsewhere
2448                 if (branch_name.empty()) {
2449                         dispatched = false;
2450                         break;
2451                 }
2452                 Branch * branch = buf->params().branchlist().find(branch_name);
2453                 if (!branch) {
2454                         LYXERR0("Branch " << branch_name << " does not exist.");
2455                         dr.setError(true);
2456                         docstring const msg =
2457                                 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2458                         dr.setMessage(msg);
2459                         break;
2460                 }
2461                 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2462                                        || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2463                 if (branch->isSelected() != activate) {
2464                         buf->undo().recordUndoFullDocument(CursorData());
2465                         branch->setSelected(activate);
2466                         dr.setError(false);
2467                         dr.screenUpdate(Update::Force);
2468                         dr.forceBufferUpdate();
2469                 }
2470                 break;
2471         }
2472
2473         case LFUN_BRANCH_ADD: {
2474                 docstring branch_name = func.argument();
2475                 if (branch_name.empty()) {
2476                         dispatched = false;
2477                         break;
2478                 }
2479                 BranchList & branch_list = params().branchlist();
2480                 vector<docstring> const branches =
2481                         getVectorFromString(branch_name, branch_list.separator());
2482                 docstring msg;
2483                 for (vector<docstring>::const_iterator it = branches.begin();
2484                      it != branches.end(); ++it) {
2485                         branch_name = *it;
2486                         Branch * branch = branch_list.find(branch_name);
2487                         if (branch) {
2488                                 LYXERR0("Branch " << branch_name << " already exists.");
2489                                 dr.setError(true);
2490                                 if (!msg.empty())
2491                                         msg += ("\n");
2492                                 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2493                         } else {
2494                                 undo().recordUndoFullDocument(CursorData());
2495                                 branch_list.add(branch_name);
2496                                 branch = branch_list.find(branch_name);
2497                                 string const x11hexname = X11hexname(branch->color());
2498                                 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2499                                 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2500                                 dr.setError(false);
2501                                 dr.screenUpdate(Update::Force);
2502                         }
2503                 }
2504                 if (!msg.empty())
2505                         dr.setMessage(msg);
2506                 break;
2507         }
2508
2509         case LFUN_BRANCHES_RENAME: {
2510                 if (func.argument().empty())
2511                         break;
2512
2513                 docstring const oldname = from_utf8(func.getArg(0));
2514                 docstring const newname = from_utf8(func.getArg(1));
2515                 InsetIterator it  = inset_iterator_begin(inset());
2516                 InsetIterator const end = inset_iterator_end(inset());
2517                 bool success = false;
2518                 for (; it != end; ++it) {
2519                         if (it->lyxCode() == BRANCH_CODE) {
2520                                 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2521                                 if (ins.branch() == oldname) {
2522                                         undo().recordUndo(CursorData(it));
2523                                         ins.rename(newname);
2524                                         success = true;
2525                                         continue;
2526                                 }
2527                         }
2528                         if (it->lyxCode() == INCLUDE_CODE) {
2529                                 // get buffer of external file
2530                                 InsetInclude const & ins =
2531                                         static_cast<InsetInclude const &>(*it);
2532                                 Buffer * child = ins.getChildBuffer();
2533                                 if (!child)
2534                                         continue;
2535                                 child->dispatch(func, dr);
2536                         }
2537                 }
2538
2539                 if (success) {
2540                         dr.screenUpdate(Update::Force);
2541                         dr.forceBufferUpdate();
2542                 }
2543                 break;
2544         }
2545
2546         case LFUN_BUFFER_PRINT: {
2547                 // we'll assume there's a problem until we succeed
2548                 dr.setError(true);
2549                 string target = func.getArg(0);
2550                 string target_name = func.getArg(1);
2551                 string command = func.getArg(2);
2552
2553                 if (target.empty()
2554                     || target_name.empty()
2555                     || command.empty()) {
2556                         LYXERR0("Unable to parse " << func.argument());
2557                         docstring const msg =
2558                                 bformat(_("Unable to parse \"%1$s\""), func.argument());
2559                         dr.setMessage(msg);
2560                         break;
2561                 }
2562                 if (target != "printer" && target != "file") {
2563                         LYXERR0("Unrecognized target \"" << target << '"');
2564                         docstring const msg =
2565                                 bformat(_("Unrecognized target \"%1$s\""), from_utf8(target));
2566                         dr.setMessage(msg);
2567                         break;
2568                 }
2569
2570                 if (doExport("dvi", true) != ExportSuccess) {
2571                         showPrintError(absFileName());
2572                         dr.setMessage(_("Error exporting to DVI."));
2573                         break;
2574                 }
2575
2576                 // Push directory path.
2577                 string const path = temppath();
2578                 // Prevent the compiler from optimizing away p
2579                 FileName pp(path);
2580                 PathChanger p(pp);
2581
2582                 // there are three cases here:
2583                 // 1. we print to a file
2584                 // 2. we print directly to a printer
2585                 // 3. we print using a spool command (print to file first)
2586                 Systemcall one;
2587                 int res = 0;
2588                 string const dviname = changeExtension(latexName(true), "dvi");
2589
2590                 if (target == "printer") {
2591                         if (!lyxrc.print_spool_command.empty()) {
2592                                 // case 3: print using a spool
2593                                 string const psname = changeExtension(dviname,".ps");
2594                                 command += ' ' + lyxrc.print_to_file
2595                                         + quoteName(psname)
2596                                         + ' '
2597                                         + quoteName(dviname);
2598
2599                                 string command2 = lyxrc.print_spool_command + ' ';
2600                                 if (target_name != "default") {
2601                                         command2 += lyxrc.print_spool_printerprefix
2602                                                 + target_name
2603                                                 + ' ';
2604                                 }
2605                                 command2 += quoteName(psname);
2606                                 // First run dvips.
2607                                 // If successful, then spool command
2608                                 res = one.startscript(Systemcall::Wait, command,
2609                                                       filePath());
2610
2611                                 if (res == 0) {
2612                                         // If there's no GUI, we have to wait on this command. Otherwise,
2613                                         // LyX deletes the temporary directory, and with it the spooled
2614                                         // file, before it can be printed!!
2615                                         Systemcall::Starttype stype = use_gui ?
2616                                                 Systemcall::DontWait : Systemcall::Wait;
2617                                         res = one.startscript(stype, command2,
2618                                                               filePath());
2619                                 }
2620                         } else {
2621                                 // case 2: print directly to a printer
2622                                 if (target_name != "default")
2623                                         command += ' ' + lyxrc.print_to_printer + target_name + ' ';
2624                                 // as above....
2625                                 Systemcall::Starttype stype = use_gui ?
2626                                         Systemcall::DontWait : Systemcall::Wait;
2627                                 res = one.startscript(stype, command +
2628                                                 quoteName(dviname), filePath());
2629                         }
2630
2631                 } else {
2632                         // case 1: print to a file
2633                         FileName const filename(makeAbsPath(target_name, filePath()));
2634                         FileName const dvifile(makeAbsPath(dviname, path));
2635                         if (filename.exists()) {
2636                                 docstring text = bformat(
2637                                         _("The file %1$s already exists.\n\n"
2638                                           "Do you want to overwrite that file?"),
2639                                         makeDisplayPath(filename.absFileName()));
2640                                 if (Alert::prompt(_("Overwrite file?"),
2641                                                   text, 0, 1, _("&Overwrite"), _("&Cancel")) != 0)
2642                                         break;
2643                         }
2644                         command += ' ' + lyxrc.print_to_file
2645                                 + quoteName(filename.toFilesystemEncoding())
2646                                 + ' '
2647                                 + quoteName(dvifile.toFilesystemEncoding());
2648                         // as above....
2649                         Systemcall::Starttype stype = use_gui ?
2650                                 Systemcall::DontWait : Systemcall::Wait;
2651                         res = one.startscript(stype, command, filePath());
2652                 }
2653
2654                 if (res == 0)
2655                         dr.setError(false);
2656                 else {
2657                         dr.setMessage(_("Error running external commands."));
2658                         showPrintError(absFileName());
2659                 }
2660                 break;
2661         }
2662
2663         default:
2664                 dispatched = false;
2665                 break;
2666         }
2667         dr.dispatched(dispatched);
2668         undo().endUndoGroup();
2669 }
2670
2671
2672 void Buffer::changeLanguage(Language const * from, Language const * to)
2673 {
2674         LASSERT(from, return);
2675         LASSERT(to, return);
2676
2677         for_each(par_iterator_begin(),
2678                  par_iterator_end(),
2679                  bind(&Paragraph::changeLanguage, _1, params(), from, to));
2680 }
2681
2682
2683 bool Buffer::isMultiLingual() const
2684 {
2685         ParConstIterator end = par_iterator_end();
2686         for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2687                 if (it->isMultiLingual(params()))
2688                         return true;
2689
2690         return false;
2691 }
2692
2693
2694 std::set<Language const *> Buffer::getLanguages() const
2695 {
2696         std::set<Language const *> languages;
2697         getLanguages(languages);
2698         return languages;
2699 }
2700
2701
2702 void Buffer::getLanguages(std::set<Language const *> & languages) const
2703 {
2704         ParConstIterator end = par_iterator_end();
2705         // add the buffer language, even if it's not actively used
2706         languages.insert(language());
2707         // iterate over the paragraphs
2708         for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2709                 it->getLanguages(languages);
2710         // also children
2711         ListOfBuffers clist = getDescendents();
2712         ListOfBuffers::const_iterator cit = clist.begin();
2713         ListOfBuffers::const_iterator const cen = clist.end();
2714         for (; cit != cen; ++cit)
2715                 (*cit)->getLanguages(languages);
2716 }
2717
2718
2719 DocIterator Buffer::getParFromID(int const id) const
2720 {
2721         Buffer * buf = const_cast<Buffer *>(this);
2722         if (id < 0) {
2723                 // John says this is called with id == -1 from undo
2724                 lyxerr << "getParFromID(), id: " << id << endl;
2725                 return doc_iterator_end(buf);
2726         }
2727
2728         for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2729                 if (it.paragraph().id() == id)
2730                         return it;
2731
2732         return doc_iterator_end(buf);
2733 }
2734
2735
2736 bool Buffer::hasParWithID(int const id) const
2737 {
2738         return !getParFromID(id).atEnd();
2739 }
2740
2741
2742 ParIterator Buffer::par_iterator_begin()
2743 {
2744         return ParIterator(doc_iterator_begin(this));
2745 }
2746
2747
2748 ParIterator Buffer::par_iterator_end()
2749 {
2750         return ParIterator(doc_iterator_end(this));
2751 }
2752
2753
2754 ParConstIterator Buffer::par_iterator_begin() const
2755 {
2756         return ParConstIterator(doc_iterator_begin(this));
2757 }
2758
2759
2760 ParConstIterator Buffer::par_iterator_end() const
2761 {
2762         return ParConstIterator(doc_iterator_end(this));
2763 }
2764
2765
2766 Language const * Buffer::language() const
2767 {
2768         return params().language;
2769 }
2770
2771
2772 docstring const Buffer::B_(string const & l10n) const
2773 {
2774         return params().B_(l10n);
2775 }
2776
2777
2778 bool Buffer::isClean() const
2779 {
2780         return d->lyx_clean;
2781 }
2782
2783
2784 bool Buffer::isExternallyModified(CheckMethod method) const
2785 {
2786         LASSERT(d->filename.exists(), return false);
2787         // if method == timestamp, check timestamp before checksum
2788         return (method == checksum_method
2789                 || d->timestamp_ != d->filename.lastModified())
2790                 && d->checksum_ != d->filename.checksum();
2791 }
2792
2793
2794 void Buffer::saveCheckSum() const
2795 {
2796         FileName const & file = d->filename;
2797
2798         file.refresh();
2799         if (file.exists()) {
2800                 d->timestamp_ = file.lastModified();
2801                 d->checksum_ = file.checksum();
2802         } else {
2803                 // in the case of save to a new file.
2804                 d->timestamp_ = 0;
2805                 d->checksum_ = 0;
2806         }
2807 }
2808
2809
2810 void Buffer::markClean() const
2811 {
2812         if (!d->lyx_clean) {
2813                 d->lyx_clean = true;
2814                 updateTitles();
2815         }
2816         // if the .lyx file has been saved, we don't need an
2817         // autosave
2818         d->bak_clean = true;
2819         d->undo_.markDirty();
2820 }
2821
2822
2823 void Buffer::setUnnamed(bool flag)
2824 {
2825         d->unnamed = flag;
2826 }
2827
2828
2829 bool Buffer::isUnnamed() const
2830 {
2831         return d->unnamed;
2832 }
2833
2834
2835 /// \note
2836 /// Don't check unnamed, here: isInternal() is used in
2837 /// newBuffer(), where the unnamed flag has not been set by anyone
2838 /// yet. Also, for an internal buffer, there should be no need for
2839 /// retrieving fileName() nor for checking if it is unnamed or not.
2840 bool Buffer::isInternal() const
2841 {
2842         return d->internal_buffer;
2843 }
2844
2845
2846 void Buffer::setInternal(bool flag)
2847 {
2848         d->internal_buffer = flag;
2849 }
2850
2851
2852 void Buffer::markDirty()
2853 {
2854         if (d->lyx_clean) {
2855                 d->lyx_clean = false;
2856                 updateTitles();
2857         }
2858         d->bak_clean = false;
2859
2860         DepClean::iterator it = d->dep_clean.begin();
2861         DepClean::const_iterator const end = d->dep_clean.end();
2862
2863         for (; it != end; ++it)
2864                 it->second = false;
2865 }
2866
2867
2868 FileName Buffer::fileName() const
2869 {
2870         return d->filename;
2871 }
2872
2873
2874 string Buffer::absFileName() const
2875 {
2876         return d->filename.absFileName();
2877 }
2878
2879
2880 string Buffer::filePath() const
2881 {
2882         string const abs = d->filename.onlyPath().absFileName();
2883         if (abs.empty())
2884                 return abs;
2885         int last = abs.length() - 1;
2886
2887         return abs[last] == '/' ? abs : abs + '/';
2888 }
2889
2890
2891 bool Buffer::isReadonly() const
2892 {
2893         return d->read_only;
2894 }
2895
2896
2897 void Buffer::setParent(Buffer const * buffer)
2898 {
2899         // Avoids recursive include.
2900         d->setParent(buffer == this ? 0 : buffer);
2901         updateMacros();
2902 }
2903
2904
2905 Buffer const * Buffer::parent() const
2906 {
2907         return d->parent();
2908 }
2909
2910
2911 ListOfBuffers Buffer::allRelatives() const
2912 {
2913         ListOfBuffers lb = masterBuffer()->getDescendents();
2914         lb.push_front(const_cast<Buffer *>(masterBuffer()));
2915         return lb;
2916 }
2917
2918
2919 Buffer const * Buffer::masterBuffer() const
2920 {
2921         // FIXME Should be make sure we are not in some kind
2922         // of recursive include? A -> B -> A will crash this.
2923         Buffer const * const pbuf = d->parent();
2924         if (!pbuf)
2925                 return this;
2926
2927         return pbuf->masterBuffer();
2928 }
2929
2930
2931 bool Buffer::isChild(Buffer * child) const
2932 {
2933         return d->children_positions.find(child) != d->children_positions.end();
2934 }
2935
2936
2937 DocIterator Buffer::firstChildPosition(Buffer const * child)
2938 {
2939         Impl::BufferPositionMap::iterator it;
2940         it = d->children_positions.find(child);
2941         if (it == d->children_positions.end())
2942                 return DocIterator(this);
2943         return it->second;
2944 }
2945
2946
2947 bool Buffer::hasChildren() const
2948 {
2949         return !d->children_positions.empty();
2950 }
2951
2952
2953 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
2954 {
2955         // loop over children
2956         Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2957         Impl::BufferPositionMap::iterator end = d->children_positions.end();
2958         for (; it != end; ++it) {
2959                 Buffer * child = const_cast<Buffer *>(it->first);
2960                 // No duplicates
2961                 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
2962                 if (bit != clist.end())
2963                         continue;
2964                 clist.push_back(child);
2965                 if (grand_children)
2966                         // there might be grandchildren
2967                         child->collectChildren(clist, true);
2968         }
2969 }
2970
2971
2972 ListOfBuffers Buffer::getChildren() const
2973 {
2974         ListOfBuffers v;
2975         collectChildren(v, false);
2976         // Make sure we have not included ourselves.
2977         ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
2978         if (bit != v.end()) {
2979                 LYXERR0("Recursive include detected in `" << fileName() << "'.");
2980                 v.erase(bit);
2981         }
2982         return v;
2983 }
2984
2985
2986 ListOfBuffers Buffer::getDescendents() const
2987 {
2988         ListOfBuffers v;
2989         collectChildren(v, true);
2990         // Make sure we have not included ourselves.
2991         ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
2992         if (bit != v.end()) {
2993                 LYXERR0("Recursive include detected in `" << fileName() << "'.");
2994                 v.erase(bit);
2995         }
2996         return v;
2997 }
2998
2999
3000 template<typename M>
3001 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3002 {
3003         if (m.empty())
3004                 return m.end();
3005
3006         typename M::const_iterator it = m.lower_bound(x);
3007         if (it == m.begin())
3008                 return m.end();
3009
3010         it--;
3011         return it;
3012 }
3013
3014
3015 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3016                                          DocIterator const & pos) const
3017 {
3018         LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3019
3020         // if paragraphs have no macro context set, pos will be empty
3021         if (pos.empty())
3022                 return 0;
3023
3024         // we haven't found anything yet
3025         DocIterator bestPos = owner_->par_iterator_begin();
3026         MacroData const * bestData = 0;
3027
3028         // find macro definitions for name
3029         NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3030         if (nameIt != macros.end()) {
3031                 // find last definition in front of pos or at pos itself
3032                 PositionScopeMacroMap::const_iterator it
3033                         = greatest_below(nameIt->second, pos);
3034                 if (it != nameIt->second.end()) {
3035                         while (true) {
3036                                 // scope ends behind pos?
3037                                 if (pos < it->second.first) {
3038                                         // Looks good, remember this. If there
3039                                         // is no external macro behind this,
3040                                         // we found the right one already.
3041                                         bestPos = it->first;
3042                                         bestData = &it->second.second;
3043                                         break;
3044                                 }
3045
3046                                 // try previous macro if there is one
3047                                 if (it == nameIt->second.begin())
3048                                         break;
3049                                 --it;
3050                         }
3051                 }
3052         }
3053
3054         // find macros in included files
3055         PositionScopeBufferMap::const_iterator it
3056                 = greatest_below(position_to_children, pos);
3057         if (it == position_to_children.end())
3058                 // no children before
3059                 return bestData;
3060
3061         while (true) {
3062                 // do we know something better (i.e. later) already?
3063                 if (it->first < bestPos )
3064                         break;
3065
3066                 // scope ends behind pos?
3067                 if (pos < it->second.first
3068                         && (cloned_buffer_ ||
3069                             theBufferList().isLoaded(it->second.second))) {
3070                         // look for macro in external file
3071                         macro_lock = true;
3072                         MacroData const * data
3073                                 = it->second.second->getMacro(name, false);
3074                         macro_lock = false;
3075                         if (data) {
3076                                 bestPos = it->first;
3077                                 bestData = data;
3078                                 break;
3079                         }
3080                 }
3081
3082                 // try previous file if there is one
3083                 if (it == position_to_children.begin())
3084                         break;
3085                 --it;
3086         }
3087
3088         // return the best macro we have found
3089         return bestData;
3090 }
3091
3092
3093 MacroData const * Buffer::getMacro(docstring const & name,
3094         DocIterator const & pos, bool global) const
3095 {
3096         if (d->macro_lock)
3097                 return 0;
3098
3099         // query buffer macros
3100         MacroData const * data = d->getBufferMacro(name, pos);
3101         if (data != 0)
3102                 return data;
3103
3104         // If there is a master buffer, query that
3105         Buffer const * const pbuf = d->parent();
3106         if (pbuf) {
3107                 d->macro_lock = true;
3108                 MacroData const * macro = pbuf->getMacro(
3109                         name, *this, false);
3110                 d->macro_lock = false;
3111                 if (macro)
3112                         return macro;
3113         }
3114
3115         if (global) {
3116                 data = MacroTable::globalMacros().get(name);
3117                 if (data != 0)
3118                         return data;
3119         }
3120
3121         return 0;
3122 }
3123
3124
3125 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3126 {
3127         // set scope end behind the last paragraph
3128         DocIterator scope = par_iterator_begin();
3129         scope.pit() = scope.lastpit() + 1;
3130
3131         return getMacro(name, scope, global);
3132 }
3133
3134
3135 MacroData const * Buffer::getMacro(docstring const & name,
3136         Buffer const & child, bool global) const
3137 {
3138         // look where the child buffer is included first
3139         Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3140         if (it == d->children_positions.end())
3141                 return 0;
3142
3143         // check for macros at the inclusion position
3144         return getMacro(name, it->second, global);
3145 }
3146
3147
3148 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3149 {
3150         pit_type const lastpit = it.lastpit();
3151
3152         // look for macros in each paragraph
3153         while (it.pit() <= lastpit) {
3154                 Paragraph & par = it.paragraph();
3155
3156                 // iterate over the insets of the current paragraph
3157                 InsetList const & insets = par.insetList();
3158                 InsetList::const_iterator iit = insets.begin();
3159                 InsetList::const_iterator end = insets.end();
3160                 for (; iit != end; ++iit) {
3161                         it.pos() = iit->pos;
3162
3163                         // is it a nested text inset?
3164                         if (iit->inset->asInsetText()) {
3165                                 // Inset needs its own scope?
3166                                 InsetText const * itext = iit->inset->asInsetText();
3167                                 bool newScope = itext->isMacroScope();
3168
3169                                 // scope which ends just behind the inset
3170                                 DocIterator insetScope = it;
3171                                 ++insetScope.pos();
3172
3173                                 // collect macros in inset
3174                                 it.push_back(CursorSlice(*iit->inset));
3175                                 updateMacros(it, newScope ? insetScope : scope);
3176                                 it.pop_back();
3177                                 continue;
3178                         }
3179
3180                         if (iit->inset->asInsetTabular()) {
3181                                 CursorSlice slice(*iit->inset);
3182                                 size_t const numcells = slice.nargs();
3183                                 for (; slice.idx() < numcells; slice.forwardIdx()) {
3184                                         it.push_back(slice);
3185                                         updateMacros(it, scope);
3186                                         it.pop_back();
3187                                 }
3188                                 continue;
3189                         }
3190
3191                         // is it an external file?
3192                         if (iit->inset->lyxCode() == INCLUDE_CODE) {
3193                                 // get buffer of external file
3194                                 InsetInclude const & inset =
3195                                         static_cast<InsetInclude const &>(*iit->inset);
3196                                 macro_lock = true;
3197                                 Buffer * child = inset.getChildBuffer();
3198                                 macro_lock = false;
3199                                 if (!child)
3200                                         continue;
3201
3202                                 // register its position, but only when it is
3203                                 // included first in the buffer
3204                                 if (children_positions.find(child) ==
3205                                         children_positions.end())
3206                                                 children_positions[child] = it;
3207
3208                                 // register child with its scope
3209                                 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3210                                 continue;
3211                         }
3212
3213                         InsetMath * im = iit->inset->asInsetMath();
3214                         if (doing_export && im)  {
3215                                 InsetMathHull * hull = im->asHullInset();
3216                                 if (hull)
3217                                         hull->recordLocation(it);
3218                         }
3219
3220                         if (iit->inset->lyxCode() != MATHMACRO_CODE)
3221                                 continue;
3222
3223                         // get macro data
3224                         MathMacroTemplate & macroTemplate =
3225                                 *iit->inset->asInsetMath()->asMacroTemplate();
3226                         MacroContext mc(owner_, it);
3227                         macroTemplate.updateToContext(mc);
3228
3229                         // valid?
3230                         bool valid = macroTemplate.validMacro();
3231                         // FIXME: Should be fixNameAndCheckIfValid() in fact,
3232                         // then the BufferView's cursor will be invalid in
3233                         // some cases which leads to crashes.
3234                         if (!valid)
3235                                 continue;
3236
3237                         // register macro
3238                         // FIXME (Abdel), I don't understandt why we pass 'it' here
3239                         // instead of 'macroTemplate' defined above... is this correct?
3240                         macros[macroTemplate.name()][it] =
3241                                 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3242                 }
3243
3244                 // next paragraph
3245                 it.pit()++;
3246                 it.pos() = 0;
3247         }
3248 }
3249
3250
3251 void Buffer::updateMacros() const
3252 {
3253         if (d->macro_lock)
3254                 return;
3255
3256         LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3257
3258         // start with empty table
3259         d->macros.clear();
3260         d->children_positions.clear();
3261         d->position_to_children.clear();
3262
3263         // Iterate over buffer, starting with first paragraph
3264         // The scope must be bigger than any lookup DocIterator
3265         // later. For the global lookup, lastpit+1 is used, hence
3266         // we use lastpit+2 here.
3267         DocIterator it = par_iterator_begin();
3268         DocIterator outerScope = it;
3269         outerScope.pit() = outerScope.lastpit() + 2;
3270         d->updateMacros(it, outerScope);
3271 }
3272
3273
3274 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3275 {
3276         InsetIterator it  = inset_iterator_begin(inset());
3277         InsetIterator const end = inset_iterator_end(inset());
3278         for (; it != end; ++it) {
3279                 if (it->lyxCode() == BRANCH_CODE) {
3280                         InsetBranch & br = static_cast<InsetBranch &>(*it);
3281                         docstring const name = br.branch();
3282                         if (!from_master && !params().branchlist().find(name))
3283                                 result.push_back(name);
3284                         else if (from_master && !masterBuffer()->params().branchlist().find(name))
3285                                 result.push_back(name);
3286                         continue;
3287                 }
3288                 if (it->lyxCode() == INCLUDE_CODE) {
3289                         // get buffer of external file
3290                         InsetInclude const & ins =
3291                                 static_cast<InsetInclude const &>(*it);
3292                         Buffer * child = ins.getChildBuffer();
3293                         if (!child)
3294                                 continue;
3295                         child->getUsedBranches(result, true);
3296                 }
3297         }
3298         // remove duplicates
3299         result.unique();
3300 }
3301
3302
3303 void Buffer::updateMacroInstances(UpdateType utype) const
3304 {
3305         LYXERR(Debug::MACROS, "updateMacroInstances for "
3306                 << d->filename.onlyFileName());
3307         DocIterator it = doc_iterator_begin(this);
3308         it.forwardInset();
3309         DocIterator const end = doc_iterator_end(this);
3310         for (; it != end; it.forwardInset()) {
3311                 // look for MathData cells in InsetMathNest insets
3312                 InsetMath * minset = it.nextInset()->asInsetMath();
3313                 if (!minset)
3314                         continue;
3315
3316                 // update macro in all cells of the InsetMathNest
3317                 DocIterator::idx_type n = minset->nargs();
3318                 MacroContext mc = MacroContext(this, it);
3319                 for (DocIterator::idx_type i = 0; i < n; ++i) {
3320                         MathData & data = minset->cell(i);
3321                         data.updateMacros(0, mc, utype);
3322                 }
3323         }
3324 }
3325
3326
3327 void Buffer::listMacroNames(MacroNameSet & macros) const
3328 {
3329         if (d->macro_lock)
3330                 return;
3331
3332         d->macro_lock = true;
3333
3334         // loop over macro names
3335         Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
3336         Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
3337         for (; nameIt != nameEnd; ++nameIt)
3338                 macros.insert(nameIt->first);
3339
3340         // loop over children
3341         Impl::BufferPositionMap::iterator it = d->children_positions.begin();
3342         Impl::BufferPositionMap::iterator end = d->children_positions.end();
3343         for (; it != end; ++it)
3344                 it->first->listMacroNames(macros);
3345
3346         // call parent
3347         Buffer const * const pbuf = d->parent();
3348         if (pbuf)
3349                 pbuf->listMacroNames(macros);
3350
3351         d->macro_lock = false;
3352 }
3353
3354
3355 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3356 {
3357         Buffer const * const pbuf = d->parent();
3358         if (!pbuf)
3359                 return;
3360
3361         MacroNameSet names;
3362         pbuf->listMacroNames(names);
3363
3364         // resolve macros
3365         MacroNameSet::iterator it = names.begin();
3366         MacroNameSet::iterator end = names.end();
3367         for (; it != end; ++it) {
3368                 // defined?
3369                 MacroData const * data =
3370                 pbuf->getMacro(*it, *this, false);
3371                 if (data) {
3372                         macros.insert(data);
3373
3374                         // we cannot access the original MathMacroTemplate anymore
3375                         // here to calls validate method. So we do its work here manually.
3376                         // FIXME: somehow make the template accessible here.
3377                         if (data->optionals() > 0)
3378                                 features.require("xargs");
3379                 }
3380         }
3381 }
3382
3383
3384 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3385 {
3386         if (d->parent())
3387                 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3388
3389         RefCache::iterator it = d->ref_cache_.find(label);
3390         if (it != d->ref_cache_.end())
3391                 return it->second.second;
3392
3393         static InsetLabel const * dummy_il = 0;
3394         static References const dummy_refs;
3395         it = d->ref_cache_.insert(
3396                 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
3397         return it->second.second;
3398 }
3399
3400
3401 Buffer::References const & Buffer::references(docstring const & label) const
3402 {
3403         return const_cast<Buffer *>(this)->getReferenceCache(label);
3404 }
3405
3406
3407 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3408 {
3409         References & refs = getReferenceCache(label);
3410         refs.push_back(make_pair(inset, it));
3411 }
3412
3413
3414 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
3415 {
3416         masterBuffer()->d->ref_cache_[label].first = il;
3417 }
3418
3419
3420 InsetLabel const * Buffer::insetLabel(docstring const & label) const
3421 {
3422         return masterBuffer()->d->ref_cache_[label].first;
3423 }
3424
3425
3426 void Buffer::clearReferenceCache() const
3427 {
3428         if (!d->parent())
3429                 d->ref_cache_.clear();
3430 }
3431
3432
3433 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
3434 {
3435         //FIXME: This does not work for child documents yet.
3436         reloadBibInfoCache();
3437
3438         // Check if the label 'from' appears more than once
3439         BiblioInfo const & keys = masterBibInfo();
3440         BiblioInfo::const_iterator bit  = keys.begin();
3441         BiblioInfo::const_iterator bend = keys.end();
3442         vector<docstring> labels;
3443
3444         for (; bit != bend; ++bit)
3445                 // FIXME UNICODE
3446                 labels.push_back(bit->first);
3447
3448         if (count(labels.begin(), labels.end(), from) > 1)
3449                 return;
3450
3451         string const paramName = "key";
3452         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
3453                 if (it->lyxCode() != CITE_CODE)
3454                         continue;
3455                 InsetCommand * inset = it->asInsetCommand();
3456                 docstring const oldValue = inset->getParam(paramName);
3457                 if (oldValue == from)
3458                         inset->setParam(paramName, to);
3459         }
3460 }
3461
3462
3463 void Buffer::getSourceCode(odocstream & os, string const format,
3464                            pit_type par_begin, pit_type par_end,
3465                            OutputWhat output, bool master) const
3466 {
3467         OutputParams runparams(&params().encoding());
3468         runparams.nice = true;
3469         runparams.flavor = params().getOutputFlavor(format);
3470         runparams.linelen = lyxrc.plaintext_linelen;
3471         // No side effect of file copying and image conversion
3472         runparams.dryrun = true;
3473
3474         if (output == CurrentParagraph) {
3475                 runparams.par_begin = par_begin;
3476                 runparams.par_end = par_end;
3477                 if (par_begin + 1 == par_end) {
3478                         os << "% "
3479                            << bformat(_("Preview source code for paragraph %1$d"), par_begin)
3480                            << "\n\n";
3481                 } else {
3482                         os << "% "
3483                            << bformat(_("Preview source code from paragraph %1$s to %2$s"),
3484                                         convert<docstring>(par_begin),
3485                                         convert<docstring>(par_end - 1))
3486                            << "\n\n";
3487                 }
3488                 // output paragraphs
3489                 if (runparams.flavor == OutputParams::LYX) {
3490                         Paragraph const & par = text().paragraphs()[par_begin];
3491                         ostringstream ods;
3492                         depth_type dt = par.getDepth();
3493                         par.write(ods, params(), dt);
3494                         os << from_utf8(ods.str());
3495                 } else if (runparams.flavor == OutputParams::HTML) {
3496                         XHTMLStream xs(os);
3497                         setMathFlavor(runparams);
3498                         xhtmlParagraphs(text(), *this, xs, runparams);
3499                 } else if (runparams.flavor == OutputParams::TEXT) {
3500                         bool dummy;
3501                         // FIXME Handles only one paragraph, unlike the others.
3502                         // Probably should have some routine with a signature like them.
3503                         writePlaintextParagraph(*this,
3504                                 text().paragraphs()[par_begin], os, runparams, dummy);
3505                 } else if (params().isDocBook()) {
3506                         docbookParagraphs(text(), *this, os, runparams);
3507                 } else {
3508                         // If we are previewing a paragraph, even if this is the
3509                         // child of some other buffer, let's cut the link here,
3510                         // so that no concurring settings from the master
3511                         // (e.g. branch state) interfere (see #8101).
3512                         if (!master)
3513                                 d->ignore_parent = true;
3514                         // We need to validate the Buffer params' features here
3515                         // in order to know if we should output polyglossia
3516                         // macros (instead of babel macros)
3517                         LaTeXFeatures features(*this, params(), runparams);
3518                         params().validate(features);
3519                         runparams.use_polyglossia = features.usePolyglossia();
3520                         TexRow texrow;
3521                         texrow.reset();
3522                         texrow.newline();
3523                         texrow.newline();
3524                         // latex or literate
3525                         otexstream ots(os, texrow);
3526
3527                         // the real stuff
3528                         latexParagraphs(*this, text(), ots, runparams);
3529
3530                         // Restore the parenthood
3531                         if (!master)
3532                                 d->ignore_parent = false;
3533                 }
3534         } else {
3535                 os << "% ";
3536                 if (output == FullSource)
3537                         os << _("Preview source code");
3538                 else if (output == OnlyPreamble)
3539                         os << _("Preview preamble");
3540                 else if (output == OnlyBody)
3541                         os << _("Preview body");
3542                 os << "\n\n";
3543                 if (runparams.flavor == OutputParams::LYX) {
3544                         ostringstream ods;
3545                         if (output == FullSource)
3546                                 write(ods);
3547                         else if (output == OnlyPreamble)
3548                                 params().writeFile(ods);
3549                         else if (output == OnlyBody)
3550                                 text().write(ods);
3551                         os << from_utf8(ods.str());
3552                 } else if (runparams.flavor == OutputParams::HTML) {
3553                         writeLyXHTMLSource(os, runparams, output);
3554                 } else if (runparams.flavor == OutputParams::TEXT) {
3555                         if (output == OnlyPreamble) {
3556                                 os << "% "<< _("Plain text does not have a preamble.");
3557                         } else
3558                                 writePlaintextFile(*this, os, runparams);
3559                 } else if (params().isDocBook()) {
3560                                 writeDocBookSource(os, absFileName(), runparams, output);
3561                 } else {
3562                         // latex or literate
3563                         d->texrow.reset();
3564                         d->texrow.newline();
3565                         d->texrow.newline();
3566                         otexstream ots(os, d->texrow);
3567                         if (master)
3568                                 runparams.is_child = true;
3569                         writeLaTeXSource(ots, string(), runparams, output);
3570                 }
3571         }
3572 }
3573
3574
3575 ErrorList & Buffer::errorList(string const & type) const
3576 {
3577         return d->errorLists[type];
3578 }
3579
3580
3581 void Buffer::updateTocItem(std::string const & type,
3582         DocIterator const & dit) const
3583 {
3584         if (d->gui_)
3585                 d->gui_->updateTocItem(type, dit);
3586 }
3587
3588
3589 void Buffer::structureChanged() const
3590 {
3591         if (d->gui_)
3592                 d->gui_->structureChanged();
3593 }
3594
3595
3596 void Buffer::errors(string const & err, bool from_master) const
3597 {
3598         if (d->gui_)
3599                 d->gui_->errors(err, from_master);
3600 }
3601
3602
3603 void Buffer::message(docstring const & msg) const
3604 {
3605         if (d->gui_)
3606                 d->gui_->message(msg);
3607 }
3608
3609
3610 void Buffer::setBusy(bool on) const
3611 {
3612         if (d->gui_)
3613                 d->gui_->setBusy(on);
3614 }
3615
3616
3617 void Buffer::updateTitles() const
3618 {
3619         if (d->wa_)
3620                 d->wa_->updateTitles();
3621 }
3622
3623
3624 void Buffer::resetAutosaveTimers() const
3625 {
3626         if (d->gui_)
3627                 d->gui_->resetAutosaveTimers();
3628 }
3629
3630
3631 bool Buffer::hasGuiDelegate() const
3632 {
3633         return d->gui_;
3634 }
3635
3636
3637 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
3638 {
3639         d->gui_ = gui;
3640 }
3641
3642
3643
3644 namespace {
3645
3646 class AutoSaveBuffer : public ForkedProcess {
3647 public:
3648         ///
3649         AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
3650                 : buffer_(buffer), fname_(fname) {}
3651         ///
3652         virtual shared_ptr<ForkedProcess> clone() const
3653         {
3654                 return shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
3655         }
3656         ///
3657         int start()
3658         {
3659                 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
3660                                                  from_utf8(fname_.absFileName())));
3661                 return run(DontWait);
3662         }
3663 private:
3664         ///
3665         virtual int generateChild();
3666         ///
3667         Buffer const & buffer_;
3668         FileName fname_;
3669 };
3670
3671
3672 int AutoSaveBuffer::generateChild()
3673 {
3674 #if defined(__APPLE__)
3675         /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
3676          *   We should use something else like threads.
3677          *
3678          * Since I do not know how to determine at run time what is the OS X
3679          * version, I just disable forking altogether for now (JMarc)
3680          */
3681         pid_t const pid = -1;
3682 #else
3683         // tmp_ret will be located (usually) in /tmp
3684         // will that be a problem?
3685         // Note that this calls ForkedCalls::fork(), so it's
3686         // ok cross-platform.
3687         pid_t const pid = fork();
3688         // If you want to debug the autosave
3689         // you should set pid to -1, and comment out the fork.
3690         if (pid != 0 && pid != -1)
3691                 return pid;
3692 #endif
3693
3694         // pid = -1 signifies that lyx was unable
3695         // to fork. But we will do the save
3696         // anyway.
3697         bool failed = false;
3698         FileName const tmp_ret = FileName::tempName("lyxauto");
3699         if (!tmp_ret.empty()) {
3700                 buffer_.writeFile(tmp_ret);
3701                 // assume successful write of tmp_ret
3702                 if (!tmp_ret.moveTo(fname_))
3703                         failed = true;
3704         } else
3705                 failed = true;
3706
3707         if (failed) {
3708                 // failed to write/rename tmp_ret so try writing direct
3709                 if (!buffer_.writeFile(fname_)) {
3710                         // It is dangerous to do this in the child,
3711                         // but safe in the parent, so...
3712                         if (pid == -1) // emit message signal.
3713                                 buffer_.message(_("Autosave failed!"));
3714                 }
3715         }
3716
3717         if (pid == 0) // we are the child so...
3718                 _exit(0);
3719
3720         return pid;
3721 }
3722
3723 } // namespace anon
3724
3725
3726 FileName Buffer::getEmergencyFileName() const
3727 {
3728         return FileName(d->filename.absFileName() + ".emergency");
3729 }
3730
3731
3732 FileName Buffer::getAutosaveFileName() const
3733 {
3734         // if the document is unnamed try to save in the backup dir, else
3735         // in the default document path, and as a last try in the filePath,
3736         // which will most often be the temporary directory
3737         string fpath;
3738         if (isUnnamed())
3739                 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
3740                         : lyxrc.backupdir_path;
3741         if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
3742                 fpath = filePath();
3743
3744         string const fname = "#" + d->filename.onlyFileName() + "#";
3745
3746         return makeAbsPath(fname, fpath);
3747 }
3748
3749
3750 void Buffer::removeAutosaveFile() const
3751 {
3752         FileName const f = getAutosaveFileName();
3753         if (f.exists())
3754                 f.removeFile();
3755 }
3756
3757
3758 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
3759 {
3760         FileName const newauto = getAutosaveFileName();
3761         oldauto.refresh();
3762         if (newauto != oldauto && oldauto.exists())
3763                 if (!oldauto.moveTo(newauto))
3764                         LYXERR0("Unable to move autosave file `" << oldauto << "'!");
3765 }
3766
3767
3768 bool Buffer::autoSave() const
3769 {
3770         Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
3771         if (buf->d->bak_clean || isReadonly())
3772                 return true;
3773
3774         message(_("Autosaving current document..."));
3775         buf->d->bak_clean = true;
3776
3777         FileName const fname = getAutosaveFileName();
3778         LASSERT(d->cloned_buffer_, return false);
3779
3780         // If this buffer is cloned, we assume that
3781         // we are running in a separate thread already.
3782         FileName const tmp_ret = FileName::tempName("lyxauto");
3783         if (!tmp_ret.empty()) {
3784                 writeFile(tmp_ret);
3785                 // assume successful write of tmp_ret
3786                 if (tmp_ret.moveTo(fname))
3787                         return true;
3788         }
3789         // failed to write/rename tmp_ret so try writing direct
3790         return writeFile(fname);
3791 }
3792
3793
3794 void Buffer::setExportStatus(bool e) const
3795 {
3796         d->doing_export = e;
3797         ListOfBuffers clist = getDescendents();
3798         ListOfBuffers::const_iterator cit = clist.begin();
3799         ListOfBuffers::const_iterator const cen = clist.end();
3800         for (; cit != cen; ++cit)
3801                 (*cit)->d->doing_export = e;
3802 }
3803
3804
3805 bool Buffer::isExporting() const
3806 {
3807         return d->doing_export;
3808 }
3809
3810
3811 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
3812         const
3813 {
3814         string result_file;
3815         return doExport(target, put_in_tempdir, result_file);
3816 }
3817
3818 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
3819         string & result_file) const
3820 {
3821         bool const update_unincluded =
3822                         params().maintain_unincluded_children
3823                         && !params().getIncludedChildren().empty();
3824
3825         // (1) export with all included children (omit \includeonly)
3826         if (update_unincluded) {
3827                 ExportStatus const status =
3828                         doExport(target, put_in_tempdir, true, result_file);
3829                 if (status != ExportSuccess)
3830                         return status;
3831         }
3832         // (2) export with included children only
3833         return doExport(target, put_in_tempdir, false, result_file);
3834 }
3835
3836
3837 void Buffer::setMathFlavor(OutputParams & op) const
3838 {
3839         switch (params().html_math_output) {
3840         case BufferParams::MathML:
3841                 op.math_flavor = OutputParams::MathAsMathML;
3842                 break;
3843         case BufferParams::HTML:
3844                 op.math_flavor = OutputParams::MathAsHTML;
3845                 break;
3846         case BufferParams::Images:
3847                 op.math_flavor = OutputParams::MathAsImages;
3848                 break;
3849         case BufferParams::LaTeX:
3850                 op.math_flavor = OutputParams::MathAsLaTeX;
3851                 break;
3852         }
3853 }
3854
3855
3856 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
3857         bool includeall, string & result_file) const
3858 {
3859         LYXERR(Debug::FILES, "target=" << target);
3860         OutputParams runparams(&params().encoding());
3861         string format = target;
3862         string dest_filename;
3863         size_t pos = target.find(' ');
3864         if (pos != string::npos) {
3865                 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
3866                 format = target.substr(0, pos);
3867                 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
3868                 FileName(dest_filename).onlyPath().createPath();
3869                 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
3870         }
3871         MarkAsExporting exporting(this);
3872         string backend_format;
3873         runparams.flavor = OutputParams::LATEX;
3874         runparams.linelen = lyxrc.plaintext_linelen;
3875         runparams.includeall = includeall;
3876         vector<string> backs = params().backends();
3877         Converters converters = theConverters();
3878         bool need_nice_file = false;
3879         if (find(backs.begin(), backs.end(), format) == backs.end()) {
3880                 // Get shortest path to format
3881                 converters.buildGraph();
3882                 Graph::EdgePath path;
3883                 for (vector<string>::const_iterator it = backs.begin();
3884                      it != backs.end(); ++it) {
3885                         Graph::EdgePath p = converters.getPath(*it, format);
3886                         if (!p.empty() && (path.empty() || p.size() < path.size())) {
3887                                 backend_format = *it;
3888                                 path = p;
3889                         }
3890                 }
3891                 if (path.empty()) {
3892                         if (!put_in_tempdir) {
3893                                 // Only show this alert if this is an export to a non-temporary
3894                                 // file (not for previewing).
3895                                 Alert::error(_("Couldn't export file"), bformat(
3896                                         _("No information for exporting the format %1$s."),
3897                                         formats.prettyName(format)));
3898                         }
3899                         return ExportNoPathToFormat;
3900                 }
3901                 runparams.flavor = converters.getFlavor(path, this);
3902                 Graph::EdgePath::const_iterator it = path.begin();
3903                 Graph::EdgePath::const_iterator en = path.end();
3904                 for (; it != en; ++it)
3905                         if (theConverters().get(*it).nice) {
3906                                 need_nice_file = true;
3907                                 break;
3908                         }
3909
3910         } else {
3911                 backend_format = format;
3912                 LYXERR(Debug::FILES, "backend_format=" << backend_format);
3913                 // FIXME: Don't hardcode format names here, but use a flag
3914                 if (backend_format == "pdflatex")
3915                         runparams.flavor = OutputParams::PDFLATEX;
3916                 else if (backend_format == "luatex")
3917                         runparams.flavor = OutputParams::LUATEX;
3918                 else if (backend_format == "dviluatex")
3919                         runparams.flavor = OutputParams::DVILUATEX;
3920                 else if (backend_format == "xetex")
3921                         runparams.flavor = OutputParams::XETEX;
3922         }
3923
3924         string filename = latexName(false);
3925         filename = addName(temppath(), filename);
3926         filename = changeExtension(filename,
3927                                    formats.extension(backend_format));
3928         LYXERR(Debug::FILES, "filename=" << filename);
3929
3930         // Plain text backend
3931         if (backend_format == "text") {
3932                 runparams.flavor = OutputParams::TEXT;
3933                 writePlaintextFile(*this, FileName(filename), runparams);
3934         }
3935         // HTML backend
3936         else if (backend_format == "xhtml") {
3937                 runparams.flavor = OutputParams::HTML;
3938                 setMathFlavor(runparams);
3939                 makeLyXHTMLFile(FileName(filename), runparams);
3940         } else if (backend_format == "lyx")
3941                 writeFile(FileName(filename));
3942         // Docbook backend
3943         else if (params().isDocBook()) {
3944                 runparams.nice = !put_in_tempdir;
3945                 makeDocBookFile(FileName(filename), runparams);
3946         }
3947         // LaTeX backend
3948         else if (backend_format == format || need_nice_file) {
3949                 runparams.nice = true;
3950                 bool const success = makeLaTeXFile(FileName(filename), string(), runparams);
3951                 if (d->cloned_buffer_)
3952                         d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
3953                 if (!success)
3954                         return ExportError;
3955         } else if (!lyxrc.tex_allows_spaces
3956                    && contains(filePath(), ' ')) {
3957                 Alert::error(_("File name error"),
3958                            _("The directory path to the document cannot contain spaces."));
3959                 return ExportTexPathHasSpaces;
3960         } else {
3961                 runparams.nice = false;
3962                 bool const success = makeLaTeXFile(
3963                         FileName(filename), filePath(), runparams);
3964                 if (d->cloned_buffer_)
3965                         d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
3966                 if (!success)
3967                         return ExportError;
3968         }
3969
3970         string const error_type = (format == "program")
3971                 ? "Build" : params().bufferFormat();
3972         ErrorList & error_list = d->errorLists[error_type];
3973         string const ext = formats.extension(format);
3974         FileName const tmp_result_file(changeExtension(filename, ext));
3975         bool const success = converters.convert(this, FileName(filename),
3976                 tmp_result_file, FileName(absFileName()), backend_format, format,
3977                 error_list);
3978
3979         // Emit the signal to show the error list or copy it back to the
3980         // cloned Buffer so that it can be emitted afterwards.
3981         if (format != backend_format) {
3982                 if (runparams.silent)
3983                         error_list.clear();
3984                 else if (d->cloned_buffer_)
3985                         d->cloned_buffer_->d->errorLists[error_type] =
3986                                 d->errorLists[error_type];
3987                 else
3988                         errors(error_type);
3989                 // also to the children, in case of master-buffer-view
3990                 ListOfBuffers clist = getDescendents();
3991                 ListOfBuffers::const_iterator cit = clist.begin();
3992                 ListOfBuffers::const_iterator const cen = clist.end();
3993                 for (; cit != cen; ++cit) {
3994                         if (runparams.silent)
3995                                 (*cit)->d->errorLists[error_type].clear();
3996                         else if (d->cloned_buffer_) {
3997                                 // Enable reverse search by copying back the
3998                                 // texrow object to the cloned buffer.
3999                                 // FIXME: this is not thread safe.
4000                                 (*cit)->d->cloned_buffer_->d->texrow = (*cit)->d->texrow;
4001                                 (*cit)->d->cloned_buffer_->d->errorLists[error_type] =
4002                                         (*cit)->d->errorLists[error_type];
4003                         } else
4004                                 (*cit)->errors(error_type, true);
4005                 }
4006         }
4007
4008         if (d->cloned_buffer_) {
4009                 // Enable reverse dvi or pdf to work by copying back the texrow
4010                 // object to the cloned buffer.
4011                 // FIXME: There is a possibility of concurrent access to texrow
4012                 // here from the main GUI thread that should be securized.
4013                 d->cloned_buffer_->d->texrow = d->texrow;
4014                 string const error_type = params().bufferFormat();
4015                 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[error_type];
4016         }
4017
4018         if (!success)
4019                 return ExportConverterError;
4020
4021         if (put_in_tempdir) {
4022                 result_file = tmp_result_file.absFileName();
4023                 return ExportSuccess;
4024         }
4025
4026         if (dest_filename.empty())
4027                 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4028         else
4029                 result_file = dest_filename;
4030         // We need to copy referenced files (e. g. included graphics
4031         // if format == "dvi") to the result dir.
4032         vector<ExportedFile> const files =
4033                 runparams.exportdata->externalFiles(format);
4034         string const dest = runparams.export_folder.empty() ?
4035                 onlyPath(result_file) : runparams.export_folder;
4036         bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4037                                  : force_overwrite == ALL_FILES;
4038         CopyStatus status = use_force ? FORCE : SUCCESS;
4039
4040         vector<ExportedFile>::const_iterator it = files.begin();
4041         vector<ExportedFile>::const_iterator const en = files.end();
4042         for (; it != en && status != CANCEL; ++it) {
4043                 string const fmt = formats.getFormatFromFile(it->sourceName);
4044                 string fixedName = it->exportName;
4045                 if (!runparams.export_folder.empty()) {
4046                         // Relative pathnames starting with ../ will be sanitized
4047                         // if exporting to a different folder
4048                         while (fixedName.substr(0, 3) == "../")
4049                                 fixedName = fixedName.substr(3, fixedName.length() - 3);
4050                 }
4051                 FileName fixedFileName = makeAbsPath(fixedName, dest);
4052                 fixedFileName.onlyPath().createPath();
4053                 status = copyFile(fmt, it->sourceName,
4054                         fixedFileName,
4055                         it->exportName, status == FORCE,
4056                         runparams.export_folder.empty());
4057         }
4058
4059         if (status == CANCEL) {
4060                 message(_("Document export cancelled."));
4061                 return ExportCancel;
4062         }
4063
4064         if (tmp_result_file.exists()) {
4065                 // Finally copy the main file
4066                 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4067                                     : force_overwrite != NO_FILES;
4068                 if (status == SUCCESS && use_force)
4069                         status = FORCE;
4070                 status = copyFile(format, tmp_result_file,
4071                         FileName(result_file), result_file,
4072                         status == FORCE);
4073                 if (status == CANCEL) {
4074                         message(_("Document export cancelled."));
4075                         return ExportCancel;
4076                 } else {
4077                         message(bformat(_("Document exported as %1$s "
4078                                 "to file `%2$s'"),
4079                                 formats.prettyName(format),
4080                                 makeDisplayPath(result_file)));
4081                 }
4082         } else {
4083                 // This must be a dummy converter like fax (bug 1888)
4084                 message(bformat(_("Document exported as %1$s"),
4085                         formats.prettyName(format)));
4086         }
4087
4088         return ExportSuccess;
4089 }
4090
4091
4092 Buffer::ExportStatus Buffer::preview(string const & format) const
4093 {
4094         bool const update_unincluded =
4095                         params().maintain_unincluded_children
4096                         && !params().getIncludedChildren().empty();
4097         return preview(format, update_unincluded);
4098 }
4099
4100 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4101 {
4102         MarkAsExporting exporting(this);
4103         string result_file;
4104         // (1) export with all included children (omit \includeonly)
4105         if (includeall) {
4106                 ExportStatus const status = doExport(format, true, true, result_file);
4107                 if (status != ExportSuccess)
4108                         return status;
4109         }
4110         // (2) export with included children only
4111         ExportStatus const status = doExport(format, true, false, result_file);
4112         if (status != ExportSuccess)
4113                 return status;
4114         if (!formats.view(*this, FileName(result_file), format))
4115                 return PreviewError;
4116         return PreviewSuccess;
4117 }
4118
4119
4120 Buffer::ReadStatus Buffer::extractFromVC()
4121 {
4122         bool const found = LyXVC::file_not_found_hook(d->filename);
4123         if (!found)
4124                 return ReadFileNotFound;
4125         if (!d->filename.isReadableFile())
4126                 return ReadVCError;
4127         return ReadSuccess;
4128 }
4129
4130
4131 Buffer::ReadStatus Buffer::loadEmergency()
4132 {
4133         FileName const emergencyFile = getEmergencyFileName();
4134         if (!emergencyFile.exists()
4135                   || emergencyFile.lastModified() <= d->filename.lastModified())
4136                 return ReadFileNotFound;
4137
4138         docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4139         docstring const text = bformat(_("An emergency save of the document "
4140                 "%1$s exists.\n\nRecover emergency save?"), file);
4141
4142         int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4143                 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4144
4145         switch (load_emerg)
4146         {
4147         case 0: {
4148                 docstring str;
4149                 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4150                 bool const success = (ret_llf == ReadSuccess);
4151                 if (success) {
4152                         if (isReadonly()) {
4153                                 Alert::warning(_("File is read-only"),
4154                                         bformat(_("An emergency file is successfully loaded, "
4155                                         "but the original file %1$s is marked read-only. "
4156                                         "Please make sure to save the document as a different "
4157                                         "file."), from_utf8(d->filename.absFileName())));
4158                         }
4159                         markDirty();
4160                         lyxvc().file_found_hook(d->filename);
4161                         str = _("Document was successfully recovered.");
4162                 } else
4163                         str = _("Document was NOT successfully recovered.");
4164                 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4165                         makeDisplayPath(emergencyFile.absFileName()));
4166
4167                 int const del_emerg =
4168                         Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4169                                 _("&Remove"), _("&Keep"));
4170                 if (del_emerg == 0) {
4171                         emergencyFile.removeFile();
4172                         if (success)
4173                                 Alert::warning(_("Emergency file deleted"),
4174                                         _("Do not forget to save your file now!"), true);
4175                         }
4176                 return success ? ReadSuccess : ReadEmergencyFailure;
4177         }
4178         case 1: {
4179                 int const del_emerg =
4180                         Alert::prompt(_("Delete emergency file?"),
4181                                 _("Remove emergency file now?"), 1, 1,
4182                                 _("&Remove"), _("&Keep"));
4183                 if (del_emerg == 0)
4184                         emergencyFile.removeFile();
4185                 return ReadOriginal;
4186         }
4187
4188         default:
4189                 break;
4190         }
4191         return ReadCancel;
4192 }
4193
4194
4195 Buffer::ReadStatus Buffer::loadAutosave()
4196 {
4197         // Now check if autosave file is newer.
4198         FileName const autosaveFile = getAutosaveFileName();
4199         if (!autosaveFile.exists()
4200                   || autosaveFile.lastModified() <= d->filename.lastModified())
4201                 return ReadFileNotFound;
4202
4203         docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4204         docstring const text = bformat(_("The backup of the document %1$s "
4205                 "is newer.\n\nLoad the backup instead?"), file);
4206         int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4207                 _("&Load backup"), _("Load &original"), _("&Cancel"));
4208
4209         switch (ret)
4210         {
4211         case 0: {
4212                 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4213                 // the file is not saved if we load the autosave file.
4214                 if (ret_llf == ReadSuccess) {
4215                         if (isReadonly()) {
4216                                 Alert::warning(_("File is read-only"),
4217                                         bformat(_("A backup file is successfully loaded, "
4218                                         "but the original file %1$s is marked read-only. "
4219                                         "Please make sure to save the document as a "
4220                                         "different file."),
4221                                         from_utf8(d->filename.absFileName())));
4222                         }
4223                         markDirty();
4224                         lyxvc().file_found_hook(d->filename);
4225                         return ReadSuccess;
4226                 }
4227                 return ReadAutosaveFailure;
4228         }
4229         case 1:
4230                 // Here we delete the autosave
4231                 autosaveFile.removeFile();
4232                 return ReadOriginal;
4233         default:
4234                 break;
4235         }
4236         return ReadCancel;
4237 }
4238
4239
4240 Buffer::ReadStatus Buffer::loadLyXFile()
4241 {
4242         if (!d->filename.isReadableFile()) {
4243                 ReadStatus const ret_rvc = extractFromVC();
4244                 if (ret_rvc != ReadSuccess)
4245                         return ret_rvc;
4246         }
4247
4248         ReadStatus const ret_re = loadEmergency();
4249         if (ret_re == ReadSuccess || ret_re == ReadCancel)
4250                 return ret_re;
4251
4252         ReadStatus const ret_ra = loadAutosave();
4253         if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4254                 return ret_ra;
4255
4256         return loadThisLyXFile(d->filename);
4257 }
4258
4259
4260 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4261 {
4262         return readFile(fn);
4263 }
4264
4265
4266 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4267 {
4268         TeXErrors::Errors::const_iterator it = terr.begin();
4269         TeXErrors::Errors::const_iterator end = terr.end();
4270         ListOfBuffers clist = getDescendents();
4271         ListOfBuffers::const_iterator cen = clist.end();
4272
4273         for (; it != end; ++it) {
4274                 int id_start = -1;
4275                 int pos_start = -1;
4276                 int errorRow = it->error_in_line;
4277                 Buffer const * buf = 0;
4278                 Impl const * p = d;
4279                 if (it->child_name.empty())
4280                     p->texrow.getIdFromRow(errorRow, id_start, pos_start);
4281                 else {
4282                         // The error occurred in a child
4283                         ListOfBuffers::const_iterator cit = clist.begin();
4284                         for (; cit != cen; ++cit) {
4285                                 string const child_name =
4286                                         DocFileName(changeExtension(
4287                                                 (*cit)->absFileName(), "tex")).
4288                                                         mangledFileName();
4289                                 if (it->child_name != child_name)
4290                                         continue;
4291                                 (*cit)->d->texrow.getIdFromRow(errorRow,
4292                                                         id_start, pos_start);
4293                                 if (id_start != -1) {
4294                                         buf = d->cloned_buffer_
4295                                                 ? (*cit)->d->cloned_buffer_->d->owner_
4296                                                 : (*cit)->d->owner_;
4297                                         p = (*cit)->d;
4298                                         break;
4299                                 }
4300                         }
4301                 }
4302                 int id_end = -1;
4303                 int pos_end = -1;
4304                 bool found;
4305                 do {
4306                         ++errorRow;
4307                         found = p->texrow.getIdFromRow(errorRow, id_end, pos_end);
4308                 } while (found && id_start == id_end && pos_start == pos_end);
4309
4310                 if (id_start != id_end) {
4311                         // Next registered position is outside the inset where
4312                         // the error occurred, so signal end-of-paragraph
4313                         pos_end = 0;
4314                 }
4315
4316                 errorList.push_back(ErrorItem(it->error_desc,
4317                         it->error_text, id_start, pos_start, pos_end, buf));
4318         }
4319 }
4320
4321
4322 void Buffer::setBuffersForInsets() const
4323 {
4324         inset().setBuffer(const_cast<Buffer &>(*this));
4325 }
4326
4327
4328 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4329 {
4330         LBUFERR(!text().paragraphs().empty());
4331
4332         // Use the master text class also for child documents
4333         Buffer const * const master = masterBuffer();
4334         DocumentClass const & textclass = master->params().documentClass();
4335
4336         // do this only if we are the top-level Buffer
4337         if (master == this) {
4338                 textclass.counters().reset(from_ascii("bibitem"));
4339                 reloadBibInfoCache();
4340         }
4341
4342         // keep the buffers to be children in this set. If the call from the
4343         // master comes back we can see which of them were actually seen (i.e.
4344         // via an InsetInclude). The remaining ones in the set need still be updated.
4345         static std::set<Buffer const *> bufToUpdate;
4346         if (scope == UpdateMaster) {
4347                 // If this is a child document start with the master
4348                 if (master != this) {
4349                         bufToUpdate.insert(this);
4350                         master->updateBuffer(UpdateMaster, utype);
4351                         // Do this here in case the master has no gui associated with it. Then,
4352                         // the TocModel is not updated and TocModel::toc_ is invalid (bug 5699).
4353                         if (!master->d->gui_)
4354                                 structureChanged();
4355
4356                         // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4357                         if (bufToUpdate.find(this) == bufToUpdate.end())
4358                                 return;
4359                 }
4360
4361                 // start over the counters in the master
4362                 textclass.counters().reset();
4363         }
4364
4365         // update will be done below for this buffer
4366         bufToUpdate.erase(this);
4367
4368         // update all caches
4369         clearReferenceCache();
4370         updateMacros();
4371
4372         Buffer & cbuf = const_cast<Buffer &>(*this);
4373
4374         // do the real work
4375         ParIterator parit = cbuf.par_iterator_begin();
4376         updateBuffer(parit, utype);
4377
4378         if (master != this)
4379                 // TocBackend update will be done later.
4380                 return;
4381
4382         d->bibinfo_cache_valid_ = true;
4383         d->cite_labels_valid_ = true;
4384         cbuf.tocBackend().update(utype == OutputUpdate);
4385         if (scope == UpdateMaster)
4386                 cbuf.structureChanged();
4387 }
4388
4389
4390 static depth_type getDepth(DocIterator const & it)
4391 {
4392         depth_type depth = 0;
4393         for (size_t i = 0 ; i < it.depth() ; ++i)
4394                 if (!it[i].inset().inMathed())
4395                         depth += it[i].paragraph().getDepth() + 1;
4396         // remove 1 since the outer inset does not count
4397         return depth - 1;
4398 }
4399
4400 static depth_type getItemDepth(ParIterator const & it)
4401 {
4402         Paragraph const & par = *it;
4403         LabelType const labeltype = par.layout().labeltype;
4404
4405         if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
4406                 return 0;
4407
4408         // this will hold the lowest depth encountered up to now.
4409         depth_type min_depth = getDepth(it);
4410         ParIterator prev_it = it;
4411         while (true) {
4412                 if (prev_it.pit())
4413                         --prev_it.top().pit();
4414                 else {
4415                         // start of nested inset: go to outer par
4416                         prev_it.pop_back();
4417                         if (prev_it.empty()) {
4418                                 // start of document: nothing to do
4419                                 return 0;
4420                         }
4421                 }
4422
4423                 // We search for the first paragraph with same label
4424                 // that is not more deeply nested.
4425                 Paragraph & prev_par = *prev_it;
4426                 depth_type const prev_depth = getDepth(prev_it);
4427                 if (labeltype == prev_par.layout().labeltype) {
4428                         if (prev_depth < min_depth)
4429                                 return prev_par.itemdepth + 1;
4430                         if (prev_depth == min_depth)
4431                                 return prev_par.itemdepth;
4432                 }
4433                 min_depth = min(min_depth, prev_depth);
4434                 // small optimization: if we are at depth 0, we won't
4435                 // find anything else
4436                 if (prev_depth == 0)
4437                         return 0;
4438         }
4439 }
4440
4441
4442 static bool needEnumCounterReset(ParIterator const & it)
4443 {
4444         Paragraph const & par = *it;
4445         LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
4446         depth_type const cur_depth = par.getDepth();
4447         ParIterator prev_it = it;
4448         while (prev_it.pit()) {
4449                 --prev_it.top().pit();
4450                 Paragraph const & prev_par = *prev_it;
4451                 if (prev_par.getDepth() <= cur_depth)
4452                         return  prev_par.layout().labeltype != LABEL_ENUMERATE;
4453         }
4454         // start of nested inset: reset
4455         return true;
4456 }
4457
4458
4459 // set the label of a paragraph. This includes the counters.
4460 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
4461 {
4462         BufferParams const & bp = owner_->masterBuffer()->params();
4463         DocumentClass const & textclass = bp.documentClass();
4464         Paragraph & par = it.paragraph();
4465         Layout const & layout = par.layout();
4466         Counters & counters = textclass.counters();
4467
4468         if (par.params().startOfAppendix()) {
4469                 // We want to reset the counter corresponding to toplevel sectioning
4470                 Layout const & lay = textclass.getTOCLayout();
4471                 docstring const cnt = lay.counter;
4472                 if (!cnt.empty())
4473                         counters.reset(cnt);
4474                 counters.appendix(true);
4475         }
4476         par.params().appendix(counters.appendix());
4477
4478         // Compute the item depth of the paragraph
4479         par.itemdepth = getItemDepth(it);
4480
4481         if (layout.margintype == MARGIN_MANUAL) {
4482                 if (par.params().labelWidthString().empty())
4483                         par.params().labelWidthString(par.expandLabel(layout, bp));
4484         } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
4485                 // we do not need to do anything here, since the empty case is
4486                 // handled during export.
4487         } else {
4488                 par.params().labelWidthString(docstring());
4489         }
4490
4491         switch(layout.labeltype) {
4492         case LABEL_ITEMIZE: {
4493                 // At some point of time we should do something more
4494                 // clever here, like:
4495                 //   par.params().labelString(
4496                 //    bp.user_defined_bullet(par.itemdepth).getText());
4497                 // for now, use a simple hardcoded label
4498                 docstring itemlabel;
4499                 switch (par.itemdepth) {
4500                 case 0:
4501                         itemlabel = char_type(0x2022);
4502                         break;
4503                 case 1:
4504                         itemlabel = char_type(0x2013);
4505                         break;
4506                 case 2:
4507                         itemlabel = char_type(0x2217);
4508                         break;
4509                 case 3:
4510                         itemlabel = char_type(0x2219); // or 0x00b7
4511                         break;
4512                 }
4513                 par.params().labelString(itemlabel);
4514                 break;
4515         }
4516
4517         case LABEL_ENUMERATE: {
4518                 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
4519
4520                 switch (par.itemdepth) {
4521                 case 2:
4522                         enumcounter += 'i';
4523                 case 1:
4524                         enumcounter += 'i';
4525                 case 0:
4526                         enumcounter += 'i';
4527                         break;
4528                 case 3:
4529                         enumcounter += "iv";
4530                         break;
4531                 default:
4532                         // not a valid enumdepth...
4533                         break;
4534                 }
4535
4536                 // Maybe we have to reset the enumeration counter.
4537                 if (needEnumCounterReset(it))
4538                         counters.reset(enumcounter);
4539                 counters.step(enumcounter, utype);
4540
4541                 string const & lang = par.getParLanguage(bp)->code();
4542                 par.params().labelString(counters.theCounter(enumcounter, lang));
4543
4544                 break;
4545         }
4546
4547         case LABEL_SENSITIVE: {
4548                 string const & type = counters.current_float();
4549                 docstring full_label;
4550                 if (type.empty())
4551                         full_label = owner_->B_("Senseless!!! ");
4552                 else {
4553                         docstring name = owner_->B_(textclass.floats().getType(type).name());
4554                         if (counters.hasCounter(from_utf8(type))) {
4555                                 string const & lang = par.getParLanguage(bp)->code();
4556                                 counters.step(from_utf8(type), utype);
4557                                 full_label = bformat(from_ascii("%1$s %2$s:"),
4558                                                      name,
4559                                                      counters.theCounter(from_utf8(type), lang));
4560                         } else
4561                                 full_label = bformat(from_ascii("%1$s #:"), name);
4562                 }
4563                 par.params().labelString(full_label);
4564                 break;
4565         }
4566
4567         case LABEL_NO_LABEL:
4568                 par.params().labelString(docstring());
4569                 break;
4570
4571         case LABEL_ABOVE:
4572         case LABEL_CENTERED:
4573         case LABEL_STATIC: {
4574                 docstring const & lcounter = layout.counter;
4575                 if (!lcounter.empty()) {
4576                         if (layout.toclevel <= bp.secnumdepth
4577                                                 && (layout.latextype != LATEX_ENVIRONMENT
4578                                         || it.text()->isFirstInSequence(it.pit()))) {
4579                                 if (counters.hasCounter(lcounter))
4580                                         counters.step(lcounter, utype);
4581                                 par.params().labelString(par.expandLabel(layout, bp));
4582                         } else
4583                                 par.params().labelString(docstring());
4584                 } else
4585                         par.params().labelString(par.expandLabel(layout, bp));
4586                 break;
4587         }
4588
4589         case LABEL_MANUAL:
4590         case LABEL_BIBLIO:
4591                 par.params().labelString(par.expandLabel(layout, bp));
4592         }
4593 }
4594
4595
4596 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
4597 {
4598         // LASSERT: Is it safe to continue here, or should we just return?
4599         LASSERT(parit.pit() == 0, /**/);
4600
4601         // Set the position of the text in the buffer to be able
4602         // to resolve macros in it.
4603         parit.text()->setMacrocontextPosition(parit);
4604
4605         depth_type maxdepth = 0;
4606         pit_type const lastpit = parit.lastpit();
4607         for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
4608                 // reduce depth if necessary
4609                 if (parit->params().depth() > maxdepth) {
4610                         /** FIXME: this function is const, but
4611                          * nevertheless it modifies the buffer. To be
4612                          * cleaner, one should modify the buffer in
4613                          * another function, which is actually
4614                          * non-const. This would however be costly in
4615                          * terms of code duplication.
4616                          */
4617                         const_cast<Buffer *>(this)->undo().recordUndo(CursorData(parit));
4618                         parit->params().depth(maxdepth);
4619                 }
4620                 maxdepth = parit->getMaxDepthAfter();
4621
4622                 if (utype == OutputUpdate) {
4623                         // track the active counters
4624                         // we have to do this for the master buffer, since the local
4625                         // buffer isn't tracking anything.
4626                         masterBuffer()->params().documentClass().counters().
4627                                         setActiveLayout(parit->layout());
4628                 }
4629
4630                 // set the counter for this paragraph
4631                 d->setLabel(parit, utype);
4632
4633                 // now the insets
4634                 InsetList::const_iterator iit = parit->insetList().begin();
4635                 InsetList::const_iterator end = parit->insetList().end();
4636                 for (; iit != end; ++iit) {
4637                         parit.pos() = iit->pos;
4638                         iit->inset->updateBuffer(parit, utype);
4639                 }
4640         }
4641 }
4642
4643
4644 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
4645         WordLangTuple & word_lang, docstring_list & suggestions) const
4646 {
4647         int progress = 0;
4648         WordLangTuple wl;
4649         suggestions.clear();
4650         word_lang = WordLangTuple();
4651         bool const to_end = to.empty();
4652         DocIterator const end = to_end ? doc_iterator_end(this) : to;
4653         // OK, we start from here.
4654         for (; from != end; from.forwardPos()) {
4655                 // We are only interested in text so remove the math CursorSlice.
4656                 while (from.inMathed()) {
4657                         from.pop_back();
4658                         from.pos()++;
4659                 }
4660                 // If from is at the end of the document (which is possible
4661                 // when leaving the mathed) LyX will crash later otherwise.
4662                 if (from.atEnd() || (!to_end && from >= end))
4663                         break;
4664                 to = from;
4665                 from.paragraph().spellCheck();
4666                 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
4667                 if (SpellChecker::misspelled(res)) {
4668                         word_lang = wl;
4669                         break;
4670                 }
4671
4672                 // Do not increase progress when from == to, otherwise the word
4673                 // count will be wrong.
4674                 if (from != to) {
4675                         from = to;
4676                         ++progress;
4677                 }
4678         }
4679         return progress;
4680 }
4681
4682
4683 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
4684 {
4685         bool inword = false;
4686         word_count_ = 0;
4687         char_count_ = 0;
4688         blank_count_ = 0;
4689
4690         for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
4691                 if (!dit.inTexted()) {
4692                         dit.forwardPos();
4693                         continue;
4694                 }
4695
4696                 Paragraph const & par = dit.paragraph();
4697                 pos_type const pos = dit.pos();
4698
4699                 // Copied and adapted from isWordSeparator() in Paragraph
4700                 if (pos == dit.lastpos()) {
4701                         inword = false;
4702                 } else {
4703                         Inset const * ins = par.getInset(pos);
4704                         if (ins && skipNoOutput && !ins->producesOutput()) {
4705                                 // skip this inset
4706                                 ++dit.top().pos();
4707                                 // stop if end of range was skipped
4708                                 if (!to.atEnd() && dit >= to)
4709                                         break;
4710                                 continue;
4711                         } else if (!par.isDeleted(pos)) {
4712                                 if (par.isWordSeparator(pos))
4713                                         inword = false;
4714                                 else if (!inword) {
4715                                         ++word_count_;
4716                                         inword = true;
4717                                 }
4718                                 if (ins && ins->isLetter())
4719                                         ++char_count_;
4720                                 else if (ins && ins->isSpace())
4721                                         ++blank_count_;
4722                                 else {
4723                                         char_type const c = par.getChar(pos);
4724                                         if (isPrintableNonspace(c))
4725                                                 ++char_count_;
4726                                         else if (isSpace(c))
4727                                                 ++blank_count_;
4728                                 }
4729                         }
4730                 }
4731                 dit.forwardPos();
4732         }
4733 }
4734
4735
4736 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
4737 {
4738         d->updateStatistics(from, to, skipNoOutput);
4739 }
4740
4741
4742 int Buffer::wordCount() const
4743 {
4744         return d->wordCount();
4745 }
4746
4747
4748 int Buffer::charCount(bool with_blanks) const
4749 {
4750         return d->charCount(with_blanks);
4751 }
4752
4753
4754 Buffer::ReadStatus Buffer::reload()
4755 {
4756         setBusy(true);
4757         // c.f. bug http://www.lyx.org/trac/ticket/6587
4758         removeAutosaveFile();
4759         // e.g., read-only status could have changed due to version control
4760         d->filename.refresh();
4761         docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
4762
4763         // clear parent. this will get reset if need be.
4764         d->setParent(0);
4765         ReadStatus const status = loadLyXFile();
4766         if (status == ReadSuccess) {
4767                 updateBuffer();
4768                 changed(true);
4769                 updateTitles();
4770                 markClean();
4771                 message(bformat(_("Document %1$s reloaded."), disp_fn));
4772                 d->undo_.clear();
4773         } else {
4774                 message(bformat(_("Could not reload document %1$s."), disp_fn));
4775         }
4776         setBusy(false);
4777         removePreviews();
4778         updatePreviews();
4779         errors("Parse");
4780         return status;
4781 }
4782
4783
4784 bool Buffer::saveAs(FileName const & fn)
4785 {
4786         FileName const old_name = fileName();
4787         FileName const old_auto = getAutosaveFileName();
4788         bool const old_unnamed = isUnnamed();
4789
4790         setFileName(fn);
4791         markDirty();
4792         setUnnamed(false);
4793
4794         if (save()) {
4795                 // bring the autosave file with us, just in case.
4796                 moveAutosaveFile(old_auto);
4797                 // validate version control data and
4798                 // correct buffer title
4799                 lyxvc().file_found_hook(fileName());
4800                 updateTitles();
4801                 // the file has now been saved to the new location.
4802                 // we need to check that the locations of child buffers
4803                 // are still valid.
4804                 checkChildBuffers();
4805                 checkMasterBuffer();
4806                 return true;
4807         } else {
4808                 // save failed
4809                 // reset the old filename and unnamed state
4810                 setFileName(old_name);
4811                 setUnnamed(old_unnamed);
4812                 return false;
4813         }
4814 }
4815
4816
4817 // FIXME We could do better here, but it is complicated. What would be
4818 // nice is to offer either (a) to save the child buffer to an appropriate
4819 // location, so that it would "move with the master", or else (b) to update
4820 // the InsetInclude so that it pointed to the same file. But (a) is a bit
4821 // complicated, because the code for this lives in GuiView.
4822 void Buffer::checkChildBuffers()
4823 {
4824         Impl::BufferPositionMap::iterator it = d->children_positions.begin();
4825         Impl::BufferPositionMap::iterator const en = d->children_positions.end();
4826         for (; it != en; ++it) {
4827                 DocIterator dit = it->second;
4828                 Buffer * cbuf = const_cast<Buffer *>(it->first);
4829                 if (!cbuf || !theBufferList().isLoaded(cbuf))
4830                         continue;
4831                 Inset * inset = dit.nextInset();
4832                 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
4833                 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
4834                 docstring const & incfile = inset_inc->getParam("filename");
4835                 string oldloc = cbuf->absFileName();
4836                 string newloc = makeAbsPath(to_utf8(incfile),
4837                                 onlyPath(absFileName())).absFileName();
4838                 if (oldloc == newloc)
4839                         continue;
4840                 // the location of the child file is incorrect.
4841                 Alert::warning(_("Included File Invalid"),
4842                                 bformat(_("Saving this document to a new location has made the file:\n"
4843                                 "  %1$s\n"
4844                                 "inaccessible. You will need to update the included filename."),
4845                                 from_utf8(oldloc)));
4846                 cbuf->setParent(0);
4847                 inset_inc->setChildBuffer(0);
4848         }
4849         // invalidate cache of children
4850         d->children_positions.clear();
4851         d->position_to_children.clear();
4852 }
4853
4854
4855 // If a child has been saved under a different name/path, it might have been
4856 // orphaned. Therefore the master needs to be reset (bug 8161).
4857 void Buffer::checkMasterBuffer()
4858 {
4859         Buffer const * const master = masterBuffer();
4860         if (master == this)
4861                 return;
4862
4863         // necessary to re-register the child (bug 5873)
4864         // FIXME: clean up updateMacros (here, only
4865         // child registering is needed).
4866         master->updateMacros();
4867         // (re)set master as master buffer, but only
4868         // if we are a real child
4869         if (master->isChild(this))
4870                 setParent(master);
4871         else
4872                 setParent(0);
4873 }
4874
4875 } // namespace lyx