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