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