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