src/Buffer.cpp

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