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