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