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