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