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