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