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