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