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 "Lexer.h"
  45 #include "LyXAction.h"
  46 #include "LyX.h"
  47 #include "LyXRC.h"
  48 #include "LyXVC.h"
  49 #include "output.h"
  50 #include "output_latex.h"
  51 #include "output_docbook.h"
  52 #include "output_plaintext.h"
  53 #include "output_xhtml.h"
  54 #include "Paragraph.h"
  55 #include "ParagraphParameters.h"
  56 #include "ParIterator.h"
  57 #include "PDFOptions.h"
  58 #include "Session.h"
  59 #include "SpellChecker.h"
  60 #include "xml.h"
  61 #include "texstream.h"
  62 #include "TexRow.h"
  63 #include "Text.h"
  64 #include "TextClass.h"
  65 #include "TocBackend.h"
  66 #include "Undo.h"
  67 #include "VCBackend.h"
  68 #include "version.h"
  69 #include "WordLangTuple.h"
  70
  71 #include "insets/InsetBranch.h"
  72 #include "insets/InsetInclude.h"
  73 #include "insets/InsetText.h"
  74
  75 #include "mathed/InsetMathHull.h"
  76 #include "mathed/MacroTable.h"
  77 #include "mathed/InsetMathMacroTemplate.h"
  78 #include "mathed/MathSupport.h"
  79
  80 #include "graphics/PreviewLoader.h"
  81
  82 #include "frontends/Application.h"
  83 #include "frontends/alert.h"
  84 #include "frontends/Delegates.h"
  85 #include "frontends/WorkAreaManager.h"
  86
  87 #include "support/lassert.h"
  88 #include "support/convert.h"
  89 #include "support/debug.h"
  90 #include "support/docstring_list.h"
  91 #include "support/ExceptionMessage.h"
  92 #include "support/FileMonitor.h"
  93 #include "support/FileName.h"
  94 #include "support/FileNameList.h"
  95 #include "support/filetools.h"
  96 #include "support/gettext.h"
  97 #include "support/gzstream.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::pair<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_pair(tocit.str(), tocit.asString()));
2438         }
2439 }
2440
2441
2442 void Buffer::invalidateBibinfoCache() const
2443 {
2444         d->bibinfo_cache_valid_ = false;
2445         d->cite_labels_valid_ = false;
2446         removeBiblioTempFiles();
2447         // also invalidate the cache for the parent buffer
2448         Buffer const * const pbuf = d->parent();
2449         if (pbuf)
2450                 pbuf->invalidateBibinfoCache();
2451 }
2452
2453
2454 docstring_list const & Buffer::getBibfiles(UpdateScope scope) const
2455 {
2456         // FIXME This is probably unnecessary, given where we call this.
2457         // If this is a child document, use the master instead.
2458         Buffer const * const pbuf = masterBuffer();
2459         if (pbuf != this && scope != UpdateChildOnly)
2460                 return pbuf->getBibfiles();
2461
2462         // In 2.3.x, we have:
2463         //if (!d->bibfile_cache_valid_)
2464         //      this->updateBibfilesCache(scope);
2465         // I think that is a leftover, but there have been so many back-
2466         // and-forths with this, due to Windows issues, that I am not sure.
2467
2468         return d->bibfiles_cache_;
2469 }
2470
2471
2472 BiblioInfo const & Buffer::masterBibInfo() const
2473 {
2474         Buffer const * const tmp = masterBuffer();
2475         if (tmp != this)
2476                 return tmp->masterBibInfo();
2477         return d->bibinfo_;
2478 }
2479
2480
2481 BiblioInfo const & Buffer::bibInfo() const
2482 {
2483         return d->bibinfo_;
2484 }
2485
2486
2487 void Buffer::registerBibfiles(const docstring_list & bf) const
2488 {
2489         // We register the bib files in the master buffer,
2490         // if there is one, but also in every single buffer,
2491         // in case a child is compiled alone.
2492         Buffer const * const tmp = masterBuffer();
2493         if (tmp != this)
2494                 tmp->registerBibfiles(bf);
2495
2496         for (auto const & p : bf) {
2497                 docstring_list::const_iterator temp =
2498                         find(d->bibfiles_cache_.begin(), d->bibfiles_cache_.end(), p);
2499                 if (temp == d->bibfiles_cache_.end())
2500                         d->bibfiles_cache_.push_back(p);
2501         }
2502 }
2503
2504
2505 static map<docstring, FileName> bibfileCache;
2506
2507 FileName Buffer::getBibfilePath(docstring const & bibid) const
2508 {
2509         map<docstring, FileName>::const_iterator it =
2510                 bibfileCache.find(bibid);
2511         if (it != bibfileCache.end()) {
2512                 // i.e., return bibfileCache[bibid];
2513                 return it->second;
2514         }
2515
2516         LYXERR(Debug::FILES, "Reading file location for " << bibid);
2517         string const texfile = changeExtension(to_utf8(bibid), "bib");
2518         // we need to check first if this file exists where it's said to be.
2519         // there's a weird bug that occurs otherwise: if the file is in the
2520         // Buffer's directory but has the same name as some file that would be
2521         // found by kpsewhich, then we find the latter, not the former.
2522         FileName const local_file = makeAbsPath(texfile, filePath());
2523         FileName file = local_file;
2524         if (!file.exists()) {
2525                 // there's no need now to check whether the file can be found
2526                 // locally
2527                 file = findtexfile(texfile, "bib", true);
2528                 if (file.empty())
2529                         file = local_file;
2530         }
2531         LYXERR(Debug::FILES, "Found at: " << file);
2532
2533         bibfileCache[bibid] = file;
2534         return bibfileCache[bibid];
2535 }
2536
2537
2538 void Buffer::checkIfBibInfoCacheIsValid() const
2539 {
2540         // use the master's cache
2541         Buffer const * const tmp = masterBuffer();
2542         if (tmp != this) {
2543                 tmp->checkIfBibInfoCacheIsValid();
2544                 return;
2545         }
2546
2547         // If we already know the cache is invalid, stop here.
2548         // This is important in the case when the bibliography
2549         // environment (rather than Bib[la]TeX) is used.
2550         // In that case, the timestamp check below gives no
2551         // sensible result. Rather than that, the cache will
2552         // be invalidated explicitly via invalidateBibInfoCache()
2553         // by the Bibitem inset.
2554         // Same applies for bib encoding changes, which trigger
2555         // invalidateBibInfoCache() by InsetBibtex.
2556         if (!d->bibinfo_cache_valid_)
2557                 return;
2558
2559         if (d->have_bibitems_) {
2560                 // We have a bibliography environment.
2561                 // Invalidate the bibinfo cache unconditionally.
2562                 // Cite labels will get invalidated by the inset if needed.
2563                 d->bibinfo_cache_valid_ = false;
2564                 return;
2565         }
2566
2567         // OK. This is with Bib(la)tex. We'll assume the cache
2568         // is valid and change this if we find changes in the bibs.
2569         d->bibinfo_cache_valid_ = true;
2570         d->cite_labels_valid_ = true;
2571
2572         // compare the cached timestamps with the actual ones.
2573         docstring_list const & bibfiles_cache = getBibfiles();
2574         for (auto const & bf : bibfiles_cache) {
2575                 FileName const fn = getBibfilePath(bf);
2576                 time_t lastw = fn.lastModified();
2577                 time_t prevw = d->bibfile_status_[fn];
2578                 if (lastw != prevw) {
2579                         d->bibinfo_cache_valid_ = false;
2580                         d->cite_labels_valid_ = false;
2581                         d->bibfile_status_[fn] = lastw;
2582                 }
2583         }
2584 }
2585
2586
2587 void Buffer::clearBibFileCache() const
2588 {
2589         bibfileCache.clear();
2590 }
2591
2592
2593 void Buffer::reloadBibInfoCache(bool const force) const
2594 {
2595         // we should not need to do this for internal buffers
2596         if (isInternal())
2597                 return;
2598
2599         // use the master's cache
2600         Buffer const * const tmp = masterBuffer();
2601         if (tmp != this) {
2602                 tmp->reloadBibInfoCache(force);
2603                 return;
2604         }
2605
2606         if (!force) {
2607                 checkIfBibInfoCacheIsValid();
2608                 if (d->bibinfo_cache_valid_)
2609                         return;
2610         }
2611
2612         LYXERR(Debug::FILES, "Bibinfo cache was invalid.");
2613         // re-read file locations when this info changes
2614         // FIXME Is this sufficient? Or should we also force that
2615         // in some other cases? If so, then it is easy enough to
2616         // add the following line in some other places.
2617         clearBibFileCache();
2618         d->bibinfo_.clear();
2619         FileNameList checkedFiles;
2620         d->have_bibitems_ = false;
2621         collectBibKeys(checkedFiles);
2622         d->bibinfo_cache_valid_ = true;
2623 }
2624
2625
2626 void Buffer::collectBibKeys(FileNameList & checkedFiles) const
2627 {
2628         if (!parent())
2629                 clearIncludeList();
2630
2631         for (InsetIterator it = begin(inset()); it; ++it) {
2632                 it->collectBibKeys(it, checkedFiles);
2633                 if (it->lyxCode() == BIBITEM_CODE) {
2634                         if (parent() != nullptr)
2635                                 parent()->d->have_bibitems_ = true;
2636                         else
2637                                 d->have_bibitems_ = true;
2638                 }
2639         }
2640 }
2641
2642
2643 void Buffer::addBiblioInfo(BiblioInfo const & bi_in) const
2644 {
2645         // We add the biblio info to the parent buffer,
2646         // if there is one, but also to this buffer, in case
2647         // it is compiled alone.
2648         BiblioInfo & our_bi = d->bibinfo_;
2649         our_bi.mergeBiblioInfo(bi_in);
2650
2651         if (parent())
2652                 parent()->addBiblioInfo(bi_in);
2653 }
2654
2655
2656 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bin) const
2657 {
2658         // We add the bibtex info to the master buffer,
2659         // if there is one, but also to every single buffer,
2660         // in case a child is compiled alone.
2661         BiblioInfo & bi = d->bibinfo_;
2662         bi[key] = bin;
2663
2664         if (parent() != nullptr) {
2665                 BiblioInfo & masterbi = masterBuffer()->d->bibinfo_;
2666                 masterbi[key] = bin;
2667         }
2668 }
2669
2670
2671 void Buffer::makeCitationLabels() const
2672 {
2673         Buffer const * const master = masterBuffer();
2674         return d->bibinfo_.makeCitationLabels(*master);
2675 }
2676
2677
2678 void Buffer::invalidateCiteLabels() const
2679 {
2680         masterBuffer()->d->cite_labels_valid_ = false;
2681 }
2682
2683 bool Buffer::citeLabelsValid() const
2684 {
2685         return masterBuffer()->d->cite_labels_valid_;
2686 }
2687
2688
2689 void Buffer::removeBiblioTempFiles() const
2690 {
2691         // We remove files that contain LaTeX commands specific to the
2692         // particular bibliographic style being used, in order to avoid
2693         // LaTeX errors when we switch style.
2694         FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2695         FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2696         LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2697         aux_file.removeFile();
2698         LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2699         bbl_file.removeFile();
2700         // Also for the parent buffer
2701         Buffer const * const pbuf = parent();
2702         if (pbuf)
2703                 pbuf->removeBiblioTempFiles();
2704 }
2705
2706
2707 bool Buffer::isDepClean(string const & name) const
2708 {
2709         DepClean::const_iterator const it = d->dep_clean.find(name);
2710         if (it == d->dep_clean.end())
2711                 return true;
2712         return it->second;
2713 }
2714
2715
2716 void Buffer::markDepClean(string const & name)
2717 {
2718         d->dep_clean[name] = true;
2719 }
2720
2721
2722 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag) const
2723 {
2724         if (isInternal()) {
2725                 // FIXME? if there is an Buffer LFUN that can be dispatched even
2726                 // if internal, put a switch '(cmd.action)' here.
2727                 return false;
2728         }
2729
2730         bool enable = true;
2731
2732         switch (cmd.action()) {
2733
2734         case LFUN_BUFFER_TOGGLE_READ_ONLY:
2735                 flag.setOnOff(hasReadonlyFlag());
2736                 break;
2737
2738                 // FIXME: There is need for a command-line import.
2739                 //case LFUN_BUFFER_IMPORT:
2740
2741         case LFUN_BUFFER_AUTO_SAVE:
2742                 break;
2743
2744         case LFUN_BUFFER_EXPORT_CUSTOM:
2745                 // FIXME: Nothing to check here?
2746                 break;
2747
2748         case LFUN_BUFFER_EXPORT: {
2749                 docstring const & arg = cmd.argument();
2750                 if (arg == "custom") {
2751                         enable = true;
2752                         break;
2753                 }
2754                 string format = (arg.empty() || arg == "default") ?
2755                         params().getDefaultOutputFormat() : to_utf8(arg);
2756                 size_t pos = format.find(' ');
2757                 if (pos != string::npos)
2758                         format = format.substr(0, pos);
2759                 enable = params().isExportable(format, false);
2760                 if (!enable)
2761                         flag.message(bformat(
2762                                              _("Don't know how to export to format: %1$s"), arg));
2763                 break;
2764         }
2765
2766         case LFUN_BUILD_PROGRAM:
2767                 enable = params().isExportable("program", false);
2768                 break;
2769
2770         case LFUN_BRANCH_ACTIVATE:
2771         case LFUN_BRANCH_DEACTIVATE:
2772         case LFUN_BRANCH_MASTER_ACTIVATE:
2773         case LFUN_BRANCH_MASTER_DEACTIVATE: {
2774                 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2775                                      || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2776                 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2777                         : params().branchlist();
2778                 docstring const & branchName = cmd.argument();
2779                 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2780                 break;
2781         }
2782
2783         case LFUN_BRANCH_ADD:
2784         case LFUN_BRANCHES_RENAME:
2785                 // if no Buffer is present, then of course we won't be called!
2786                 break;
2787
2788         case LFUN_BUFFER_LANGUAGE:
2789                 enable = !isReadonly();
2790                 break;
2791
2792         case LFUN_BUFFER_VIEW_CACHE:
2793                 (d->preview_file_).refresh();
2794                 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2795                 break;
2796
2797         case LFUN_CHANGES_TRACK:
2798                 flag.setEnabled(true);
2799                 flag.setOnOff(params().track_changes);
2800                 break;
2801
2802         case LFUN_CHANGES_OUTPUT:
2803                 flag.setEnabled(true);
2804                 flag.setOnOff(params().output_changes);
2805                 break;
2806
2807         case LFUN_BUFFER_TOGGLE_COMPRESSION:
2808                 flag.setOnOff(params().compressed);
2809                 break;
2810
2811         case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2812                 flag.setOnOff(params().output_sync);
2813                 break;
2814
2815         case LFUN_BUFFER_ANONYMIZE:
2816                 break;
2817
2818         default:
2819                 return false;
2820         }
2821         flag.setEnabled(enable);
2822         return true;
2823 }
2824
2825
2826 void Buffer::dispatch(string const & command, DispatchResult & result)
2827 {
2828         return dispatch(lyxaction.lookupFunc(command), result);
2829 }
2830
2831
2832 // NOTE We can end up here even if we have no GUI, because we are called
2833 // by LyX::exec to handled command-line requests. So we may need to check
2834 // whether we have a GUI or not. The boolean use_gui holds this information.
2835 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2836 {
2837         if (isInternal()) {
2838                 // FIXME? if there is an Buffer LFUN that can be dispatched even
2839                 // if internal, put a switch '(cmd.action())' here.
2840                 dr.dispatched(false);
2841                 return;
2842         }
2843         string const argument = to_utf8(func.argument());
2844         // We'll set this back to false if need be.
2845         bool dispatched = true;
2846         // This handles undo groups automagically
2847         UndoGroupHelper ugh(this);
2848
2849         switch (func.action()) {
2850         case LFUN_BUFFER_TOGGLE_READ_ONLY:
2851                 if (lyxvc().inUse()) {
2852                         string log = lyxvc().toggleReadOnly();
2853                         if (!log.empty())
2854                                 dr.setMessage(log);
2855                 }
2856                 else
2857                         setReadonly(!hasReadonlyFlag());
2858                 break;
2859
2860         case LFUN_BUFFER_EXPORT: {
2861                 string const format = (argument.empty() || argument == "default") ?
2862                         params().getDefaultOutputFormat() : argument;
2863                 ExportStatus const status = doExport(format, false);
2864                 dr.setError(status != ExportSuccess);
2865                 if (status != ExportSuccess)
2866                         dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2867                                               from_utf8(format)));
2868                 break;
2869         }
2870
2871         case LFUN_BUILD_PROGRAM: {
2872                 ExportStatus const status = doExport("program", true);
2873                 dr.setError(status != ExportSuccess);
2874                 if (status != ExportSuccess)
2875                         dr.setMessage(_("Error generating literate programming code."));
2876                 break;
2877         }
2878
2879         case LFUN_BUFFER_EXPORT_CUSTOM: {
2880                 string format_name;
2881                 string command = split(argument, format_name, ' ');
2882                 Format const * format = theFormats().getFormat(format_name);
2883                 if (!format) {
2884                         lyxerr << "Format \"" << format_name
2885                                 << "\" not recognized!"
2886                                 << endl;
2887                         break;
2888                 }
2889
2890                 // The name of the file created by the conversion process
2891                 string filename;
2892
2893                 // Output to filename
2894                 if (format->name() == "lyx") {
2895                         string const latexname = latexName(false);
2896                         filename = changeExtension(latexname,
2897                                 format->extension());
2898                         filename = addName(temppath(), filename);
2899
2900                         if (!writeFile(FileName(filename)))
2901                                 break;
2902
2903                 } else {
2904                         doExport(format_name, true, filename);
2905                 }
2906
2907                 // Substitute $$FName for filename
2908                 if (!contains(command, "$$FName"))
2909                         command = "( " + command + " ) < $$FName";
2910                 command = subst(command, "$$FName", filename);
2911
2912                 // Execute the command in the background
2913                 Systemcall call;
2914                 call.startscript(Systemcall::DontWait, command,
2915                                  filePath(), layoutPos());
2916                 break;
2917         }
2918
2919         // FIXME: There is need for a command-line import.
2920         /*
2921         case LFUN_BUFFER_IMPORT:
2922                 doImport(argument);
2923                 break;
2924         */
2925
2926         case LFUN_BUFFER_AUTO_SAVE:
2927                 autoSave();
2928                 resetAutosaveTimers();
2929                 break;
2930
2931         case LFUN_BRANCH_ACTIVATE:
2932         case LFUN_BRANCH_DEACTIVATE:
2933         case LFUN_BRANCH_MASTER_ACTIVATE:
2934         case LFUN_BRANCH_MASTER_DEACTIVATE: {
2935                 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2936                                      || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2937                 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2938                                       : this;
2939
2940                 docstring const & branch_name = func.argument();
2941                 // the case without a branch name is handled elsewhere
2942                 if (branch_name.empty()) {
2943                         dispatched = false;
2944                         break;
2945                 }
2946                 Branch * branch = buf->params().branchlist().find(branch_name);
2947                 if (!branch) {
2948                         LYXERR0("Branch " << branch_name << " does not exist.");
2949                         dr.setError(true);
2950                         docstring const msg =
2951                                 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2952                         dr.setMessage(msg);
2953                         break;
2954                 }
2955                 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2956                                        || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2957                 if (branch->isSelected() != activate) {
2958                         buf->undo().recordUndoBufferParams(CursorData());
2959                         branch->setSelected(activate);
2960                         dr.setError(false);
2961                         dr.screenUpdate(Update::Force);
2962                         dr.forceBufferUpdate();
2963                 }
2964                 break;
2965         }
2966
2967         case LFUN_BRANCH_ADD: {
2968                 docstring const & branchnames = func.argument();
2969                 if (branchnames.empty()) {
2970                         dispatched = false;
2971                         break;
2972                 }
2973                 BranchList & branch_list = params().branchlist();
2974                 vector<docstring> const branches =
2975                         getVectorFromString(branchnames, branch_list.separator());
2976                 docstring msg;
2977                 for (docstring const & branch_name : branches) {
2978                         Branch * branch = branch_list.find(branch_name);
2979                         if (branch) {
2980                                 LYXERR0("Branch " << branch_name << " already exists.");
2981                                 dr.setError(true);
2982                                 if (!msg.empty())
2983                                         msg += ("\n");
2984                                 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2985                         } else {
2986                                 undo().recordUndoBufferParams(CursorData());
2987                                 branch_list.add(branch_name);
2988                                 branch = branch_list.find(branch_name);
2989                                 if (branch)
2990                                         // needed to update the color table for dark mode
2991                                         branch->setColors("background", "background");
2992                                 dr.setError(false);
2993                                 dr.screenUpdate(Update::Force);
2994                         }
2995                 }
2996                 if (!msg.empty())
2997                         dr.setMessage(msg);
2998                 break;
2999         }
3000
3001         case LFUN_BRANCHES_RENAME: {
3002                 if (func.argument().empty())
3003                         break;
3004
3005                 docstring const oldname = from_utf8(func.getArg(0));
3006                 docstring const newname = from_utf8(func.getArg(1));
3007                 InsetIterator it  = begin(inset());
3008                 InsetIterator const itend = end(inset());
3009                 bool success = false;
3010                 for (; it != itend; ++it) {
3011                         if (it->lyxCode() == BRANCH_CODE) {
3012                                 InsetBranch & ins = static_cast<InsetBranch &>(*it);
3013                                 if (ins.branch() == oldname) {
3014                                         undo().recordUndo(CursorData(it));
3015                                         ins.rename(newname);
3016                                         success = true;
3017                                         continue;
3018                                 }
3019                         }
3020                         if (it->lyxCode() == INCLUDE_CODE) {
3021                                 // get buffer of external file
3022                                 InsetInclude const & ins =
3023                                         static_cast<InsetInclude const &>(*it);
3024                                 Buffer * child = ins.loadIfNeeded();
3025                                 if (!child)
3026                                         continue;
3027                                 child->dispatch(func, dr);
3028                         }
3029                 }
3030
3031                 if (success) {
3032                         dr.screenUpdate(Update::Force);
3033                         dr.forceBufferUpdate();
3034                 }
3035                 break;
3036         }
3037
3038         case LFUN_BUFFER_VIEW_CACHE:
3039                 if (!theFormats().view(*this, d->preview_file_,
3040                                   d->preview_format_))
3041                         dr.setMessage(_("Error viewing the output file."));
3042                 break;
3043
3044         case LFUN_CHANGES_TRACK:
3045                 if (params().save_transient_properties)
3046                         undo().recordUndoBufferParams(CursorData());
3047                 params().track_changes = !params().track_changes;
3048                 break;
3049
3050         case LFUN_CHANGES_OUTPUT:
3051                 if (params().save_transient_properties)
3052                         undo().recordUndoBufferParams(CursorData());
3053                 params().output_changes = !params().output_changes;
3054                 if (params().output_changes) {
3055                         bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
3056                                           LaTeXFeatures::isAvailable("xcolor");
3057
3058                         if (!xcolorulem) {
3059                                 Alert::warning(_("Changes not shown in LaTeX output"),
3060                                                _("Changes will not be highlighted in LaTeX output, "
3061                                                  "because xcolor and ulem are not installed.\n"
3062                                                  "Please install both packages or redefine "
3063                                                  "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3064                         }
3065                 }
3066                 break;
3067
3068         case LFUN_BUFFER_TOGGLE_COMPRESSION:
3069                 // turn compression on/off
3070                 undo().recordUndoBufferParams(CursorData());
3071                 params().compressed = !params().compressed;
3072                 break;
3073
3074         case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
3075                 undo().recordUndoBufferParams(CursorData());
3076                 params().output_sync = !params().output_sync;
3077                 break;
3078
3079         case LFUN_BUFFER_ANONYMIZE: {
3080                 undo().recordUndoFullBuffer(CursorData());
3081                 CursorData cur(doc_iterator_begin(this));
3082                 for ( ; cur ; cur.forwardPar())
3083                         cur.paragraph().anonymize();
3084                 dr.forceBufferUpdate();
3085                 dr.screenUpdate(Update::Force);
3086                 break;
3087         }
3088
3089         default:
3090                 dispatched = false;
3091                 break;
3092         }
3093         dr.dispatched(dispatched);
3094 }
3095
3096
3097 void Buffer::changeLanguage(Language const * from, Language const * to)
3098 {
3099         LASSERT(from, return);
3100         LASSERT(to, return);
3101
3102         ParIterator it = par_iterator_begin();
3103         ParIterator eit = par_iterator_end();
3104         for (; it != eit; ++it)
3105                 it->changeLanguage(params(), from, to);
3106 }
3107
3108
3109 bool Buffer::isMultiLingual() const
3110 {
3111         ParConstIterator end = par_iterator_end();
3112         for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3113                 if (it->isMultiLingual(params()))
3114                         return true;
3115
3116         return false;
3117 }
3118
3119
3120 std::set<Language const *> Buffer::getLanguages() const
3121 {
3122         std::set<Language const *> langs;
3123         getLanguages(langs);
3124         return langs;
3125 }
3126
3127
3128 void Buffer::getLanguages(std::set<Language const *> & langs) const
3129 {
3130         ParConstIterator end = par_iterator_end();
3131         // add the buffer language, even if it's not actively used
3132         langs.insert(language());
3133         // iterate over the paragraphs
3134         for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3135                 it->getLanguages(langs);
3136         // also children
3137         ListOfBuffers clist = getDescendants();
3138         for (auto const & cit : clist)
3139                 cit->getLanguages(langs);
3140 }
3141
3142
3143 DocIterator Buffer::getParFromID(int const id) const
3144 {
3145         Buffer * buf = const_cast<Buffer *>(this);
3146         if (id < 0)
3147                 // This means non-existent
3148                 return doc_iterator_end(buf);
3149
3150         for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
3151                 if (it.paragraph().id() == id)
3152                         return it;
3153
3154         return doc_iterator_end(buf);
3155 }
3156
3157
3158 bool Buffer::hasParWithID(int const id) const
3159 {
3160         return !getParFromID(id).atEnd();
3161 }
3162
3163
3164 ParIterator Buffer::par_iterator_begin()
3165 {
3166         return ParIterator(doc_iterator_begin(this));
3167 }
3168
3169
3170 ParIterator Buffer::par_iterator_end()
3171 {
3172         return ParIterator(doc_iterator_end(this));
3173 }
3174
3175
3176 ParConstIterator Buffer::par_iterator_begin() const
3177 {
3178         return ParConstIterator(doc_iterator_begin(this));
3179 }
3180
3181
3182 ParConstIterator Buffer::par_iterator_end() const
3183 {
3184         return ParConstIterator(doc_iterator_end(this));
3185 }
3186
3187 bool Buffer::empty() const
3188 {
3189         return paragraphs().size() == 1 && paragraphs().front().empty();
3190 }
3191
3192
3193 Language const * Buffer::language() const
3194 {
3195         return params().language;
3196 }
3197
3198
3199 docstring Buffer::B_(string const & l10n) const
3200 {
3201         return params().B_(l10n);
3202 }
3203
3204
3205 bool Buffer::isClean() const
3206 {
3207         return d->lyx_clean;
3208 }
3209
3210
3211 bool Buffer::isChecksumModified() const
3212 {
3213         LASSERT(d->filename.exists(), return false);
3214         return d->checksum_ != d->filename.checksum();
3215 }
3216
3217
3218 void Buffer::saveCheckSum() const
3219 {
3220         FileName const & file = d->filename;
3221         file.refresh();
3222         d->checksum_ = file.exists() ? file.checksum()
3223                 : 0; // in the case of save to a new file.
3224 }
3225
3226
3227 void Buffer::markClean() const
3228 {
3229         if (!d->lyx_clean) {
3230                 d->lyx_clean = true;
3231                 updateTitles();
3232         }
3233         // if the .lyx file has been saved, we don't need an
3234         // autosave
3235         d->bak_clean = true;
3236         d->undo_.markDirty();
3237         clearExternalModification();
3238 }
3239
3240
3241 void Buffer::setUnnamed(bool flag)
3242 {
3243         d->unnamed = flag;
3244 }
3245
3246
3247 bool Buffer::isUnnamed() const
3248 {
3249         return d->unnamed;
3250 }
3251
3252
3253 /// \note
3254 /// Don't check unnamed, here: isInternal() is used in
3255 /// newBuffer(), where the unnamed flag has not been set by anyone
3256 /// yet. Also, for an internal buffer, there should be no need for
3257 /// retrieving fileName() nor for checking if it is unnamed or not.
3258 bool Buffer::isInternal() const
3259 {
3260         return d->internal_buffer;
3261 }
3262
3263
3264 void Buffer::setInternal(bool flag)
3265 {
3266         d->internal_buffer = flag;
3267 }
3268
3269
3270 void Buffer::markDirty()
3271 {
3272         if (d->lyx_clean) {
3273                 d->lyx_clean = false;
3274                 updateTitles();
3275         }
3276         d->bak_clean = false;
3277
3278         for (auto & depit : d->dep_clean)
3279                 depit.second = false;
3280 }
3281
3282
3283 FileName Buffer::fileName() const
3284 {
3285         return d->filename;
3286 }
3287
3288
3289 string Buffer::absFileName() const
3290 {
3291         return d->filename.absFileName();
3292 }
3293
3294
3295 string Buffer::filePath() const
3296 {
3297         string const abs = d->filename.onlyPath().absFileName();
3298         if (abs.empty())
3299                 return abs;
3300         int last = abs.length() - 1;
3301
3302         return abs[last] == '/' ? abs : abs + '/';
3303 }
3304
3305
3306 DocFileName Buffer::getReferencedFileName(string const & fn) const
3307 {
3308         DocFileName result;
3309         if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3310                 result.set(fn, filePath());
3311         else {
3312                 // filePath() ends with a path separator
3313                 FileName const test(filePath() + fn);
3314                 if (test.exists())
3315                         result.set(fn, filePath());
3316                 else
3317                         result.set(fn, params().origin);
3318         }
3319
3320         return result;
3321 }
3322
3323
3324 string const Buffer::prepareFileNameForLaTeX(string const & name,
3325                                              string const & ext, bool nice) const
3326 {
3327         string const fname = makeAbsPath(name, filePath()).absFileName();
3328         if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
3329                 return name;
3330         if (!nice)
3331                 return fname;
3332
3333         // FIXME UNICODE
3334         return to_utf8(makeRelPath(from_utf8(fname),
3335                 from_utf8(masterBuffer()->filePath())));
3336 }
3337
3338
3339 vector<pair<docstring, string>> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
3340                                                 docstring_list const & bibfilelist,
3341                                                 bool const add_extension) const
3342 {
3343         // If we are processing the LaTeX file in a temp directory then
3344         // copy the .bib databases to this temp directory, mangling their
3345         // names in the process. Store this mangled name in the list of
3346         // all databases.
3347         // (We need to do all this because BibTeX *really*, *really*
3348         // can't handle "files with spaces" and Windows users tend to
3349         // use such filenames.)
3350         // Otherwise, store the (maybe absolute) path to the original,
3351         // unmangled database name.
3352
3353         vector<pair<docstring, string>> res;
3354
3355         // determine the export format
3356         string const tex_format = flavor2format(runparams.flavor);
3357
3358         // check for spaces in paths
3359         bool found_space = false;
3360
3361         for (auto const & bit : bibfilelist) {
3362                 string utf8input = to_utf8(bit);
3363                 string database =
3364                         prepareFileNameForLaTeX(utf8input, ".bib", runparams.nice);
3365                 FileName try_in_file =
3366                         makeAbsPath(database + ".bib", filePath());
3367                 bool not_from_texmf = try_in_file.isReadableFile();
3368                 // If the file has not been found, try with the real file name
3369                 // (it might come from a child in a sub-directory)
3370                 if (!not_from_texmf) {
3371                         try_in_file = getBibfilePath(bit);
3372                         if (try_in_file.isReadableFile()) {
3373                                 // Check if the file is in texmf
3374                                 FileName kpsefile(findtexfile(changeExtension(utf8input, "bib"), "bib", true));
3375                                 not_from_texmf = kpsefile.empty()
3376                                                 || kpsefile.absFileName() != try_in_file.absFileName();
3377                                 if (not_from_texmf)
3378                                         // If this exists, make path relative to the master
3379                                         // FIXME Unicode
3380                                         database =
3381                                                 removeExtension(prepareFileNameForLaTeX(
3382                                                                                         to_utf8(makeRelPath(from_utf8(try_in_file.absFileName()),
3383                                                                                                                                 from_utf8(filePath()))),
3384                                                                                         ".bib", runparams.nice));
3385                         }
3386                 }
3387
3388                 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
3389                     not_from_texmf) {
3390                         // mangledFileName() needs the extension
3391                         DocFileName const in_file = DocFileName(try_in_file);
3392                         database = removeExtension(in_file.mangledFileName());
3393                         FileName const out_file = makeAbsPath(database + ".bib",
3394                                         masterBuffer()->temppath());
3395                         bool const success = in_file.copyTo(out_file);
3396                         if (!success) {
3397                                 LYXERR0("Failed to copy '" << in_file
3398                                        << "' to '" << out_file << "'");
3399                         }
3400                 } else if (!runparams.inComment && runparams.nice && not_from_texmf) {
3401                         runparams.exportdata->addExternalFile(tex_format, try_in_file, database + ".bib");
3402                         if (!isValidLaTeXFileName(database)) {
3403                                 frontend::Alert::warning(_("Invalid filename"),
3404                                          _("The following filename will cause troubles "
3405                                                "when running the exported file through LaTeX: ") +
3406                                              from_utf8(database));
3407                         }
3408                         if (!isValidDVIFileName(database)) {
3409                                 frontend::Alert::warning(_("Problematic filename for DVI"),
3410                                          _("The following filename can cause troubles "
3411                                                "when running the exported file through LaTeX "
3412                                                    "and opening the resulting DVI: ") +
3413                                              from_utf8(database), true);
3414                         }
3415                 }
3416
3417                 if (add_extension)
3418                         database += ".bib";
3419
3420                 // FIXME UNICODE
3421                 docstring const path = from_utf8(latex_path(database));
3422
3423                 if (contains(path, ' '))
3424                         found_space = true;
3425                 string enc;
3426                 if (params().useBiblatex() && !params().bibFileEncoding(utf8input).empty())
3427                         enc = params().bibFileEncoding(utf8input);
3428
3429                 bool recorded = false;
3430                 for (auto const & pe : res) {
3431                         if (pe.first == path) {
3432                                 recorded = true;
3433                                 break;
3434                         }
3435
3436                 }
3437                 if (!recorded)
3438                         res.push_back(make_pair(path, enc));
3439         }
3440
3441         // Check if there are spaces in the path and warn BibTeX users, if so.
3442         // (biber can cope with such paths)
3443         if (!prefixIs(runparams.bibtex_command, "biber")) {
3444                 // Post this warning only once.
3445                 static bool warned_about_spaces = false;
3446                 if (!warned_about_spaces &&
3447                     runparams.nice && found_space) {
3448                         warned_about_spaces = true;
3449                         Alert::warning(_("Export Warning!"),
3450                                        _("There are spaces in the paths to your BibTeX databases.\n"
3451                                                       "BibTeX will be unable to find them."));
3452                 }
3453         }
3454
3455         return res;
3456 }
3457
3458
3459
3460 string Buffer::layoutPos() const
3461 {
3462         return d->layout_position;
3463 }
3464
3465
3466 void Buffer::setLayoutPos(string const & path)
3467 {
3468         if (path.empty()) {
3469                 d->layout_position.clear();
3470                 return;
3471         }
3472
3473         LATTEST(FileName::isAbsolute(path));
3474
3475         d->layout_position =
3476                 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3477
3478         if (d->layout_position.empty())
3479                 d->layout_position = ".";
3480 }
3481
3482
3483 bool Buffer::hasReadonlyFlag() const
3484 {
3485         return d->read_only;
3486 }
3487
3488
3489 bool Buffer::isReadonly() const
3490 {
3491         return hasReadonlyFlag() || notifiesExternalModification();
3492 }
3493
3494
3495 void Buffer::setParent(Buffer const * buffer)
3496 {
3497         // We need to do some work here to avoid recursive parent structures.
3498         // This is the easy case.
3499         if (buffer == this) {
3500                 LYXERR0("Ignoring attempt to set self as parent in\n" << fileName());
3501                 return;
3502         }
3503         // Now we check parents going upward, to make sure that IF we set the
3504         // parent as requested, we would not generate a recursive include.
3505         set<Buffer const *> sb;
3506         Buffer const * b = buffer;
3507         bool found_recursion = false;
3508         while (b) {
3509                 if (sb.find(b) != sb.end()) {
3510                         found_recursion = true;
3511                         break;
3512                 }
3513                 sb.insert(b);
3514                 b = b->parent();
3515         }
3516
3517         if (found_recursion) {
3518                 LYXERR0("Ignoring attempt to set parent of\n" <<
3519                         fileName() <<
3520                         "\nto " <<
3521                         buffer->fileName() <<
3522                         "\nbecause that would create a recursive inclusion.");
3523                 return;
3524         }
3525
3526         // We should be safe now.
3527         d->setParent(buffer);
3528         updateMacros();
3529 }
3530
3531
3532 Buffer const * Buffer::parent() const
3533 {
3534         return d->parent();
3535 }
3536
3537
3538 ListOfBuffers Buffer::allRelatives() const
3539 {
3540         ListOfBuffers lb = masterBuffer()->getDescendants();
3541         lb.push_front(const_cast<Buffer *>(masterBuffer()));
3542         return lb;
3543 }
3544
3545
3546 Buffer const * Buffer::masterBuffer() const
3547 {
3548         Buffer const * const pbuf = d->parent();
3549         if (!pbuf)
3550                 return this;
3551
3552         return pbuf->masterBuffer();
3553 }
3554
3555
3556 bool Buffer::isChild(Buffer * child) const
3557 {
3558         return d->children_positions.find(child) != d->children_positions.end();
3559 }
3560
3561
3562 DocIterator Buffer::firstChildPosition(Buffer const * child)
3563 {
3564         Impl::BufferPositionMap::iterator it;
3565         it = d->children_positions.find(child);
3566         if (it == d->children_positions.end())
3567                 return DocIterator(this);
3568         return it->second;
3569 }
3570
3571
3572 bool Buffer::hasChildren() const
3573 {
3574         return !d->children_positions.empty();
3575 }
3576
3577
3578 void Buffer::collectChildren(ListOfBuffers & children, bool grand_children) const
3579 {
3580         // loop over children
3581         for (auto const & p : d->children_positions) {
3582                 Buffer * child = const_cast<Buffer *>(p.first);
3583                 // No duplicates
3584                 ListOfBuffers::const_iterator bit = find(children.begin(), children.end(), child);
3585                 if (bit != children.end())
3586                         continue;
3587                 children.push_back(child);
3588                 if (grand_children)
3589                         // there might be grandchildren
3590                         child->collectChildren(children, true);
3591         }
3592 }
3593
3594
3595 ListOfBuffers Buffer::getChildren() const
3596 {
3597         ListOfBuffers v;
3598         collectChildren(v, false);
3599         // Make sure we have not included ourselves.
3600         ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3601         if (bit != v.end()) {
3602                 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3603                 v.erase(bit);
3604         }
3605         return v;
3606 }
3607
3608
3609 ListOfBuffers Buffer::getDescendants() const
3610 {
3611         ListOfBuffers v;
3612         collectChildren(v, true);
3613         // Make sure we have not included ourselves.
3614         ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3615         if (bit != v.end()) {
3616                 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3617                 v.erase(bit);
3618         }
3619         return v;
3620 }
3621
3622
3623 template<typename M>
3624 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3625 {
3626         if (m.empty())
3627                 return m.end();
3628
3629         typename M::const_iterator it = m.lower_bound(x);
3630         if (it == m.begin())
3631                 return m.end();
3632
3633         --it;
3634         return it;
3635 }
3636
3637
3638 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3639                                          DocIterator const & pos) const
3640 {
3641         LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3642
3643         // if paragraphs have no macro context set, pos will be empty
3644         if (pos.empty())
3645                 return nullptr;
3646
3647         // we haven't found anything yet
3648         DocIterator bestPos = owner_->par_iterator_begin();
3649         MacroData const * bestData = nullptr;
3650
3651         // find macro definitions for name
3652         NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3653         if (nameIt != macros.end()) {
3654                 // find last definition in front of pos or at pos itself
3655                 PositionScopeMacroMap::const_iterator it
3656                         = greatest_below(nameIt->second, pos);
3657                 if (it != nameIt->second.end()) {
3658                         while (true) {
3659                                 // scope ends behind pos?
3660                                 if (pos < it->second.scope) {
3661                                         // Looks good, remember this. If there
3662                                         // is no external macro behind this,
3663                                         // we found the right one already.
3664                                         bestPos = it->first;
3665                                         bestData = &it->second.macro;
3666                                         break;
3667                                 }
3668
3669                                 // try previous macro if there is one
3670                                 if (it == nameIt->second.begin())
3671                                         break;
3672                                 --it;
3673                         }
3674                 }
3675         }
3676
3677         // find macros in included files
3678         PositionScopeBufferMap::const_iterator it
3679                 = greatest_below(position_to_children, pos);
3680         if (it == position_to_children.end())
3681                 // no children before
3682                 return bestData;
3683
3684         while (true) {
3685                 // do we know something better (i.e. later) already?
3686                 if (it->first < bestPos )
3687                         break;
3688
3689                 // scope ends behind pos?
3690                 if (pos < it->second.scope
3691                         && (cloned_buffer_ ||
3692                             theBufferList().isLoaded(it->second.buffer))) {
3693                         // look for macro in external file
3694                         macro_lock = true;
3695                         MacroData const * data
3696                                 = it->second.buffer->getMacro(name, false);
3697                         macro_lock = false;
3698                         if (data) {
3699                                 bestPos = it->first;
3700                                 bestData = data;
3701                                 break;
3702                         }
3703                 }
3704
3705                 // try previous file if there is one
3706                 if (it == position_to_children.begin())
3707                         break;
3708                 --it;
3709         }
3710
3711         // return the best macro we have found
3712         return bestData;
3713 }
3714
3715
3716 MacroData const * Buffer::getMacro(docstring const & name,
3717         DocIterator const & pos, bool global) const
3718 {
3719         if (d->macro_lock)
3720                 return nullptr;
3721
3722         // query buffer macros
3723         MacroData const * data = d->getBufferMacro(name, pos);
3724         if (data != nullptr)
3725                 return data;
3726
3727         // If there is a master buffer, query that
3728         Buffer const * const pbuf = d->parent();
3729         if (pbuf) {
3730                 d->macro_lock = true;
3731                 MacroData const * macro = pbuf->getMacro(
3732                         name, *this, false);
3733                 d->macro_lock = false;
3734                 if (macro)
3735                         return macro;
3736         }
3737
3738         if (global) {
3739                 data = MacroTable::globalMacros().get(name);
3740                 if (data != nullptr)
3741                         return data;
3742         }
3743
3744         return nullptr;
3745 }
3746
3747
3748 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3749 {
3750         // set scope end behind the last paragraph
3751         DocIterator scope = par_iterator_begin();
3752         scope.pit() = scope.lastpit() + 1;
3753
3754         return getMacro(name, scope, global);
3755 }
3756
3757
3758 MacroData const * Buffer::getMacro(docstring const & name,
3759         Buffer const & child, bool global) const
3760 {
3761         // look where the child buffer is included first
3762         Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3763         if (it == d->children_positions.end())
3764                 return nullptr;
3765
3766         // check for macros at the inclusion position
3767         return getMacro(name, it->second, global);
3768 }
3769
3770
3771 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3772 {
3773         pit_type const lastpit = it.lastpit();
3774
3775         // look for macros in each paragraph
3776         while (it.pit() <= lastpit) {
3777                 Paragraph & par = it.paragraph();
3778
3779                 // iterate over the insets of the current paragraph
3780                 for (auto const & insit : par.insetList()) {
3781                         it.pos() = insit.pos;
3782
3783                         // is it a nested text inset?
3784                         if (insit.inset->asInsetText()) {
3785                                 // Inset needs its own scope?
3786                                 InsetText const * itext = insit.inset->asInsetText();
3787                                 bool newScope = itext->isMacroScope();
3788
3789                                 // scope which ends just behind the inset
3790                                 DocIterator insetScope = it;
3791                                 ++insetScope.pos();
3792
3793                                 // collect macros in inset
3794                                 it.push_back(CursorSlice(*insit.inset));
3795                                 updateMacros(it, newScope ? insetScope : scope);
3796                                 it.pop_back();
3797                                 continue;
3798                         }
3799
3800                         if (insit.inset->asInsetTabular()) {
3801                                 CursorSlice slice(*insit.inset);
3802                                 size_t const numcells = slice.nargs();
3803                                 for (; slice.idx() < numcells; slice.forwardIdx()) {
3804                                         it.push_back(slice);
3805                                         updateMacros(it, scope);
3806                                         it.pop_back();
3807                                 }
3808                                 continue;
3809                         }
3810
3811                         // is it an external file?
3812                         if (insit.inset->lyxCode() == INCLUDE_CODE) {
3813                                 // get buffer of external file
3814                                 InsetInclude const & incinset =
3815                                         static_cast<InsetInclude const &>(*insit.inset);
3816                                 macro_lock = true;
3817                                 Buffer * child = incinset.loadIfNeeded();
3818                                 macro_lock = false;
3819                                 if (!child)
3820                                         continue;
3821
3822                                 // register its position, but only when it is
3823                                 // included first in the buffer
3824                                 children_positions.insert({child, it});
3825
3826                                 // register child with its scope
3827                                 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3828                                 continue;
3829                         }
3830
3831                         InsetMath * im = insit.inset->asInsetMath();
3832                         if (doing_export && im)  {
3833                                 InsetMathHull * hull = im->asHullInset();
3834                                 if (hull)
3835                                         hull->recordLocation(it);
3836                         }
3837
3838                         if (insit.inset->lyxCode() != MATHMACRO_CODE)
3839                                 continue;
3840
3841                         // get macro data
3842                         InsetMathMacroTemplate & macroTemplate =
3843                                 *insit.inset->asInsetMath()->asMacroTemplate();
3844                         MacroContext mc(owner_, it);
3845                         macroTemplate.updateToContext(mc);
3846
3847                         // valid?
3848                         bool valid = macroTemplate.validMacro();
3849                         // FIXME: Should be fixNameAndCheckIfValid() in fact,
3850                         // then the BufferView's cursor will be invalid in
3851                         // some cases which leads to crashes.
3852                         if (!valid)
3853                                 continue;
3854
3855                         // register macro
3856                         // FIXME (Abdel), I don't understand why we pass 'it' here
3857                         // instead of 'macroTemplate' defined above... is this correct?
3858                         macros[macroTemplate.name()][it] =
3859                                 Impl::ScopeMacro(scope, MacroData(owner_, it));
3860                 }
3861
3862                 // next paragraph
3863                 it.pit()++;
3864                 it.pos() = 0;
3865         }
3866 }
3867
3868
3869 void Buffer::updateMacros() const
3870 {
3871         if (d->macro_lock)
3872                 return;
3873
3874         LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3875
3876         // start with empty table
3877         d->macros.clear();
3878         d->children_positions.clear();
3879         d->position_to_children.clear();
3880
3881         // Iterate over buffer, starting with first paragraph
3882         // The scope must be bigger than any lookup DocIterator
3883         // later. For the global lookup, lastpit+1 is used, hence
3884         // we use lastpit+2 here.
3885         DocIterator it = par_iterator_begin();
3886         DocIterator outerScope = it;
3887         outerScope.pit() = outerScope.lastpit() + 2;
3888         d->updateMacros(it, outerScope);
3889 }
3890
3891
3892 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3893 {
3894         for (Inset const & it : inset()) {
3895                 if (it.lyxCode() == BRANCH_CODE) {
3896                         InsetBranch const & br = static_cast<InsetBranch const &>(it);
3897                         docstring const name = br.branch();
3898                         if (!from_master && !params().branchlist().find(name))
3899                                 result.push_back(name);
3900                         else if (from_master && !masterBuffer()->params().branchlist().find(name))
3901                                 result.push_back(name);
3902                         continue;
3903                 }
3904                 if (it.lyxCode() == INCLUDE_CODE) {
3905                         // get buffer of external file
3906                         InsetInclude const & ins =
3907                                 static_cast<InsetInclude const &>(it);
3908                         Buffer * child = ins.loadIfNeeded();
3909                         if (!child)
3910                                 continue;
3911                         child->getUsedBranches(result, true);
3912                 }
3913         }
3914         // remove duplicates
3915         result.unique();
3916 }
3917
3918
3919 void Buffer::updateMacroInstances(UpdateType utype) const
3920 {
3921         LYXERR(Debug::MACROS, "updateMacroInstances for "
3922                 << d->filename.onlyFileName());
3923         DocIterator it = doc_iterator_begin(this);
3924         it.forwardInset();
3925         DocIterator const end = doc_iterator_end(this);
3926         for (; it != end; it.forwardInset()) {
3927                 // look for MathData cells in InsetMathNest insets
3928                 InsetMath * minset = it.nextInset()->asInsetMath();
3929                 if (!minset)
3930                         continue;
3931
3932                 // update macro in all cells of the InsetMathNest
3933                 idx_type n = minset->nargs();
3934                 MacroContext mc = MacroContext(this, it);
3935                 for (idx_type i = 0; i < n; ++i) {
3936                         MathData & data = minset->cell(i);
3937                         data.updateMacros(nullptr, mc, utype, 0);
3938                 }
3939         }
3940 }
3941
3942
3943 void Buffer::listMacroNames(MacroNameSet & macros) const
3944 {
3945         if (d->macro_lock)
3946                 return;
3947
3948         d->macro_lock = true;
3949
3950         // loop over macro names
3951         for (auto const & nameit : d->macros)
3952                 macros.insert(nameit.first);
3953
3954         // loop over children
3955         for (auto const & p : d->children_positions) {
3956                 Buffer * child = const_cast<Buffer *>(p.first);
3957                 // The buffer might have been closed (see #10766).
3958                 if (theBufferList().isLoaded(child))
3959                         child->listMacroNames(macros);
3960         }
3961
3962         // call parent
3963         Buffer const * const pbuf = d->parent();
3964         if (pbuf)
3965                 pbuf->listMacroNames(macros);
3966
3967         d->macro_lock = false;
3968 }
3969
3970
3971 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3972 {
3973         Buffer const * const pbuf = d->parent();
3974         if (!pbuf)
3975                 return;
3976
3977         MacroNameSet names;
3978         pbuf->listMacroNames(names);
3979
3980         // resolve macros
3981         for (auto const & mit : names) {
3982                 // defined?
3983                 MacroData const * data = pbuf->getMacro(mit, *this, false);
3984                 if (data) {
3985                         macros.insert(data);
3986
3987                         // we cannot access the original InsetMathMacroTemplate anymore
3988                         // here to calls validate method. So we do its work here manually.
3989                         // FIXME: somehow make the template accessible here.
3990                         if (data->optionals() > 0)
3991                                 features.require("xargs");
3992                 }
3993         }
3994 }
3995
3996
3997 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3998 {
3999         if (d->parent())
4000                 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
4001
4002         RefCache::iterator it = d->ref_cache_.find(label);
4003         if (it != d->ref_cache_.end())
4004                 return it->second;
4005
4006         static References const dummy_refs = References();
4007         it = d->ref_cache_.insert(
4008                 make_pair(label, dummy_refs)).first;
4009         return it->second;
4010 }
4011
4012
4013 Buffer::References const & Buffer::references(docstring const & label) const
4014 {
4015         return const_cast<Buffer *>(this)->getReferenceCache(label);
4016 }
4017
4018
4019 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
4020 {
4021         References & refs = getReferenceCache(label);
4022         refs.push_back(make_pair(inset, it));
4023 }
4024
4025
4026 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il,
4027                            bool const active)
4028 {
4029         LabelInfo linfo;
4030         linfo.label = label;
4031         linfo.inset = il;
4032         linfo.active = active;
4033         masterBuffer()->d->label_cache_.push_back(linfo);
4034 }
4035
4036
4037 InsetLabel const * Buffer::insetLabel(docstring const & label,
4038                                       bool const active) const
4039 {
4040         for (auto const & rc : masterBuffer()->d->label_cache_) {
4041                 if (rc.label == label && (rc.active || !active))
4042                         return rc.inset;
4043         }
4044         return nullptr;
4045 }
4046
4047
4048 bool Buffer::activeLabel(docstring const & label) const
4049 {
4050         return insetLabel(label, true) != nullptr;
4051 }
4052
4053
4054 void Buffer::clearReferenceCache() const
4055 {
4056         if (!d->parent()) {
4057                 d->ref_cache_.clear();
4058                 d->label_cache_.clear();
4059         }
4060 }
4061
4062
4063 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
4064 {
4065         //FIXME: This does not work for child documents yet.
4066         reloadBibInfoCache();
4067
4068         // Check if the label 'from' appears more than once
4069         vector<docstring> labels;
4070         for (auto const & bibit : masterBibInfo())
4071                 labels.push_back(bibit.first);
4072
4073         if (count(labels.begin(), labels.end(), from) > 1)
4074                 return;
4075
4076         string const paramName = "key";
4077         UndoGroupHelper ugh(this);
4078         InsetIterator it = begin(inset());
4079         for (; it; ++it) {
4080                 if (it->lyxCode() != CITE_CODE)
4081                         continue;
4082                 InsetCommand * inset = it->asInsetCommand();
4083                 docstring const oldValue = inset->getParam(paramName);
4084                 if (oldValue == from) {
4085                         undo().recordUndo(CursorData(it));
4086                         inset->setParam(paramName, to);
4087                 }
4088         }
4089 }
4090
4091 // returns NULL if id-to-row conversion is unsupported
4092 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
4093                                          pit_type par_begin, pit_type par_end,
4094                                          OutputWhat output, bool master) const
4095 {
4096         unique_ptr<TexRow> texrow;
4097         OutputParams runparams(&params().encoding());
4098         runparams.nice = true;
4099         runparams.flavor = params().getOutputFlavor(format);
4100         runparams.linelen = lyxrc.plaintext_linelen;
4101         // No side effect of file copying and image conversion
4102         runparams.dryrun = true;
4103
4104         // Some macros rely on font encoding
4105         runparams.main_fontenc = params().main_font_encoding();
4106
4107         // Use the right wrapping for the comment at the beginning of the generated
4108         // snippet, so that it is either valid LaTeX or valid XML (including HTML and DocBook).
4109         docstring comment_start = from_ascii("% ");
4110         docstring comment_end = from_ascii("");
4111         if (runparams.flavor == Flavor::Html || runparams.flavor == Flavor::DocBook5) {
4112                 comment_start = from_ascii("<!-- ");
4113                 comment_end = from_ascii(" -->");
4114         }
4115
4116         if (output == CurrentParagraph) {
4117                 runparams.par_begin = par_begin;
4118                 runparams.par_end = par_end;
4119                 if (par_begin + 1 == par_end) {
4120                         os << comment_start
4121                            << bformat(_("Preview source code for paragraph %1$d"), par_begin)
4122                            << comment_end
4123                            << "\n\n";
4124                 } else {
4125                         os << comment_start
4126                            << bformat(_("Preview source code from paragraph %1$s to %2$s"),
4127                                         convert<docstring>(par_begin),
4128                                         convert<docstring>(par_end - 1))
4129                            << comment_end
4130                            << "\n\n";
4131                 }
4132                 // output paragraphs
4133                 if (runparams.flavor == Flavor::LyX) {
4134                         Paragraph const & par = text().paragraphs()[par_begin];
4135                         ostringstream ods;
4136                         depth_type dt = par.getDepth();
4137                         par.write(ods, params(), dt);
4138                         os << from_utf8(ods.str());
4139                 } else if (runparams.flavor == Flavor::Html) {
4140                         XMLStream xs(os);
4141                         setMathFlavor(runparams);
4142                         xhtmlParagraphs(text(), *this, xs, runparams);
4143                 } else if (runparams.flavor == Flavor::Text) {
4144                         bool dummy = false;
4145                         // FIXME Handles only one paragraph, unlike the others.
4146                         // Probably should have some routine with a signature like them.
4147                         writePlaintextParagraph(*this,
4148                                 text().paragraphs()[par_begin], os, runparams, dummy);
4149                 } else if (runparams.flavor == Flavor::DocBook5) {
4150                         XMLStream xs{os};
4151                         docbookParagraphs(text(), *this, xs, runparams);
4152                 } else {
4153                         // If we are previewing a paragraph, even if this is the
4154                         // child of some other buffer, let's cut the link here,
4155                         // so that no concurring settings from the master
4156                         // (e.g. branch state) interfere (see #8101).
4157                         if (!master)
4158                                 d->ignore_parent = true;
4159                         // We need to validate the Buffer params' features here
4160                         // in order to know if we should output polyglossia
4161                         // macros (instead of babel macros)
4162                         LaTeXFeatures features(*this, params(), runparams);
4163                         validate(features);
4164                         runparams.use_polyglossia = features.usePolyglossia();
4165                         runparams.use_babel = features.useBabel();
4166                         runparams.use_hyperref = features.isRequired("hyperref");
4167                         // latex or literate
4168                         otexstream ots(os);
4169                         // output above
4170                         ots.texrow().newlines(2);
4171                         // the real stuff
4172                         latexParagraphs(*this, text(), ots, runparams);
4173                         texrow = ots.releaseTexRow();
4174
4175                         // Restore the parenthood
4176                         if (!master)
4177                                 d->ignore_parent = false;
4178                 }
4179         } else {
4180                 os << comment_start;
4181                 if (output == FullSource)
4182                         os << _("Preview source code");
4183                 else if (output == OnlyPreamble)
4184                         os << _("Preview preamble");
4185                 else if (output == OnlyBody)
4186                         os << _("Preview body");
4187                 os << comment_end;
4188                 os << "\n\n";
4189                 if (runparams.flavor == Flavor::LyX) {
4190                         ostringstream ods;
4191                         if (output == FullSource)
4192                                 write(ods);
4193                         else if (output == OnlyPreamble)
4194                                 params().writeFile(ods, this);
4195                         else if (output == OnlyBody)
4196                                 text().write(ods);
4197                         os << from_utf8(ods.str());
4198                 } else if (runparams.flavor == Flavor::Html) {
4199                         writeLyXHTMLSource(os, runparams, output);
4200                 } else if (runparams.flavor == Flavor::Text) {
4201                         if (output == OnlyPreamble)
4202                                 os << "% "<< _("Plain text does not have a preamble.");
4203                         else
4204                                 writePlaintextFile(*this, os, runparams);
4205                 } else if (runparams.flavor == Flavor::DocBook5) {
4206                         writeDocBookSource(os, runparams, output);
4207                 } else {
4208                         // latex or literate
4209                         otexstream ots(os);
4210                         // output above
4211                         ots.texrow().newlines(2);
4212                         if (master)
4213                                 runparams.is_child = true;
4214                         updateBuffer();
4215                         writeLaTeXSource(ots, string(), runparams, output);
4216                         texrow = ots.releaseTexRow();
4217                 }
4218         }
4219         return texrow;
4220 }
4221
4222
4223 ErrorList & Buffer::errorList(string const & type) const
4224 {
4225         return d->errorLists[type];
4226 }
4227
4228
4229 void Buffer::updateTocItem(std::string const & type,
4230         DocIterator const & dit) const
4231 {
4232         if (d->gui_)
4233                 d->gui_->updateTocItem(type, dit);
4234 }
4235
4236
4237 void Buffer::structureChanged() const
4238 {
4239         if (d->gui_)
4240                 d->gui_->structureChanged();
4241 }
4242
4243
4244 void Buffer::errors(string const & err, bool from_master) const
4245 {
4246         if (d->gui_)
4247                 d->gui_->errors(err, from_master);
4248 }
4249
4250
4251 void Buffer::message(docstring const & msg) const
4252 {
4253         if (d->gui_)
4254                 d->gui_->message(msg);
4255 }
4256
4257
4258 void Buffer::setBusy(bool on) const
4259 {
4260         if (d->gui_)
4261                 d->gui_->setBusy(on);
4262 }
4263
4264
4265 void Buffer::updateTitles() const
4266 {
4267         if (d->wa_)
4268                 d->wa_->updateTitles();
4269 }
4270
4271
4272 void Buffer::scheduleRedrawWorkAreas() const
4273 {
4274         if (d->wa_)
4275                 d->wa_->scheduleRedraw();
4276 }
4277
4278
4279 void Buffer::resetAutosaveTimers() const
4280 {
4281         if (d->gui_)
4282                 d->gui_->resetAutosaveTimers();
4283 }
4284
4285
4286 bool Buffer::hasGuiDelegate() const
4287 {
4288         return d->gui_;
4289 }
4290
4291
4292 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
4293 {
4294         d->gui_ = gui;
4295 }
4296
4297
4298 FileName Buffer::getEmergencyFileName() const
4299 {
4300         return FileName(d->filename.absFileName() + ".emergency");
4301 }
4302
4303
4304 FileName Buffer::getAutosaveFileName() const
4305 {
4306         // if the document is unnamed try to save in the backup dir, else
4307         // in the default document path, and as a last try in the filePath,
4308         // which will most often be the temporary directory
4309         string fpath;
4310         if (isUnnamed())
4311                 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
4312                         : lyxrc.backupdir_path;
4313         if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
4314                 fpath = filePath();
4315
4316         string const fname = "#" + d->filename.onlyFileName() + "#";
4317
4318         return makeAbsPath(fname, fpath);
4319 }
4320
4321
4322 void Buffer::removeAutosaveFile() const
4323 {
4324         FileName const f = getAutosaveFileName();
4325         if (f.exists())
4326                 f.removeFile();
4327 }
4328
4329
4330 void Buffer::moveAutosaveFile(FileName const & oldauto) const
4331 {
4332         FileName const newauto = getAutosaveFileName();
4333         oldauto.refresh();
4334         if (newauto != oldauto && oldauto.exists())
4335                 if (!oldauto.moveTo(newauto))
4336                         LYXERR0("Unable to move autosave file `" << oldauto << "'!");
4337 }
4338
4339
4340 bool Buffer::autoSave() const
4341 {
4342         Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
4343         if (buf->d->bak_clean || hasReadonlyFlag())
4344                 return true;
4345
4346         message(_("Autosaving current document..."));
4347         buf->d->bak_clean = true;
4348
4349         FileName const fname = getAutosaveFileName();
4350         LASSERT(d->cloned_buffer_, return false);
4351
4352         // If this buffer is cloned, we assume that
4353         // we are running in a separate thread already.
4354         TempFile tempfile("lyxautoXXXXXX.lyx");
4355         tempfile.setAutoRemove(false);
4356         FileName const tmp_ret = tempfile.name();
4357         if (!tmp_ret.empty()) {
4358                 writeFile(tmp_ret);
4359                 // assume successful write of tmp_ret
4360                 if (tmp_ret.moveTo(fname))
4361                         return true;
4362         }
4363         // failed to write/rename tmp_ret so try writing direct
4364         return writeFile(fname);
4365 }
4366
4367
4368 void Buffer::setExportStatus(bool e) const
4369 {
4370         d->doing_export = e;
4371         ListOfBuffers clist = getDescendants();
4372         for (auto const & bit : clist)
4373                 bit->d->doing_export = e;
4374 }
4375
4376
4377 bool Buffer::isExporting() const
4378 {
4379         return d->doing_export;
4380 }
4381
4382
4383 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4384         const
4385 {
4386         string result_file;
4387         return doExport(target, put_in_tempdir, result_file);
4388 }
4389
4390 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4391         string & result_file) const
4392 {
4393         bool const update_unincluded =
4394                         params().maintain_unincluded_children != BufferParams::CM_None
4395                         && !params().getIncludedChildren().empty();
4396
4397         // (1) export with all included children (omit \includeonly)
4398         if (update_unincluded) {
4399                 ExportStatus const status =
4400                         doExport(target, put_in_tempdir, true, result_file);
4401                 if (status != ExportSuccess)
4402                         return status;
4403         }
4404         // (2) export with included children only
4405         return doExport(target, put_in_tempdir, false, result_file);
4406 }
4407
4408
4409 void Buffer::setMathFlavor(OutputParams & op) const
4410 {
4411         // Passes the way to generate formulae to the XHTML output code.
4412         // In particular, this function has no impact on the DocBook code, as it
4413         // uses another mechanism to handle math flavours.
4414         switch (params().html_math_output) {
4415         case BufferParams::MathML:
4416                 op.math_flavor = OutputParams::MathAsMathML;
4417                 break;
4418         case BufferParams::HTML:
4419                 op.math_flavor = OutputParams::MathAsHTML;
4420                 break;
4421         case BufferParams::Images:
4422                 op.math_flavor = OutputParams::MathAsImages;
4423                 break;
4424         case BufferParams::LaTeX:
4425                 op.math_flavor = OutputParams::MathAsLaTeX;
4426                 break;
4427         }
4428 }
4429
4430
4431 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4432         bool includeall, string & result_file) const
4433 {
4434         LYXERR(Debug::FILES, "target=" << target);
4435         OutputParams runparams(&params().encoding());
4436         string format = target;
4437         string dest_filename;
4438         size_t pos = target.find(' ');
4439         if (pos != string::npos) {
4440                 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4441                 format = target.substr(0, pos);
4442                 if (format == "default")
4443                         format = params().getDefaultOutputFormat();
4444                 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4445                 FileName(dest_filename).onlyPath().createPath();
4446                 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4447         }
4448         MarkAsExporting exporting(this);
4449         string backend_format;
4450         runparams.flavor = Flavor::LaTeX;
4451         runparams.linelen = lyxrc.plaintext_linelen;
4452         runparams.includeall = includeall;
4453         vector<string> backs = params().backends();
4454         Converters converters = theConverters();
4455         bool need_nice_file = false;
4456         if (find(backs.begin(), backs.end(), format) == backs.end()) {
4457                 // Get the shortest path to format
4458                 converters.buildGraph();
4459                 Graph::EdgePath path;
4460                 for (string const & sit : backs) {
4461                         Graph::EdgePath p = converters.getPath(sit, format);
4462                         if (!p.empty() && (path.empty() || p.size() < path.size())) {
4463                                 backend_format = sit;
4464                                 path = p;
4465                         }
4466                 }
4467                 if (path.empty()) {
4468                         if (!put_in_tempdir) {
4469                                 // Only show this alert if this is an export to a non-temporary
4470                                 // file (not for previewing).
4471                                 docstring s = bformat(_("No information for exporting the format %1$s."),
4472                                                       translateIfPossible(theFormats().prettyName(format)));
4473                                 if (format == "pdf4")
4474                                         s += "\n"
4475                                           + bformat(_("Hint: use non-TeX fonts or set input encoding"
4476                                                   " to '%1$s'"), from_utf8(encodings.fromLyXName("ascii")->guiName()));
4477                                 Alert::error(_("Couldn't export file"), s);
4478                         }
4479                         return ExportNoPathToFormat;
4480                 }
4481                 runparams.flavor = converters.getFlavor(path, this);
4482                 runparams.hyperref_driver = converters.getHyperrefDriver(path);
4483                 for (auto const & edge : path)
4484                         if (theConverters().get(edge).nice()) {
4485                                 need_nice_file = true;
4486                                 break;
4487                         }
4488
4489         } else {
4490                 backend_format = format;
4491                 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4492                 // FIXME: Don't hardcode format names here, but use a flag
4493                 if (backend_format == "pdflatex")
4494                         runparams.flavor = Flavor::PdfLaTeX;
4495                 else if (backend_format == "luatex")
4496                         runparams.flavor = Flavor::LuaTeX;
4497                 else if (backend_format == "dviluatex")
4498                         runparams.flavor = Flavor::DviLuaTeX;
4499                 else if (backend_format == "xetex")
4500                         runparams.flavor = Flavor::XeTeX;
4501         }
4502
4503         string filename = latexName(false);
4504         filename = addName(temppath(), filename);
4505         filename = changeExtension(filename,
4506                                    theFormats().extension(backend_format));
4507         LYXERR(Debug::FILES, "filename=" << filename);
4508
4509         // Plain text backend
4510         if (backend_format == "text") {
4511                 runparams.flavor = Flavor::Text;
4512                 try {
4513                         writePlaintextFile(*this, FileName(filename), runparams);
4514                 }
4515                 catch (ConversionException const &) { return ExportCancel; }
4516         }
4517         // HTML backend
4518         else if (backend_format == "xhtml") {
4519                 runparams.flavor = Flavor::Html;
4520                 setMathFlavor(runparams);
4521                 if (makeLyXHTMLFile(FileName(filename), runparams) == ExportKilled)
4522                         return ExportKilled;
4523         } else if (backend_format == "lyx")
4524                 writeFile(FileName(filename));
4525         // DocBook backend
4526         else if (backend_format == "docbook5") {
4527                 runparams.flavor = Flavor::DocBook5;
4528                 runparams.nice = false;
4529                 if (makeDocBookFile(FileName(filename), runparams) == ExportKilled)
4530                         return ExportKilled;
4531         }
4532         // LaTeX backend
4533         else if (backend_format == format || need_nice_file) {
4534                 runparams.nice = true;
4535                 ExportStatus const retval =
4536                         makeLaTeXFile(FileName(filename), string(), runparams);
4537                 if (retval == ExportKilled)
4538                         return ExportKilled;
4539                 if (d->cloned_buffer_)
4540                         d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4541                 if (retval != ExportSuccess)
4542                         return retval;
4543         } else if (!lyxrc.tex_allows_spaces
4544                    && contains(filePath(), ' ')) {
4545                 Alert::error(_("File name error"),
4546                         bformat(_("The directory path to the document\n%1$s\n"
4547                             "contains spaces, but your TeX installation does "
4548                             "not allow them. You should save the file to a directory "
4549                                         "whose name does not contain spaces."), from_utf8(filePath())));
4550                 return ExportTexPathHasSpaces;
4551         } else {
4552                 runparams.nice = false;
4553                 ExportStatus const retval =
4554                         makeLaTeXFile(FileName(filename), filePath(), runparams);
4555                 if (retval == ExportKilled)
4556                         return ExportKilled;
4557                 if (d->cloned_buffer_)
4558                         d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4559                 if (retval != ExportSuccess)
4560                         return ExportError;
4561         }
4562
4563         string const error_type = (format == "program")
4564                 ? "Build" : params().bufferFormat();
4565         ErrorList & error_list = d->errorLists[error_type];
4566         string const ext = theFormats().extension(format);
4567         FileName const tmp_result_file(changeExtension(filename, ext));
4568         Converters::RetVal const retval =
4569                 converters.convert(this, FileName(filename), tmp_result_file,
4570                                    FileName(absFileName()), backend_format, format,
4571                                    error_list, Converters::none, includeall);
4572         if (retval == Converters::KILLED)
4573                 return ExportCancel;
4574         bool success = (retval == Converters::SUCCESS);
4575
4576         // Emit the signal to show the error list or copy it back to the
4577         // cloned Buffer so that it can be emitted afterwards.
4578         if (format != backend_format) {
4579                 if (runparams.silent)
4580                         error_list.clear();
4581                 else if (d->cloned_buffer_)
4582                         d->cloned_buffer_->d->errorLists[error_type] =
4583                                 d->errorLists[error_type];
4584                 else
4585                         errors(error_type);
4586                 // also to the children, in case of master-buffer-view
4587                 ListOfBuffers clist = getDescendants();
4588                 for (auto const & bit : clist) {
4589                         if (runparams.silent)
4590                                 bit->d->errorLists[error_type].clear();
4591                         else if (d->cloned_buffer_) {
4592                                 // Enable reverse search by copying back the
4593                                 // texrow object to the cloned buffer.
4594                                 // FIXME: this is not thread safe.
4595                                 bit->d->cloned_buffer_->d->texrow = bit->d->texrow;
4596                                 bit->d->cloned_buffer_->d->errorLists[error_type] =
4597                                         bit->d->errorLists[error_type];
4598                         } else
4599                                 bit->errors(error_type, true);
4600                 }
4601         }
4602
4603         if (d->cloned_buffer_) {
4604                 // Enable reverse dvi or pdf to work by copying back the texrow
4605                 // object to the cloned buffer.
4606                 // FIXME: There is a possibility of concurrent access to texrow
4607                 // here from the main GUI thread that should be securized.
4608                 d->cloned_buffer_->d->texrow = d->texrow;
4609                 string const err_type = params().bufferFormat();
4610                 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[err_type];
4611         }
4612
4613
4614         if (put_in_tempdir) {
4615                 result_file = tmp_result_file.absFileName();
4616                 return success ? ExportSuccess : ExportConverterError;
4617         }
4618
4619         if (dest_filename.empty())
4620                 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4621         else
4622                 result_file = dest_filename;
4623         // We need to copy referenced files (e.g. included graphics
4624         // if format == "dvi") to the result dir.
4625         vector<ExportedFile> const extfiles =
4626                 runparams.exportdata->externalFiles(format);
4627         string const dest = runparams.export_folder.empty() ?
4628                 onlyPath(result_file) : runparams.export_folder;
4629         bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4630                                  : force_overwrite == ALL_FILES;
4631         CopyStatus status = use_force ? FORCE : SUCCESS;
4632
4633         for (ExportedFile const & exp : extfiles) {
4634                 if (status == CANCEL) {
4635                         message(_("Document export cancelled."));
4636                         return ExportCancel;
4637                 }
4638                 string const fmt = theFormats().getFormatFromFile(exp.sourceName);
4639                 string fixedName = exp.exportName;
4640                 if (!runparams.export_folder.empty()) {
4641                         // Relative pathnames starting with ../ will be sanitized
4642                         // if exporting to a different folder
4643                         while (fixedName.substr(0, 3) == "../")
4644                                 fixedName = fixedName.substr(3, fixedName.length() - 3);
4645                 }
4646                 FileName fixedFileName = makeAbsPath(fixedName, dest);
4647                 fixedFileName.onlyPath().createPath();
4648                 status = copyFile(fmt, exp.sourceName,
4649                         fixedFileName,
4650                         exp.exportName, status == FORCE,
4651                         runparams.export_folder.empty());
4652         }
4653
4654
4655         if (tmp_result_file.exists()) {
4656                 // Finally copy the main file
4657                 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4658                                     : force_overwrite != NO_FILES;
4659                 if (status == SUCCESS && use_force)
4660                         status = FORCE;
4661                 status = copyFile(format, tmp_result_file,
4662                         FileName(result_file), result_file,
4663                         status == FORCE);
4664                 if (status == CANCEL) {
4665                         message(_("Document export cancelled."));
4666                         return ExportCancel;
4667                 } else {
4668                         message(bformat(_("Document exported as %1$s "
4669                                 "to file `%2$s'"),
4670                                 translateIfPossible(theFormats().prettyName(format)),
4671                                 makeDisplayPath(result_file)));
4672                 }
4673         } else {
4674                 // This must be a dummy converter like fax (bug 1888)
4675                 message(bformat(_("Document exported as %1$s"),
4676                         translateIfPossible(theFormats().prettyName(format))));
4677         }
4678
4679         return success ? ExportSuccess : ExportConverterError;
4680 }
4681
4682
4683 Buffer::ExportStatus Buffer::preview(string const & format) const
4684 {
4685         bool const update_unincluded =
4686                         params().maintain_unincluded_children != BufferParams::CM_None
4687                         && !params().getIncludedChildren().empty();
4688         return preview(format, update_unincluded);
4689 }
4690
4691
4692 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4693 {
4694         MarkAsExporting exporting(this);
4695         string result_file;
4696         // (1) export with all included children (omit \includeonly)
4697         if (includeall) {
4698                 ExportStatus const status = doExport(format, true, true, result_file);
4699                 if (status != ExportSuccess)
4700                         return status;
4701         }
4702         // (2) export with included children only
4703         ExportStatus const status = doExport(format, true, false, result_file);
4704         FileName const previewFile(result_file);
4705
4706         Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4707         theimpl->preview_file_ = previewFile;
4708         theimpl->preview_format_ = format;
4709         theimpl->require_fresh_start_ = (status != ExportSuccess);
4710
4711         if (status != ExportSuccess)
4712                 return status;
4713
4714         if (previewFile.exists())
4715                 return theFormats().view(*this, previewFile, format) ?
4716                         PreviewSuccess : PreviewError;
4717
4718         // Successful export but no output file?
4719         // Probably a bug in error detection.
4720         LATTEST(status != ExportSuccess);
4721         return status;
4722 }
4723
4724
4725 Buffer::ReadStatus Buffer::extractFromVC()
4726 {
4727         bool const found = LyXVC::file_not_found_hook(d->filename);
4728         if (!found)
4729                 return ReadFileNotFound;
4730         if (!d->filename.isReadableFile())
4731                 return ReadVCError;
4732         return ReadSuccess;
4733 }
4734
4735
4736 Buffer::ReadStatus Buffer::loadEmergency()
4737 {
4738         FileName const emergencyFile = getEmergencyFileName();
4739         if (!emergencyFile.exists()
4740                   || emergencyFile.lastModified() <= d->filename.lastModified())
4741                 return ReadFileNotFound;
4742
4743         docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4744         docstring const text = bformat(_("An emergency save of the document "
4745                 "%1$s exists.\n\nRecover emergency save?"), file);
4746
4747         int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4748                 0, 3, _("&Recover"), _("&Load Original"), _("&Only show difference"), _("&Cancel"));
4749
4750         switch (load_emerg)
4751         {
4752         case 0: {
4753                 docstring str;
4754                 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4755                 bool const success = (ret_llf == ReadSuccess);
4756                 if (success) {
4757                         if (hasReadonlyFlag()) {
4758                                 Alert::warning(_("File is read-only"),
4759                                         bformat(_("An emergency file is successfully loaded, "
4760                                         "but the original file %1$s is marked read-only. "
4761                                         "Please make sure to save the document as a different "
4762                                         "file."), from_utf8(d->filename.absFileName())));
4763                         }
4764                         markDirty();
4765                         lyxvc().file_found_hook(d->filename);
4766                         str = _("Document was successfully recovered.");
4767                 } else
4768                         str = _("Document was NOT successfully recovered.");
4769                 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4770                         makeDisplayPath(emergencyFile.absFileName()));
4771
4772                 int const del_emerg =
4773                         Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4774                                 _("&Remove"), _("&Keep"));
4775                 if (del_emerg == 0) {
4776                         emergencyFile.removeFile();
4777                         if (success)
4778                                 Alert::warning(_("Emergency file deleted"),
4779                                         _("Do not forget to save your file now!"), true);
4780                         }
4781                 return success ? ReadSuccess : ReadEmergencyFailure;
4782         }
4783         case 1: {
4784                 int const del_emerg =
4785                         Alert::prompt(_("Delete emergency file?"),
4786                                 _("Remove emergency file now?"), 1, 1,
4787                                 _("&Remove"), _("&Keep"));
4788                 if (del_emerg == 0)
4789                         emergencyFile.removeFile();
4790                 else {
4791                         // See bug #11464
4792                         FileName newname;
4793                         string const ename = emergencyFile.absFileName();
4794                         bool noname = true;
4795                         // Surely we can find one in 100 tries?
4796                         for (int i = 1; i < 100; ++i) {
4797                                 newname.set(ename + to_string(i) + ".lyx");
4798                                 if (!newname.exists()) {
4799                                         noname = false;
4800                                         break;
4801                                 }
4802                         }
4803                         if (!noname) {
4804                                 // renameTo returns true on success. So inverting that
4805                                 // will give us true if we fail.
4806                                 noname = !emergencyFile.renameTo(newname);
4807                         }
4808                         if (noname) {
4809                                 Alert::warning(_("Can't rename emergency file!"),
4810                                         _("LyX was unable to rename the emergency file. "
4811                                           "You should do so manually. Otherwise, you will be "
4812                                           "asked about it again the next time you try to load "
4813                                           "this file, and may over-write your own work."));
4814                         } else {
4815                                 Alert::warning(_("Emergency File Renamed"),
4816                                         bformat(_("Emergency file renamed as:\n %1$s"),
4817                                         from_utf8(newname.onlyFileName())));
4818                         }
4819                 }
4820                 return ReadOriginal;
4821         }
4822
4823         case 2: {
4824                 string const f1 = d->filename.absFileName();
4825                 string const f2 = emergencyFile.absFileName();
4826                 if (loadThisLyXFile(d->filename) != ReadSuccess)
4827                         return ReadCancel;
4828                 string const par = "compare run-blocking " + quoteName(f1) + " " + quoteName(f2);
4829                 LYXERR(Debug::FILES, par << "\n");
4830                 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, par));
4831
4832                 //release the emergency buffer loaded by compare
4833                 Buffer * emerBuffer = theBufferList().getBuffer(emergencyFile);
4834                 if (emerBuffer)
4835                         theBufferList().release(emerBuffer);
4836
4837                 return ReadCancel; //Release the buffer of Original immediatelly
4838         }
4839         default:
4840                 break;
4841         }
4842         return ReadCancel;
4843 }
4844
4845
4846 Buffer::ReadStatus Buffer::loadAutosave()
4847 {
4848         // Now check if autosave file is newer.
4849         FileName const autosaveFile = getAutosaveFileName();
4850         if (!autosaveFile.exists()
4851                   || autosaveFile.lastModified() <= d->filename.lastModified())
4852                 return ReadFileNotFound;
4853
4854         docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4855         docstring const text = bformat(_("The backup of the document %1$s "
4856                 "is newer.\n\nLoad the backup instead?"), file);
4857         int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4858                 _("&Load backup"), _("Load &original"), _("&Cancel"));
4859
4860         switch (ret)
4861         {
4862         case 0: {
4863                 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4864                 // the file is not saved if we load the autosave file.
4865                 if (ret_llf == ReadSuccess) {
4866                         if (hasReadonlyFlag()) {
4867                                 Alert::warning(_("File is read-only"),
4868                                         bformat(_("A backup file is successfully loaded, "
4869                                         "but the original file %1$s is marked read-only. "
4870                                         "Please make sure to save the document as a "
4871                                         "different file."),
4872                                         from_utf8(d->filename.absFileName())));
4873                         }
4874                         markDirty();
4875                         lyxvc().file_found_hook(d->filename);
4876                         return ReadSuccess;
4877                 }
4878                 return ReadAutosaveFailure;
4879         }
4880         case 1:
4881                 // Here we delete the autosave
4882                 autosaveFile.removeFile();
4883                 return ReadOriginal;
4884         default:
4885                 break;
4886         }
4887         return ReadCancel;
4888 }
4889
4890
4891 Buffer::ReadStatus Buffer::loadLyXFile()
4892 {
4893         if (!d->filename.isReadableFile()) {
4894                 ReadStatus const ret_rvc = extractFromVC();
4895                 if (ret_rvc != ReadSuccess)
4896                         return ret_rvc;
4897         }
4898
4899         ReadStatus const ret_re = loadEmergency();
4900         if (ret_re == ReadSuccess || ret_re == ReadCancel)
4901                 return ret_re;
4902
4903         ReadStatus const ret_ra = loadAutosave();
4904         if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4905                 return ret_ra;
4906
4907         return loadThisLyXFile(d->filename);
4908 }
4909
4910
4911 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4912 {
4913         return readFile(fn);
4914 }
4915
4916
4917 void Buffer::Impl::traverseErrors(TeXErrors::Errors::const_iterator err, TeXErrors::Errors::const_iterator end, ErrorList & errorList) const
4918 {
4919         for (; err != end; ++err) {
4920                 TexRow::TextEntry start = TexRow::text_none, end = TexRow::text_none;
4921                 int errorRow = err->error_in_line;
4922                 Buffer const * buf = nullptr;
4923                 Impl const * p = this;
4924                 if (err->child_name.empty())
4925                         tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4926                 else {
4927                         // The error occurred in a child
4928                         for (Buffer const * child : owner_->getDescendants()) {
4929                                 string const child_name =
4930                                         DocFileName(changeExtension(child->absFileName(), "tex")).
4931                                         mangledFileName();
4932                                 if (err->child_name != child_name)
4933                                         continue;
4934                                 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4935                                 if (!TexRow::isNone(start)) {
4936                                         buf = this->cloned_buffer_
4937                                                 ? child->d->cloned_buffer_->d->owner_
4938                                                 : child->d->owner_;
4939                                         p = child->d;
4940                                         break;
4941                                 }
4942                         }
4943                 }
4944                 errorList.push_back(ErrorItem(err->error_desc, err->error_text,
4945                                               start, end, buf));
4946         }
4947 }
4948
4949
4950 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4951 {
4952         TeXErrors::Errors::const_iterator err = terr.begin();
4953         TeXErrors::Errors::const_iterator end = terr.end();
4954
4955         d->traverseErrors(err, end, errorList);
4956 }
4957
4958
4959 void Buffer::bufferRefs(TeXErrors const & terr, ErrorList & errorList) const
4960 {
4961         TeXErrors::Errors::const_iterator err = terr.begin_ref();
4962         TeXErrors::Errors::const_iterator end = terr.end_ref();
4963
4964         d->traverseErrors(err, end, errorList);
4965 }
4966
4967
4968 void Buffer::updateBuffer() const
4969 {
4970         updateBuffer(UpdateMaster, InternalUpdate);
4971         d->need_update = false;
4972 }
4973
4974
4975 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4976 {
4977         LBUFERR(!text().paragraphs().empty());
4978
4979         // This can be called when loading a file, so that there be no
4980         // open undo group.
4981         UndoGroupHelper ugh(const_cast<Buffer *>(this));
4982
4983         // Use the master text class also for child documents
4984         Buffer const * const master = masterBuffer();
4985         DocumentClass const & textclass = master->params().documentClass();
4986
4987         docstring_list old_bibfiles;
4988         // Do this only if we are the top-level Buffer. We also need to account
4989         // for the case of a previewed child with ignored parent here.
4990         if (master == this && !d->ignore_parent) {
4991                 textclass.counters().reset(from_ascii("bibitem"));
4992                 reloadBibInfoCache();
4993                 // we will re-read this cache as we go through, but we need
4994                 // to know whether it's changed to know whether we need to
4995                 // update the bibinfo cache.
4996                 old_bibfiles = d->bibfiles_cache_;
4997                 d->bibfiles_cache_.clear();
4998         }
4999
5000         // keep the buffers to be children in this set. If the call from the
5001         // master comes back we can see which of them were actually seen (i.e.
5002         // via an InsetInclude). The remaining ones in the set need still be updated.
5003         static std::set<Buffer const *> bufToUpdate;
5004         if (scope == UpdateMaster) {
5005                 // If this is a child document start with the master
5006                 if (master != this) {
5007                         bufToUpdate.insert(this);
5008                         master->updateBuffer(UpdateMaster, utype);
5009                         // If the master buffer has no gui associated with it, then the TocModel is
5010                         // not updated during the updateBuffer call and TocModel::toc_ is invalid
5011                         // (bug 5699). The same happens if the master buffer is open in a different
5012                         // window. This test catches both possibilities.
5013                         // See: https://marc.info/?l=lyx-devel&m=138590578911716&w=2
5014                         // There remains a problem here: If there is another child open in yet a third
5015                         // window, that TOC is not updated. So some more general solution is needed at
5016                         // some point.
5017                         if (master->d->gui_ != d->gui_)
5018                                 structureChanged();
5019
5020                         // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
5021                         if (bufToUpdate.find(this) == bufToUpdate.end())
5022                                 return;
5023                 }
5024
5025                 // start over the counters in the master
5026                 textclass.counters().reset();
5027         }
5028
5029         // update will be done below for this buffer
5030         bufToUpdate.erase(this);
5031
5032         // update all caches
5033         clearReferenceCache();
5034         updateMacros();
5035
5036         Buffer & cbuf = const_cast<Buffer &>(*this);
5037         // if we are reloading, then we could have a dangling TOC,
5038         // in effect. so we need to go ahead and reset, even though
5039         // we will do so again when we rebuild the TOC later.
5040         cbuf.tocBackend().reset();
5041
5042         // do the real work
5043         ParIterator parit = cbuf.par_iterator_begin();
5044         if (scope == UpdateMaster)
5045                 clearIncludeList();
5046         updateBuffer(parit, utype);
5047
5048         // If this document has siblings, then update the TocBackend later. The
5049         // reason is to ensure that later siblings are up to date when e.g. the
5050         // broken or not status of references is computed. The update is called
5051         // in InsetInclude::addToToc.
5052         if (master != this)
5053                 return;
5054
5055         // if the bibfiles changed, the cache of bibinfo is invalid
5056         docstring_list new_bibfiles = d->bibfiles_cache_;
5057         // this is a trick to determine whether the two vectors have
5058         // the same elements.
5059         sort(new_bibfiles.begin(), new_bibfiles.end());
5060         sort(old_bibfiles.begin(), old_bibfiles.end());
5061         if (old_bibfiles != new_bibfiles) {
5062                 LYXERR(Debug::FILES, "Reloading bibinfo cache.");
5063                 invalidateBibinfoCache();
5064                 reloadBibInfoCache();
5065                 // We relied upon the bibinfo cache when recalculating labels. But that
5066                 // cache was invalid, although we didn't find that out until now. So we
5067                 // have to do it all again.
5068                 // That said, the only thing we really need to do is update the citation
5069                 // labels. Nothing else will have changed. So we could create a new
5070                 // UpdateType that would signal that fact, if we needed to do so.
5071                 parit = cbuf.par_iterator_begin();
5072                 // we will be re-doing the counters and references and such.
5073                 textclass.counters().reset();
5074                 clearReferenceCache();
5075                 // we should not need to do this again?
5076                 // updateMacros();
5077                 updateBuffer(parit, utype);
5078                 // this will already have been done by reloadBibInfoCache();
5079                 // d->bibinfo_cache_valid_ = true;
5080         }
5081         else {
5082                 LYXERR(Debug::FILES, "Bibfiles unchanged.");
5083                 // this is also set to true on the other path, by reloadBibInfoCache.
5084                 d->bibinfo_cache_valid_ = true;
5085         }
5086         d->cite_labels_valid_ = true;
5087         /// FIXME: Perf
5088         clearIncludeList();
5089         cbuf.tocBackend().update(true, utype);
5090         if (scope == UpdateMaster)
5091                 cbuf.structureChanged();
5092
5093         d->need_update = false;
5094 }
5095
5096
5097 static depth_type getDepth(DocIterator const & it)
5098 {
5099         depth_type depth = 0;
5100         for (size_t i = 0 ; i < it.depth() ; ++i)
5101                 if (!it[i].inset().inMathed())
5102                         depth += it[i].paragraph().getDepth() + 1;
5103         // remove 1 since the outer inset does not count
5104         // we should have at least one non-math inset, so
5105         // depth should nevery be 0. but maybe it is worth
5106         // marking this, just in case.
5107         LATTEST(depth > 0);
5108         // coverity[INTEGER_OVERFLOW]
5109         return depth - 1;
5110 }
5111
5112 static depth_type getItemDepth(ParIterator const & it)
5113 {
5114         Paragraph const & par = *it;
5115         LabelType const labeltype = par.layout().labeltype;
5116
5117         if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
5118                 return 0;
5119
5120         // this will hold the lowest depth encountered up to now.
5121         depth_type min_depth = getDepth(it);
5122         ParIterator prev_it = it;
5123         while (true) {
5124                 if (prev_it.pit())
5125                         --prev_it.top().pit();
5126                 else {
5127                         // start of nested inset: go to outer par
5128                         prev_it.pop_back();
5129                         if (prev_it.empty()) {
5130                                 // start of document: nothing to do
5131                                 return 0;
5132                         }
5133                 }
5134
5135                 // We search for the first paragraph with same label
5136                 // that is not more deeply nested.
5137                 Paragraph & prev_par = *prev_it;
5138                 depth_type const prev_depth = getDepth(prev_it);
5139                 if (labeltype == prev_par.layout().labeltype) {
5140                         if (prev_depth < min_depth)
5141                                 return prev_par.itemdepth + 1;
5142                         if (prev_depth == min_depth)
5143                                 return prev_par.itemdepth;
5144                 }
5145                 min_depth = min(min_depth, prev_depth);
5146                 // small optimization: if we are at depth 0, we won't
5147                 // find anything else
5148                 if (prev_depth == 0)
5149                         return 0;
5150         }
5151 }
5152
5153
5154 static bool needEnumCounterReset(ParIterator const & it)
5155 {
5156         Paragraph const & par = *it;
5157         LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
5158         depth_type const cur_depth = par.getDepth();
5159         ParIterator prev_it = it;
5160         while (prev_it.pit()) {
5161                 --prev_it.top().pit();
5162                 Paragraph const & prev_par = *prev_it;
5163                 if (prev_par.getDepth() <= cur_depth)
5164                         return prev_par.layout().name() != par.layout().name();
5165         }
5166         // start of nested inset: reset
5167         return true;
5168 }
5169
5170
5171 // set the label of a paragraph. This includes the counters.
5172 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
5173 {
5174         BufferParams const & bp = owner_->masterBuffer()->params();
5175         DocumentClass const & textclass = bp.documentClass();
5176         Paragraph & par = it.paragraph();
5177         Layout const & layout = par.layout();
5178         Counters & counters = textclass.counters();
5179
5180         if (par.params().startOfAppendix()) {
5181                 // We want to reset the counter corresponding to toplevel sectioning
5182                 Layout const & lay = textclass.getTOCLayout();
5183                 docstring const cnt = lay.counter;
5184                 if (!cnt.empty())
5185                         counters.reset(cnt);
5186                 counters.appendix(true);
5187         }
5188         par.params().appendix(counters.appendix());
5189
5190         // Compute the item depth of the paragraph
5191         par.itemdepth = getItemDepth(it);
5192
5193         if (layout.margintype == MARGIN_MANUAL) {
5194                 if (par.params().labelWidthString().empty())
5195                         par.params().labelWidthString(par.expandLabel(layout, bp));
5196         } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
5197                 // we do not need to do anything here, since the empty case is
5198                 // handled during export.
5199         } else {
5200                 par.params().labelWidthString(docstring());
5201         }
5202
5203         switch(layout.labeltype) {
5204         case LABEL_ITEMIZE: {
5205                 par.params().labelString(
5206                         (par.itemdepth < 4)
5207                                         ? bp.user_defined_bullet(par.itemdepth).getLabel()
5208                                           // Display fallback for too deeply nested items
5209                                         : bformat(from_ascii("[?%1$d]"), int(par.itemdepth + 1)));
5210                 break;
5211         }
5212
5213         case LABEL_ENUMERATE: {
5214                 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
5215
5216                 switch (par.itemdepth) {
5217                 case 2:
5218                         enumcounter += 'i';
5219                         // fall through
5220                 case 1:
5221                         enumcounter += 'i';
5222                         // fall through
5223                 case 0:
5224                         enumcounter += 'i';
5225                         break;
5226                 case 3:
5227                         enumcounter += "iv";
5228                         break;
5229                 default:
5230                         // not a valid enumdepth...
5231                         break;
5232                 }
5233
5234                 if (needEnumCounterReset(it)) {
5235                         // Increase the parent counter?
5236                         if (layout.stepparentcounter)
5237                                 counters.stepParent(enumcounter, utype);
5238                         // Maybe we have to reset the enumeration counter.
5239                         if (!layout.resumecounter)
5240                                 counters.reset(enumcounter);
5241                 }
5242                 counters.step(enumcounter, utype);
5243
5244                 string const & lang = par.getParLanguage(bp)->code();
5245                 par.params().labelString(counters.theCounter(enumcounter, lang));
5246
5247                 break;
5248         }
5249
5250         case LABEL_SENSITIVE: {
5251                 string const & type = counters.current_float();
5252                 docstring full_label;
5253                 if (type.empty())
5254                         full_label = owner_->B_("Senseless!!! ");
5255                 else {
5256                         docstring name = owner_->B_(textclass.floats().getType(type).name());
5257                         if (counters.hasCounter(from_utf8(type))) {
5258                                 string const & lang = par.getParLanguage(bp)->code();
5259                                 counters.step(from_utf8(type), utype);
5260                                 full_label = bformat(from_ascii("%1$s %2$s:"),
5261                                                      name,
5262                                                      counters.theCounter(from_utf8(type), lang));
5263                         } else
5264                                 full_label = bformat(from_ascii("%1$s #:"), name);
5265                 }
5266                 par.params().labelString(full_label);
5267                 break;
5268         }
5269
5270         case LABEL_NO_LABEL:
5271                 par.params().labelString(docstring());
5272                 break;
5273
5274         case LABEL_ABOVE:
5275         case LABEL_CENTERED:
5276         case LABEL_STATIC: {
5277                 docstring const & lcounter = layout.counter;
5278                 if (!lcounter.empty()) {
5279                         if (layout.toclevel <= bp.secnumdepth
5280                                                 && (layout.latextype != LATEX_ENVIRONMENT
5281                                         || it.text()->isFirstInSequence(it.pit()))) {
5282                                 if (counters.hasCounter(lcounter))
5283                                         counters.step(lcounter, utype);
5284                                 par.params().labelString(par.expandLabel(layout, bp));
5285                         } else
5286                                 par.params().labelString(docstring());
5287                 } else
5288                         par.params().labelString(par.expandLabel(layout, bp));
5289                 break;
5290         }
5291
5292         case LABEL_MANUAL:
5293         case LABEL_BIBLIO:
5294                 par.params().labelString(par.expandLabel(layout, bp));
5295         }
5296 }
5297
5298
5299 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype, bool const deleted) const
5300 {
5301         pushIncludedBuffer(this);
5302         // LASSERT: Is it safe to continue here, or should we just return?
5303         LASSERT(parit.pit() == 0, /**/);
5304
5305         // Set the position of the text in the buffer to be able
5306         // to resolve macros in it.
5307         parit.text()->setMacrocontextPosition(parit);
5308
5309         depth_type maxdepth = 0;
5310         pit_type const lastpit = parit.lastpit();
5311         bool changed = false;
5312         for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
5313                 // reduce depth if necessary
5314                 if (parit->params().depth() > maxdepth) {
5315                         /** FIXME: this function is const, but
5316                          * nevertheless it modifies the buffer. To be
5317                          * cleaner, one should modify the buffer in
5318                          * another function, which is actually
5319                          * non-const. This would however be costly in
5320                          * terms of code duplication.
5321                          */
5322                         CursorData(parit).recordUndo();
5323                         parit->params().depth(maxdepth);
5324                 }
5325                 maxdepth = parit->getMaxDepthAfter();
5326
5327                 if (utype == OutputUpdate) {
5328                         // track the active counters
5329                         // we have to do this for the master buffer, since the local
5330                         // buffer isn't tracking anything.
5331                         masterBuffer()->params().documentClass().counters().
5332                                         setActiveLayout(parit->layout());
5333                 }
5334
5335                 // set the counter for this paragraph
5336                 d->setLabel(parit, utype);
5337
5338                 // now the insets
5339                 for (auto const & insit : parit->insetList()) {
5340                         parit.pos() = insit.pos;
5341                         insit.inset->updateBuffer(parit, utype, deleted || parit->isDeleted(insit.pos));
5342                         changed |= insit.inset->isChanged();
5343                 }
5344
5345                 // are there changes in this paragraph?
5346                 changed |= parit->isChanged();
5347         }
5348
5349         // set change indicator for the inset (or the cell that the iterator
5350         // points to, if applicable).
5351         parit.text()->inset().isChanged(changed);
5352         popIncludedBuffer();
5353 }
5354
5355
5356 void Buffer::forceUpdate() const
5357 {
5358         d->need_update = true;
5359 }
5360
5361
5362 bool Buffer::needUpdate() const
5363 {
5364         return d->need_update;
5365 }
5366
5367
5368 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
5369         WordLangTuple & word_lang, docstring_list & suggestions) const
5370 {
5371         int progress = 0;
5372         WordLangTuple wl;
5373         suggestions.clear();
5374         word_lang = WordLangTuple();
5375         bool const to_end = to.empty();
5376         DocIterator const end = to_end ? doc_iterator_end(this) : to;
5377         // OK, we start from here.
5378         for (; from != end; from.forwardPos()) {
5379                 // This skips all insets with spell check disabled.
5380                 while (!from.allowSpellCheck()) {
5381                         from.pop_back();
5382                         from.pos()++;
5383                 }
5384                 // If from is at the end of the document (which is possible
5385                 // when "from" was changed above) LyX will crash later otherwise.
5386                 if (from.atEnd() || (!to_end && from >= end))
5387                         break;
5388                 to = from;
5389                 from.paragraph().spellCheck();
5390                 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
5391                 if (SpellChecker::misspelled(res)) {
5392                         word_lang = wl;
5393                         break;
5394                 }
5395                 // Do not increase progress when from == to, otherwise the word
5396                 // count will be wrong.
5397                 if (from != to) {
5398                         from = to;
5399                         ++progress;
5400                 }
5401         }
5402         return progress;
5403 }
5404
5405
5406 void Buffer::requestSpellcheck()
5407 {
5408         ParagraphList::iterator pit = paragraphs().begin();
5409         ParagraphList::iterator pend = paragraphs().end();
5410         for (; pit != pend; ++pit)
5411                 pit->requestSpellCheck();
5412 }
5413
5414
5415 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
5416 {
5417         bool inword = false;
5418         word_count_ = 0;
5419         char_count_ = 0;
5420         blank_count_ = 0;
5421
5422         for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
5423                 if (!dit.inTexted()) {
5424                         dit.forwardPos();
5425                         continue;
5426                 }
5427
5428                 Paragraph const & par = dit.paragraph();
5429                 pos_type const pos = dit.pos();
5430
5431                 // Copied and adapted from isWordSeparator() in Paragraph
5432                 if (pos == dit.lastpos()) {
5433                         inword = false;
5434                 } else {
5435                         Inset const * ins = par.getInset(pos);
5436                         if (ins && skipNoOutput && !ins->producesOutput()) {
5437                                 // skip this inset
5438                                 ++dit.top().pos();
5439                                 // stop if end of range was skipped
5440                                 if (!to.atEnd() && dit >= to)
5441                                         break;
5442                                 continue;
5443                         } else if (!par.isDeleted(pos)) {
5444                                 if (par.isWordSeparator(pos))
5445                                         inword = false;
5446                                 else if (!inword) {
5447                                         ++word_count_;
5448                                         inword = true;
5449                                 }
5450                                 if (ins && ins->isLetter()) {
5451                                         odocstringstream os;
5452                                         ins->toString(os);
5453                                         char_count_ += os.str().length();
5454                                 }
5455                                 else if (ins && ins->isSpace())
5456                                         ++blank_count_;
5457                                 else if (ins) {
5458                                         pair<int, int> words = ins->isWords();
5459                                         char_count_ += words.first;
5460                                         word_count_ += words.second;
5461                                         inword = false;
5462                                 }
5463                                 else {
5464                                         char_type const c = par.getChar(pos);
5465                                         if (isPrintableNonspace(c))
5466                                                 ++char_count_;
5467                                         else if (isSpace(c))
5468                                                 ++blank_count_;
5469                                 }
5470                         }
5471                 }
5472                 dit.forwardPos();
5473         }
5474 }
5475
5476
5477 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
5478 {
5479         d->updateStatistics(from, to, skipNoOutput);
5480 }
5481
5482
5483 int Buffer::wordCount() const
5484 {
5485         return d->wordCount();
5486 }
5487
5488
5489 int Buffer::charCount(bool with_blanks) const
5490 {
5491         return d->charCount(with_blanks);
5492 }
5493
5494
5495 bool Buffer::areChangesPresent() const
5496 {
5497         return inset().isChanged();
5498 }
5499
5500
5501 Buffer::ReadStatus Buffer::reload()
5502 {
5503         setBusy(true);
5504         // c.f. bug https://www.lyx.org/trac/ticket/6587
5505         removeAutosaveFile();
5506         // e.g., read-only status could have changed due to version control
5507         d->filename.refresh();
5508         docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
5509
5510         // clear parent. this will get reset if need be.
5511         d->setParent(nullptr);
5512         ReadStatus const status = loadLyXFile();
5513         if (status == ReadSuccess) {
5514                 updateBuffer();
5515                 changed(true);
5516                 updateTitles();
5517                 markClean();
5518                 message(bformat(_("Document %1$s reloaded."), disp_fn));
5519                 d->undo_.clear();
5520         } else {
5521                 message(bformat(_("Could not reload document %1$s."), disp_fn));
5522         }
5523         setBusy(false);
5524         removePreviews();
5525         updatePreviews();
5526         errors("Parse");
5527         return status;
5528 }
5529
5530
5531 bool Buffer::saveAs(FileName const & fn)
5532 {
5533         FileName const old_name = fileName();
5534         FileName const old_auto = getAutosaveFileName();
5535         bool const old_unnamed = isUnnamed();
5536         bool success = true;
5537         d->old_position = filePath();
5538
5539         setFileName(fn);
5540         markDirty();
5541         setUnnamed(false);
5542
5543         if (save()) {
5544                 // bring the autosave file with us, just in case.
5545                 moveAutosaveFile(old_auto);
5546                 // validate version control data and
5547                 // correct buffer title
5548                 lyxvc().file_found_hook(fileName());
5549                 updateTitles();
5550                 // the file has now been saved to the new location.
5551                 // we need to check that the locations of child buffers
5552                 // are still valid.
5553                 checkChildBuffers();
5554                 checkMasterBuffer();
5555         } else {
5556                 // save failed
5557                 // reset the old filename and unnamed state
5558                 setFileName(old_name);
5559                 setUnnamed(old_unnamed);
5560                 success = false;
5561         }
5562
5563         d->old_position.clear();
5564         return success;
5565 }
5566
5567
5568 void Buffer::checkChildBuffers()
5569 {
5570         for (auto const & bit : d->children_positions) {
5571                 DocIterator dit = bit.second;
5572                 Buffer * cbuf = const_cast<Buffer *>(bit.first);
5573                 if (!cbuf || !theBufferList().isLoaded(cbuf))
5574                         continue;
5575                 Inset * inset = dit.nextInset();
5576                 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5577                 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5578                 docstring const & incfile = inset_inc->getParam("filename");
5579                 string oldloc = cbuf->absFileName();
5580                 string newloc = makeAbsPath(to_utf8(incfile),
5581                                 onlyPath(absFileName())).absFileName();
5582                 if (oldloc == newloc)
5583                         continue;
5584                 // the location of the child file is incorrect.
5585                 cbuf->setParent(nullptr);
5586                 inset_inc->setChildBuffer(nullptr);
5587         }
5588         // invalidate cache of children
5589         d->children_positions.clear();
5590         d->position_to_children.clear();
5591 }
5592
5593
5594 // If a child has been saved under a different name/path, it might have been
5595 // orphaned. Therefore the master needs to be reset (bug 8161).
5596 void Buffer::checkMasterBuffer()
5597 {
5598         Buffer const * const master = masterBuffer();
5599         if (master == this)
5600                 return;
5601
5602         // necessary to re-register the child (bug 5873)
5603         // FIXME: clean up updateMacros (here, only
5604         // child registering is needed).
5605         master->updateMacros();
5606         // (re)set master as master buffer, but only
5607         // if we are a real child
5608         if (master->isChild(this))
5609                 setParent(master);
5610         else
5611                 setParent(nullptr);
5612 }
5613
5614
5615 string Buffer::includedFilePath(string const & name, string const & ext) const
5616 {
5617         if (d->old_position.empty() ||
5618             equivalent(FileName(d->old_position), FileName(filePath())))
5619                 return name;
5620
5621         bool isabsolute = FileName::isAbsolute(name);
5622         // both old_position and filePath() end with a path separator
5623         string absname = isabsolute ? name : d->old_position + name;
5624
5625         // if old_position is set to origin, we need to do the equivalent of
5626         // getReferencedFileName() (see readDocument())
5627         if (!isabsolute && d->old_position == params().origin) {
5628                 FileName const test(addExtension(filePath() + name, ext));
5629                 if (test.exists())
5630                         absname = filePath() + name;
5631         }
5632
5633         if (!FileName(addExtension(absname, ext)).exists())
5634                 return name;
5635
5636         if (isabsolute)
5637                 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5638
5639         return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5640                                    from_utf8(filePath())));
5641 }
5642
5643
5644 void Buffer::Impl::refreshFileMonitor()
5645 {
5646         if (file_monitor_ && file_monitor_->filename() == filename.absFileName()) {
5647                 file_monitor_->refresh();
5648                 return;
5649         }
5650
5651         // The previous file monitor is invalid
5652         // This also destroys the previous file monitor and all its connections
5653         file_monitor_ = FileSystemWatcher::monitor(filename);
5654         // file_monitor_ will be destroyed with *this, so it is not going to call a
5655         // destroyed object method.
5656         file_monitor_->connect([this](bool exists) {
5657                         fileExternallyModified(exists);
5658                 });
5659 }
5660
5661
5662 void Buffer::Impl::fileExternallyModified(bool const exists)
5663 {
5664         // ignore notifications after our own saving operations
5665         if (checksum_ == filename.checksum()) {
5666                 LYXERR(Debug::FILES, "External modification but "
5667                        "checksum unchanged: " << filename);
5668                 return;
5669         }
5670         // If the file has been deleted, only mark the file as dirty since it is
5671         // pointless to prompt for reloading. If later a file is moved into this
5672         // location, then the externally modified warning will appear then.
5673         if (exists)
5674                         externally_modified_ = true;
5675         // Update external modification notification.
5676         // Dirty buffers must be visible at all times.
5677         if (wa_ && wa_->unhide(owner_))
5678                 wa_->updateTitles();
5679         else
5680                 // Unable to unhide the buffer (e.g. no GUI or not current View)
5681                 lyx_clean = true;
5682 }
5683
5684
5685 bool Buffer::notifiesExternalModification() const
5686 {
5687         return d->externally_modified_;
5688 }
5689
5690
5691 void Buffer::clearExternalModification() const
5692 {
5693         d->externally_modified_ = false;
5694         if (d->wa_)
5695                 d->wa_->updateTitles();
5696 }
5697
5698
5699 void Buffer::pushIncludedBuffer(Buffer const * buf) const
5700 {
5701         masterBuffer()->d->include_list_.push_back(buf);
5702         if (lyxerr.debugging(Debug::FILES)) {
5703                 LYXERR0("Pushed. Stack now:");
5704                 if (masterBuffer()->d->include_list_.empty())
5705                         LYXERR0("EMPTY!");
5706                 else
5707                         for (auto const & b : masterBuffer()->d->include_list_)
5708                                 LYXERR0(b->fileName());
5709         }
5710 }
5711
5712
5713 void Buffer::popIncludedBuffer() const
5714 {
5715         masterBuffer()->d->include_list_.pop_back();
5716         if (lyxerr.debugging(Debug::FILES)) {
5717                 LYXERR0("Popped. Stack now:");
5718                 if (masterBuffer()->d->include_list_.empty())
5719                         LYXERR0("EMPTY!");
5720                 else
5721                         for (auto const & b : masterBuffer()->d->include_list_)
5722                                 LYXERR0(b->fileName());
5723         }
5724 }
5725
5726
5727 bool Buffer::isBufferIncluded(Buffer const * buf) const
5728 {
5729         if (!buf)
5730                 return false;
5731         if (lyxerr.debugging(Debug::FILES)) {
5732                 LYXERR0("Checking for " << buf->fileName() << ". Stack now:");
5733                 if (masterBuffer()->d->include_list_.empty())
5734                         LYXERR0("EMPTY!");
5735                 else
5736                         for (auto const & b : masterBuffer()->d->include_list_)
5737                                 LYXERR0(b->fileName());
5738         }
5739         list<Buffer const *> const & blist = masterBuffer()->d->include_list_;
5740         return find(blist.begin(), blist.end(), buf) != blist.end();
5741 }
5742
5743
5744 void Buffer::clearIncludeList() const
5745 {
5746         LYXERR(Debug::FILES, "Clearing include list for " << fileName());
5747         d->include_list_.clear();
5748 }
5749
5750 } // namespace lyx