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