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 (!isExporting() && 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                            OutputWhat output) 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, runparams, output);
1344         }
1345         catch (EncodingException & e) {
1346                 odocstringstream ods;
1347                 ods.put(e.failed_char);
1348                 ostringstream oss;
1349                 oss << "0x" << hex << e.failed_char << dec;
1350                 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1351                                           " (code point %2$s)"),
1352                                           ods.str(), from_utf8(oss.str()));
1353                 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1354                                 "representable in the chosen encoding.\n"
1355                                 "Changing the document encoding to utf8 could help."),
1356                                 e.par_id, e.pos, e.pos + 1));
1357                 failed_export = true;
1358         }
1359         catch (iconv_codecvt_facet_exception & e) {
1360                 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1361                         _(e.what()), -1, 0, 0));
1362                 failed_export = true;
1363         }
1364         catch (exception const & e) {
1365                 errorList.push_back(ErrorItem(_("conversion failed"),
1366                         _(e.what()), -1, 0, 0));
1367                 failed_export = true;
1368         }
1369         catch (...) {
1370                 lyxerr << "Caught some really weird exception..." << endl;
1371                 lyx_exit(1);
1372         }
1373
1374         ofs.close();
1375         if (ofs.fail()) {
1376                 failed_export = true;
1377                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1378         }
1379
1380         errors("Export");
1381         return !failed_export;
1382 }
1383
1384
1385 void Buffer::writeLaTeXSource(otexstream & os,
1386                            string const & original_path,
1387                            OutputParams const & runparams_in,
1388          OutputWhat output) const
1389 {
1390         // The child documents, if any, shall be already loaded at this point.
1391
1392         OutputParams runparams = runparams_in;
1393
1394         // Classify the unicode characters appearing in math insets
1395         Encodings::initUnicodeMath(*this);
1396
1397         // validate the buffer.
1398         LYXERR(Debug::LATEX, "  Validating buffer...");
1399         LaTeXFeatures features(*this, params(), runparams);
1400         validate(features);
1401         LYXERR(Debug::LATEX, "  Buffer validation done.");
1402
1403         bool const output_preamble =
1404                 output == FullSource || output == OnlyPreamble;
1405         bool const output_body =
1406           output == FullSource || output == OnlyBody;
1407
1408         // The starting paragraph of the coming rows is the
1409         // first paragraph of the document. (Asger)
1410         if (output_preamble && runparams.nice) {
1411                 os << "%% LyX " << lyx_version << " created this file.  "
1412                         "For more info, see http://www.lyx.org/.\n"
1413                         "%% Do not edit unless you really know what "
1414                         "you are doing.\n";
1415         }
1416         LYXERR(Debug::INFO, "lyx document header finished");
1417
1418         // There are a few differences between nice LaTeX and usual files:
1419         // usual files have \batchmode and special input@path to allow
1420         // inclusion of figures specified by an explicitly relative path
1421         // (i.e., a path starting with './' or '../') with either \input or
1422         // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1423         // input@path is set when the actual parameter original_path is set.
1424         // This is done for usual tex-file, but not for nice-latex-file.
1425         // (Matthias 250696)
1426         // Note that input@path is only needed for something the user does
1427         // in the preamble, included .tex files or ERT, files included by
1428         // LyX work without it.
1429         if (output_preamble) {
1430                 if (!runparams.nice) {
1431                         // code for usual, NOT nice-latex-file
1432                         os << "\\batchmode\n"; // changed from \nonstopmode
1433                 }
1434                 if (!original_path.empty()) {
1435                         // FIXME UNICODE
1436                         // We don't know the encoding of inputpath
1437                         docstring const inputpath = from_utf8(original_path);
1438                         docstring uncodable_glyphs;
1439                         Encoding const * const enc = runparams.encoding;
1440                         if (enc) {
1441                                 for (size_t n = 0; n < inputpath.size(); ++n) {
1442                                         docstring const glyph =
1443                                                 docstring(1, inputpath[n]);
1444                                         if (enc->latexChar(inputpath[n], true) != glyph) {
1445                                                 LYXERR0("Uncodable character '"
1446                                                         << glyph
1447                                                         << "' in input path!");
1448                                                 uncodable_glyphs += glyph;
1449                                         }
1450                                 }
1451                         }
1452
1453                         // warn user if we found uncodable glyphs.
1454                         if (!uncodable_glyphs.empty()) {
1455                                 frontend::Alert::warning(
1456                                         _("Uncodable character in file path"),
1457                                         support::bformat(
1458                                           _("The path of your document\n"
1459                                             "(%1$s)\n"
1460                                             "contains glyphs that are unknown "
1461                                             "in the current document encoding "
1462                                             "(namely %2$s). This may result in "
1463                                             "incomplete output, unless "
1464                                             "TEXINPUTS contains the document "
1465                                             "directory and you don't use "
1466                                             "explicitly relative paths (i.e., "
1467                                             "paths starting with './' or "
1468                                             "'../') in the preamble or in ERT."
1469                                             "\n\nIn case of problems, choose "
1470                                             "an appropriate document encoding\n"
1471                                             "(such as utf8) or change the "
1472                                             "file path name."),
1473                                           inputpath, uncodable_glyphs));
1474                         } else {
1475                                 string docdir =
1476                                         support::latex_path(original_path);
1477                                 if (contains(docdir, '#')) {
1478                                         docdir = subst(docdir, "#", "\\#");
1479                                         os << "\\catcode`\\#=11"
1480                                               "\\def\\#{#}\\catcode`\\#=6\n";
1481                                 }
1482                                 if (contains(docdir, '%')) {
1483                                         docdir = subst(docdir, "%", "\\%");
1484                                         os << "\\catcode`\\%=11"
1485                                               "\\def\\%{%}\\catcode`\\%=14\n";
1486                                 }
1487                                 os << "\\makeatletter\n"
1488                                    << "\\def\\input@path{{"
1489                                    << docdir << "/}}\n"
1490                                    << "\\makeatother\n";
1491                         }
1492                 }
1493
1494                 // get parent macros (if this buffer has a parent) which will be
1495                 // written at the document begin further down.
1496                 MacroSet parentMacros;
1497                 listParentMacros(parentMacros, features);
1498
1499                 runparams.use_polyglossia = features.usePolyglossia();
1500                 // Write the preamble
1501                 runparams.use_babel = params().writeLaTeX(os, features,
1502                                                           d->filename.onlyPath());
1503
1504                 runparams.use_japanese = features.isRequired("japanese");
1505
1506                 if (!output_body)
1507                         return;
1508
1509                 // make the body.
1510                 os << "\\begin{document}\n";
1511
1512                 // output the parent macros
1513                 MacroSet::iterator it = parentMacros.begin();
1514                 MacroSet::iterator end = parentMacros.end();
1515                 for (; it != end; ++it) {
1516                         int num_lines = (*it)->write(os.os(), true);
1517                         os.texrow().newlines(num_lines);
1518                 }
1519
1520         } // output_preamble
1521
1522         os.texrow().start(paragraphs().begin()->id(), 0);
1523
1524         LYXERR(Debug::INFO, "preamble finished, now the body.");
1525
1526         // if we are doing a real file with body, even if this is the
1527         // child of some other buffer, let's cut the link here.
1528         // This happens for example if only a child document is printed.
1529         Buffer const * save_parent = 0;
1530         if (output_preamble) {
1531                 save_parent = d->parent();
1532                 d->setParent(0);
1533         }
1534
1535         // the real stuff
1536         latexParagraphs(*this, text(), os, runparams);
1537
1538         // Restore the parenthood if needed
1539         if (output_preamble)
1540                 d->setParent(save_parent);
1541
1542         // add this just in case after all the paragraphs
1543         os << endl;
1544
1545         if (output_preamble) {
1546                 os << "\\end{document}\n";
1547                 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1548         } else {
1549                 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1550         }
1551         runparams_in.encoding = runparams.encoding;
1552
1553         // Just to be sure. (Asger)
1554         os.texrow().newline();
1555
1556         //for (int i = 0; i<d->texrow.rows(); i++) {
1557         // int id,pos;
1558         // if (d->texrow.getIdFromRow(i+1,id,pos) && id>0)
1559         //      lyxerr << i+1 << ":" << id << ":" << getParFromID(id).paragraph().asString()<<"\n";
1560         //}
1561
1562         LYXERR(Debug::INFO, "Finished making LaTeX file.");
1563         LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
1564 }
1565
1566
1567 void Buffer::makeDocBookFile(FileName const & fname,
1568                               OutputParams const & runparams,
1569                               OutputWhat output) const
1570 {
1571         LYXERR(Debug::LATEX, "makeDocBookFile...");
1572
1573         ofdocstream ofs;
1574         if (!openFileWrite(ofs, fname))
1575                 return;
1576
1577         // make sure we are ready to export
1578         // this needs to be done before we validate
1579         updateBuffer();
1580         updateMacroInstances(OutputUpdate);
1581
1582         writeDocBookSource(ofs, fname.absFileName(), runparams, output);
1583
1584         ofs.close();
1585         if (ofs.fail())
1586                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1587 }
1588
1589
1590 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1591                              OutputParams const & runparams,
1592                              OutputWhat output) const
1593 {
1594         LaTeXFeatures features(*this, params(), runparams);
1595         validate(features);
1596
1597         d->texrow.reset();
1598
1599         DocumentClass const & tclass = params().documentClass();
1600         string const top_element = tclass.latexname();
1601
1602         bool const output_preamble =
1603                 output == FullSource || output == OnlyPreamble;
1604         bool const output_body =
1605           output == FullSource || output == OnlyBody;
1606
1607         if (output_preamble) {
1608                 if (runparams.flavor == OutputParams::XML)
1609                         os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1610
1611                 // FIXME UNICODE
1612                 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1613
1614                 // FIXME UNICODE
1615                 if (! tclass.class_header().empty())
1616                         os << from_ascii(tclass.class_header());
1617                 else if (runparams.flavor == OutputParams::XML)
1618                         os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1619                             << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1620                 else
1621                         os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1622
1623                 docstring preamble = from_utf8(params().preamble);
1624                 if (runparams.flavor != OutputParams::XML ) {
1625                         preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1626                         preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1627                         preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1628                         preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1629                 }
1630
1631                 string const name = runparams.nice
1632                         ? changeExtension(absFileName(), ".sgml") : fname;
1633                 preamble += features.getIncludedFiles(name);
1634                 preamble += features.getLyXSGMLEntities();
1635
1636                 if (!preamble.empty()) {
1637                         os << "\n [ " << preamble << " ]";
1638                 }
1639                 os << ">\n\n";
1640         }
1641
1642         if (output_body) {
1643                 string top = top_element;
1644                 top += " lang=\"";
1645                 if (runparams.flavor == OutputParams::XML)
1646                         top += params().language->code();
1647                 else
1648                         top += params().language->code().substr(0, 2);
1649                 top += '"';
1650
1651                 if (!params().options.empty()) {
1652                         top += ' ';
1653                         top += params().options;
1654                 }
1655
1656                 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1657                                 << " file was created by LyX " << lyx_version
1658                                 << "\n  See http://www.lyx.org/ for more information -->\n";
1659
1660                 params().documentClass().counters().reset();
1661
1662                 sgml::openTag(os, top);
1663                 os << '\n';
1664                 docbookParagraphs(text(), *this, os, runparams);
1665                 sgml::closeTag(os, top_element);
1666         }
1667 }
1668
1669
1670 void Buffer::makeLyXHTMLFile(FileName const & fname,
1671                               OutputParams const & runparams) const
1672 {
1673         LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
1674
1675         ofdocstream ofs;
1676         if (!openFileWrite(ofs, fname))
1677                 return;
1678
1679         // make sure we are ready to export
1680         // this has to be done before we validate
1681         updateBuffer(UpdateMaster, OutputUpdate);
1682         updateMacroInstances(OutputUpdate);
1683
1684         writeLyXHTMLSource(ofs, runparams, FullSource);
1685
1686         ofs.close();
1687         if (ofs.fail())
1688                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1689 }
1690
1691
1692 void Buffer::writeLyXHTMLSource(odocstream & os,
1693                              OutputParams const & runparams,
1694                              OutputWhat output) const
1695 {
1696         LaTeXFeatures features(*this, params(), runparams);
1697         validate(features);
1698         d->bibinfo_.makeCitationLabels(*this);
1699
1700         bool const output_preamble =
1701                 output == FullSource || output == OnlyPreamble;
1702         bool const output_body =
1703           output == FullSource || output == OnlyBody;
1704
1705         if (output_preamble) {
1706                 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
1707                    << "<!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"
1708                    // FIXME Language should be set properly.
1709                    << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
1710                    << "<head>\n"
1711                    << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
1712                    // FIXME Presumably need to set this right
1713                    << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
1714
1715                 docstring const & doctitle = features.htmlTitle();
1716                 os << "<title>"
1717                    << (doctitle.empty() ? from_ascii("LyX Document") : doctitle)
1718                    << "</title>\n";
1719
1720                 os << "\n<!-- Text Class Preamble -->\n"
1721                    << features.getTClassHTMLPreamble()
1722                    << "\n<!-- Preamble Snippets -->\n"
1723                    << from_utf8(features.getPreambleSnippets());
1724
1725                 os << "\n<!-- Layout-provided Styles -->\n";
1726                 docstring const styleinfo = features.getTClassHTMLStyles();
1727                 if (!styleinfo.empty()) {
1728                         os << "<style type='text/css'>\n"
1729                                 << styleinfo
1730                                 << "</style>\n";
1731                 }
1732
1733                 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
1734                 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
1735                 if (needfg || needbg) {
1736                                 os << "<style type='text/css'>\nbody {\n";
1737                                 if (needfg)
1738                                    os << "  color: "
1739                                             << from_ascii(X11hexname(params().fontcolor))
1740                                             << ";\n";
1741                                 if (needbg)
1742                                    os << "  background-color: "
1743                                             << from_ascii(X11hexname(params().backgroundcolor))
1744                                             << ";\n";
1745                                 os << "}\n</style>\n";
1746                 }
1747                 os << "</head>\n";
1748         }
1749
1750         if (output_body) {
1751                 os << "<body>\n";
1752                 XHTMLStream xs(os);
1753                 params().documentClass().counters().reset();
1754                 xhtmlParagraphs(text(), *this, xs, runparams);
1755                 os << "</body>\n";
1756         }
1757
1758         if (output_preamble)
1759                 os << "</html>\n";
1760 }
1761
1762
1763 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1764 // Other flags: -wall -v0 -x
1765 int Buffer::runChktex()
1766 {
1767         setBusy(true);
1768
1769         // get LaTeX-Filename
1770         FileName const path(temppath());
1771         string const name = addName(path.absFileName(), latexName());
1772         string const org_path = filePath();
1773
1774         PathChanger p(path); // path to LaTeX file
1775         message(_("Running chktex..."));
1776
1777         // Generate the LaTeX file if neccessary
1778         OutputParams runparams(&params().encoding());
1779         runparams.flavor = OutputParams::LATEX;
1780         runparams.nice = false;
1781         runparams.linelen = lyxrc.plaintext_linelen;
1782         makeLaTeXFile(FileName(name), org_path, runparams);
1783
1784         TeXErrors terr;
1785         Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
1786         int const res = chktex.run(terr); // run chktex
1787
1788         if (res == -1) {
1789                 Alert::error(_("chktex failure"),
1790                              _("Could not run chktex successfully."));
1791         } else if (res > 0) {
1792                 ErrorList & errlist = d->errorLists["ChkTeX"];
1793                 errlist.clear();
1794                 bufferErrors(terr, errlist);
1795         }
1796
1797         setBusy(false);
1798
1799         errors("ChkTeX");
1800
1801         return res;
1802 }
1803
1804
1805 void Buffer::validate(LaTeXFeatures & features) const
1806 {
1807         params().validate(features);
1808
1809         for_each(paragraphs().begin(), paragraphs().end(),
1810                  bind(&Paragraph::validate, _1, ref(features)));
1811
1812         if (lyxerr.debugging(Debug::LATEX)) {
1813                 features.showStruct();
1814         }
1815 }
1816
1817
1818 void Buffer::getLabelList(vector<docstring> & list) const
1819 {
1820         // If this is a child document, use the master's list instead.
1821         if (parent()) {
1822                 masterBuffer()->getLabelList(list);
1823                 return;
1824         }
1825
1826         list.clear();
1827         Toc & toc = d->toc_backend.toc("label");
1828         TocIterator toc_it = toc.begin();
1829         TocIterator end = toc.end();
1830         for (; toc_it != end; ++toc_it) {
1831                 if (toc_it->depth() == 0)
1832                         list.push_back(toc_it->str());
1833         }
1834 }
1835
1836
1837 void Buffer::updateBibfilesCache(UpdateScope scope) const
1838 {
1839         // FIXME This is probably unnecssary, given where we call this.
1840         // If this is a child document, use the parent's cache instead.
1841         if (parent() && scope != UpdateChildOnly) {
1842                 masterBuffer()->updateBibfilesCache();
1843                 return;
1844         }
1845
1846         d->bibfiles_cache_.clear();
1847         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1848                 if (it->lyxCode() == BIBTEX_CODE) {
1849                         InsetBibtex const & inset = static_cast<InsetBibtex const &>(*it);
1850                         support::FileNameList const bibfiles = inset.getBibFiles();
1851                         d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
1852                                 bibfiles.begin(),
1853                                 bibfiles.end());
1854                 } else if (it->lyxCode() == INCLUDE_CODE) {
1855                         InsetInclude & inset = static_cast<InsetInclude &>(*it);
1856                         Buffer const * const incbuf = inset.getChildBuffer();
1857                         if (!incbuf)
1858                                 continue;
1859                         support::FileNameList const & bibfiles =
1860                                         incbuf->getBibfilesCache(UpdateChildOnly);
1861                         if (!bibfiles.empty()) {
1862                                 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
1863                                         bibfiles.begin(),
1864                                         bibfiles.end());
1865                         }
1866                 }
1867         }
1868         d->bibfile_cache_valid_ = true;
1869         d->bibinfo_cache_valid_ = false;
1870         d->cite_labels_valid_ = false;
1871 }
1872
1873
1874 void Buffer::invalidateBibinfoCache() const
1875 {
1876         d->bibinfo_cache_valid_ = false;
1877         d->cite_labels_valid_ = false;
1878         // also invalidate the cache for the parent buffer
1879         Buffer const * const pbuf = d->parent();
1880         if (pbuf)
1881                 pbuf->invalidateBibinfoCache();
1882 }
1883
1884
1885 void Buffer::invalidateBibfileCache() const
1886 {
1887         d->bibfile_cache_valid_ = false;
1888         d->bibinfo_cache_valid_ = false;
1889         d->cite_labels_valid_ = false;
1890         // also invalidate the cache for the parent buffer
1891         Buffer const * const pbuf = d->parent();
1892         if (pbuf)
1893                 pbuf->invalidateBibfileCache();
1894 }
1895
1896
1897 support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const
1898 {
1899         // FIXME This is probably unnecessary, given where we call this.
1900         // If this is a child document, use the master's cache instead.
1901         Buffer const * const pbuf = masterBuffer();
1902         if (pbuf != this && scope != UpdateChildOnly)
1903                 return pbuf->getBibfilesCache();
1904
1905         if (!d->bibfile_cache_valid_)
1906                 this->updateBibfilesCache(scope);
1907
1908         return d->bibfiles_cache_;
1909 }
1910
1911
1912 BiblioInfo const & Buffer::masterBibInfo() const
1913 {
1914         Buffer const * const tmp = masterBuffer();
1915         if (tmp != this)
1916                 return tmp->masterBibInfo();
1917         return d->bibinfo_;
1918 }
1919
1920
1921 void Buffer::checkIfBibInfoCacheIsValid() const
1922 {
1923         // use the master's cache
1924         Buffer const * const tmp = masterBuffer();
1925         if (tmp != this) {
1926                 tmp->checkIfBibInfoCacheIsValid();
1927                 return;
1928         }
1929
1930         // compare the cached timestamps with the actual ones.
1931         FileNameList const & bibfiles_cache = getBibfilesCache();
1932         FileNameList::const_iterator ei = bibfiles_cache.begin();
1933         FileNameList::const_iterator en = bibfiles_cache.end();
1934         for (; ei != en; ++ ei) {
1935                 time_t lastw = ei->lastModified();
1936                 time_t prevw = d->bibfile_status_[*ei];
1937                 if (lastw != prevw) {
1938                         d->bibinfo_cache_valid_ = false;
1939                         d->cite_labels_valid_ = false;
1940                         d->bibfile_status_[*ei] = lastw;
1941                 }
1942         }
1943 }
1944
1945
1946 void Buffer::reloadBibInfoCache() const
1947 {
1948         // use the master's cache
1949         Buffer const * const tmp = masterBuffer();
1950         if (tmp != this) {
1951                 tmp->reloadBibInfoCache();
1952                 return;
1953         }
1954
1955         checkIfBibInfoCacheIsValid();
1956         if (d->bibinfo_cache_valid_)
1957                 return;
1958
1959         d->bibinfo_.clear();
1960         collectBibKeys();
1961         d->bibinfo_cache_valid_ = true;
1962 }
1963
1964
1965 void Buffer::collectBibKeys() const
1966 {
1967         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1968                 it->collectBibKeys(it);
1969 }
1970
1971
1972 void Buffer::addBiblioInfo(BiblioInfo const & bi) const
1973 {
1974         Buffer const * tmp = masterBuffer();
1975         BiblioInfo & masterbi = (tmp == this) ?
1976                 d->bibinfo_ : tmp->d->bibinfo_;
1977         masterbi.mergeBiblioInfo(bi);
1978 }
1979
1980
1981 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const
1982 {
1983         Buffer const * tmp = masterBuffer();
1984         BiblioInfo & masterbi = (tmp == this) ?
1985                 d->bibinfo_ : tmp->d->bibinfo_;
1986         masterbi[key] = bi;
1987 }
1988
1989
1990 bool Buffer::citeLabelsValid() const
1991 {
1992         return masterBuffer()->d->cite_labels_valid_;
1993 }
1994
1995
1996 bool Buffer::isDepClean(string const & name) const
1997 {
1998         DepClean::const_iterator const it = d->dep_clean.find(name);
1999         if (it == d->dep_clean.end())
2000                 return true;
2001         return it->second;
2002 }
2003
2004
2005 void Buffer::markDepClean(string const & name)
2006 {
2007         d->dep_clean[name] = true;
2008 }
2009
2010
2011 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2012 {
2013         if (isInternal()) {
2014                 // FIXME? if there is an Buffer LFUN that can be dispatched even
2015                 // if internal, put a switch '(cmd.action)' here.
2016                 return false;
2017         }
2018
2019         bool enable = true;
2020
2021         switch (cmd.action()) {
2022
2023                 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2024                         flag.setOnOff(isReadonly());
2025                         break;
2026
2027                 // FIXME: There is need for a command-line import.
2028                 //case LFUN_BUFFER_IMPORT:
2029
2030                 case LFUN_BUFFER_AUTO_SAVE:
2031                         break;
2032
2033                 case LFUN_BUFFER_EXPORT_CUSTOM:
2034                         // FIXME: Nothing to check here?
2035                         break;
2036
2037                 case LFUN_BUFFER_EXPORT: {
2038                         docstring const arg = cmd.argument();
2039                         if (arg == "custom") {
2040                                 enable = true;
2041                                 break;
2042                         }
2043                         string format = to_utf8(arg);
2044                         size_t pos = format.find(' ');
2045                         if (pos != string::npos)
2046                                 format = format.substr(0, pos);
2047                         enable = params().isExportable(format);
2048                         if (!enable)
2049                                 flag.message(bformat(
2050                                         _("Don't know how to export to format: %1$s"), arg));
2051                         break;
2052                 }
2053
2054                 case LFUN_BUFFER_CHKTEX:
2055                         enable = params().isLatex() && !lyxrc.chktex_command.empty();
2056                         break;
2057
2058                 case LFUN_BUILD_PROGRAM:
2059                         enable = params().isExportable("program");
2060                         break;
2061
2062                 case LFUN_BRANCH_ACTIVATE:
2063                 case LFUN_BRANCH_DEACTIVATE: {
2064                         BranchList const & branchList = params().branchlist();
2065                         docstring const branchName = cmd.argument();
2066                         enable = !branchName.empty() && branchList.find(branchName);
2067                         break;
2068                 }
2069
2070                 case LFUN_BRANCH_ADD:
2071                 case LFUN_BRANCHES_RENAME:
2072                 case LFUN_BUFFER_PRINT:
2073                         // if no Buffer is present, then of course we won't be called!
2074                         break;
2075
2076                 case LFUN_BUFFER_LANGUAGE:
2077                         enable = !isReadonly();
2078                         break;
2079
2080                 default:
2081                         return false;
2082         }
2083         flag.setEnabled(enable);
2084         return true;
2085 }
2086
2087
2088 void Buffer::dispatch(string const & command, DispatchResult & result)
2089 {
2090         return dispatch(lyxaction.lookupFunc(command), result);
2091 }
2092
2093
2094 // NOTE We can end up here even if we have no GUI, because we are called
2095 // by LyX::exec to handled command-line requests. So we may need to check
2096 // whether we have a GUI or not. The boolean use_gui holds this information.
2097 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2098 {
2099         if (isInternal()) {
2100                 // FIXME? if there is an Buffer LFUN that can be dispatched even
2101                 // if internal, put a switch '(cmd.action())' here.
2102                 dr.dispatched(false);
2103                 return;
2104         }
2105         string const argument = to_utf8(func.argument());
2106         // We'll set this back to false if need be.
2107         bool dispatched = true;
2108         undo().beginUndoGroup();
2109
2110         switch (func.action()) {
2111         case LFUN_BUFFER_TOGGLE_READ_ONLY:
2112                 if (lyxvc().inUse())
2113                         lyxvc().toggleReadOnly();
2114                 else
2115                         setReadonly(!isReadonly());
2116                 break;
2117
2118         case LFUN_BUFFER_EXPORT: {
2119                 ExportStatus const status = doExport(argument, false);
2120                 dr.setError(status != ExportSuccess);
2121                 if (status != ExportSuccess)
2122                         dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2123                                               func.argument()));
2124                 break;
2125         }
2126
2127         case LFUN_BUILD_PROGRAM:
2128                 doExport("program", true);
2129                 break;
2130
2131         case LFUN_BUFFER_CHKTEX:
2132                 runChktex();
2133                 break;
2134
2135         case LFUN_BUFFER_EXPORT_CUSTOM: {
2136                 string format_name;
2137                 string command = split(argument, format_name, ' ');
2138                 Format const * format = formats.getFormat(format_name);
2139                 if (!format) {
2140                         lyxerr << "Format \"" << format_name
2141                                 << "\" not recognized!"
2142                                 << endl;
2143                         break;
2144                 }
2145
2146                 // The name of the file created by the conversion process
2147                 string filename;
2148
2149                 // Output to filename
2150                 if (format->name() == "lyx") {
2151                         string const latexname = latexName(false);
2152                         filename = changeExtension(latexname,
2153                                 format->extension());
2154                         filename = addName(temppath(), filename);
2155
2156                         if (!writeFile(FileName(filename)))
2157                                 break;
2158
2159                 } else {
2160                         doExport(format_name, true, filename);
2161                 }
2162
2163                 // Substitute $$FName for filename
2164                 if (!contains(command, "$$FName"))
2165                         command = "( " + command + " ) < $$FName";
2166                 command = subst(command, "$$FName", filename);
2167
2168                 // Execute the command in the background
2169                 Systemcall call;
2170                 call.startscript(Systemcall::DontWait, command, filePath());
2171                 break;
2172         }
2173
2174         // FIXME: There is need for a command-line import.
2175         /*
2176         case LFUN_BUFFER_IMPORT:
2177                 doImport(argument);
2178                 break;
2179         */
2180
2181         case LFUN_BUFFER_AUTO_SAVE:
2182                 autoSave();
2183                 resetAutosaveTimers();
2184                 break;
2185
2186         case LFUN_BRANCH_ADD: {
2187                 docstring branch_name = func.argument();
2188                 if (branch_name.empty()) {
2189                         dispatched = false;
2190                         break;
2191                 }
2192                 BranchList & branch_list = params().branchlist();
2193                 vector<docstring> const branches =
2194                         getVectorFromString(branch_name, branch_list.separator());
2195                 docstring msg;
2196                 for (vector<docstring>::const_iterator it = branches.begin();
2197                      it != branches.end(); ++it) {
2198                         branch_name = *it;
2199                         Branch * branch = branch_list.find(branch_name);
2200                         if (branch) {
2201                                 LYXERR0("Branch " << branch_name << " already exists.");
2202                                 dr.setError(true);
2203                                 if (!msg.empty())
2204                                         msg += ("\n");
2205                                 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2206                         } else {
2207                                 branch_list.add(branch_name);
2208                                 branch = branch_list.find(branch_name);
2209                                 string const x11hexname = X11hexname(branch->color());
2210                                 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2211                                 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2212                                 dr.setError(false);
2213                                 dr.screenUpdate(Update::Force);
2214                         }
2215                 }
2216                 if (!msg.empty())
2217                         dr.setMessage(msg);
2218                 break;
2219         }
2220
2221         case LFUN_BRANCH_ACTIVATE:
2222         case LFUN_BRANCH_DEACTIVATE: {
2223                 BranchList & branchList = params().branchlist();
2224                 docstring const branchName = func.argument();
2225                 // the case without a branch name is handled elsewhere
2226                 if (branchName.empty()) {
2227                         dispatched = false;
2228                         break;
2229                 }
2230                 Branch * branch = branchList.find(branchName);
2231                 if (!branch) {
2232                         LYXERR0("Branch " << branchName << " does not exist.");
2233                         dr.setError(true);
2234                         docstring const msg =
2235                                 bformat(_("Branch \"%1$s\" does not exist."), branchName);
2236                         dr.setMessage(msg);
2237                 } else {
2238                         branch->setSelected(func.action() == LFUN_BRANCH_ACTIVATE);
2239                         dr.setError(false);
2240                         dr.screenUpdate(Update::Force);
2241                         dr.forceBufferUpdate();
2242                 }
2243                 break;
2244         }
2245
2246         case LFUN_BRANCHES_RENAME: {
2247                 if (func.argument().empty())
2248                         break;
2249
2250                 docstring const oldname = from_utf8(func.getArg(0));
2251                 docstring const newname = from_utf8(func.getArg(1));
2252                 InsetIterator it  = inset_iterator_begin(inset());
2253                 InsetIterator const end = inset_iterator_end(inset());
2254                 bool success = false;
2255                 for (; it != end; ++it) {
2256                         if (it->lyxCode() == BRANCH_CODE) {
2257                                 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2258                                 if (ins.branch() == oldname) {
2259                                         undo().recordUndo(it);
2260                                         ins.rename(newname);
2261                                         success = true;
2262                                         continue;
2263                                 }
2264                         }
2265                         if (it->lyxCode() == INCLUDE_CODE) {
2266                                 // get buffer of external file
2267                                 InsetInclude const & ins =
2268                                         static_cast<InsetInclude const &>(*it);
2269                                 Buffer * child = ins.getChildBuffer();
2270                                 if (!child)
2271                                         continue;
2272                                 child->dispatch(func, dr);
2273                         }
2274                 }
2275
2276                 if (success) {
2277                         dr.screenUpdate(Update::Force);
2278                         dr.forceBufferUpdate();
2279                 }
2280                 break;
2281         }
2282
2283         case LFUN_BUFFER_PRINT: {
2284                 // we'll assume there's a problem until we succeed
2285                 dr.setError(true);
2286                 string target = func.getArg(0);
2287                 string target_name = func.getArg(1);
2288                 string command = func.getArg(2);
2289
2290                 if (target.empty()
2291                     || target_name.empty()
2292                     || command.empty()) {
2293                         LYXERR0("Unable to parse " << func.argument());
2294                         docstring const msg =
2295                                 bformat(_("Unable to parse \"%1$s\""), func.argument());
2296                         dr.setMessage(msg);
2297                         break;
2298                 }
2299                 if (target != "printer" && target != "file") {
2300                         LYXERR0("Unrecognized target \"" << target << '"');
2301                         docstring const msg =
2302                                 bformat(_("Unrecognized target \"%1$s\""), from_utf8(target));
2303                         dr.setMessage(msg);
2304                         break;
2305                 }
2306
2307                 if (!doExport("dvi", true)) {
2308                         showPrintError(absFileName());
2309                         dr.setMessage(_("Error exporting to DVI."));
2310                         break;
2311                 }
2312
2313                 // Push directory path.
2314                 string const path = temppath();
2315                 // Prevent the compiler from optimizing away p
2316                 FileName pp(path);
2317                 PathChanger p(pp);
2318
2319                 // there are three cases here:
2320                 // 1. we print to a file
2321                 // 2. we print directly to a printer
2322                 // 3. we print using a spool command (print to file first)
2323                 Systemcall one;
2324                 int res = 0;
2325                 string const dviname = changeExtension(latexName(true), "dvi");
2326
2327                 if (target == "printer") {
2328                         if (!lyxrc.print_spool_command.empty()) {
2329                                 // case 3: print using a spool
2330                                 string const psname = changeExtension(dviname,".ps");
2331                                 command += ' ' + lyxrc.print_to_file
2332                                         + quoteName(psname)
2333                                         + ' '
2334                                         + quoteName(dviname);
2335
2336                                 string command2 = lyxrc.print_spool_command + ' ';
2337                                 if (target_name != "default") {
2338                                         command2 += lyxrc.print_spool_printerprefix
2339                                                 + target_name
2340                                                 + ' ';
2341                                 }
2342                                 command2 += quoteName(psname);
2343                                 // First run dvips.
2344                                 // If successful, then spool command
2345                                 res = one.startscript(Systemcall::Wait, command,
2346                                                       filePath());
2347
2348                                 if (res == 0) {
2349                                         // If there's no GUI, we have to wait on this command. Otherwise,
2350                                         // LyX deletes the temporary directory, and with it the spooled
2351                                         // file, before it can be printed!!
2352                                         Systemcall::Starttype stype = use_gui ?
2353                                                 Systemcall::DontWait : Systemcall::Wait;
2354                                         res = one.startscript(stype, command2,
2355                                                               filePath());
2356                                 }
2357                         } else {
2358                                 // case 2: print directly to a printer
2359                                 if (target_name != "default")
2360                                         command += ' ' + lyxrc.print_to_printer + target_name + ' ';
2361                                 // as above....
2362                                 Systemcall::Starttype stype = use_gui ?
2363                                         Systemcall::DontWait : Systemcall::Wait;
2364                                 res = one.startscript(stype, command +
2365                                                 quoteName(dviname), filePath());
2366                         }
2367
2368                 } else {
2369                         // case 1: print to a file
2370                         FileName const filename(makeAbsPath(target_name, filePath()));
2371                         FileName const dvifile(makeAbsPath(dviname, path));
2372                         if (filename.exists()) {
2373                                 docstring text = bformat(
2374                                         _("The file %1$s already exists.\n\n"
2375                                           "Do you want to overwrite that file?"),
2376                                         makeDisplayPath(filename.absFileName()));
2377                                 if (Alert::prompt(_("Overwrite file?"),
2378                                                   text, 0, 1, _("&Overwrite"), _("&Cancel")) != 0)
2379                                         break;
2380                         }
2381                         command += ' ' + lyxrc.print_to_file
2382                                 + quoteName(filename.toFilesystemEncoding())
2383                                 + ' '
2384                                 + quoteName(dvifile.toFilesystemEncoding());
2385                         // as above....
2386                         Systemcall::Starttype stype = use_gui ?
2387                                 Systemcall::DontWait : Systemcall::Wait;
2388                         res = one.startscript(stype, command, filePath());
2389                 }
2390
2391                 if (res == 0)
2392                         dr.setError(false);
2393                 else {
2394                         dr.setMessage(_("Error running external commands."));
2395                         showPrintError(absFileName());
2396                 }
2397                 break;
2398         }
2399
2400         default:
2401                 dispatched = false;
2402                 break;
2403         }
2404         dr.dispatched(dispatched);
2405         undo().endUndoGroup();
2406 }
2407
2408
2409 void Buffer::changeLanguage(Language const * from, Language const * to)
2410 {
2411         LASSERT(from, /**/);
2412         LASSERT(to, /**/);
2413
2414         for_each(par_iterator_begin(),
2415                  par_iterator_end(),
2416                  bind(&Paragraph::changeLanguage, _1, params(), from, to));
2417 }
2418
2419
2420 bool Buffer::isMultiLingual() const
2421 {
2422         ParConstIterator end = par_iterator_end();
2423         for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2424                 if (it->isMultiLingual(params()))
2425                         return true;
2426
2427         return false;
2428 }
2429
2430
2431 std::set<Language const *> Buffer::getLanguages() const
2432 {
2433         std::set<Language const *> languages;
2434         getLanguages(languages);
2435         return languages;
2436 }
2437
2438
2439 void Buffer::getLanguages(std::set<Language const *> & languages) const
2440 {
2441         ParConstIterator end = par_iterator_end();
2442         // add the buffer language, even if it's not actively used
2443         languages.insert(language());
2444         // iterate over the paragraphs
2445         for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2446                 it->getLanguages(languages);
2447         // also children
2448         ListOfBuffers clist = getDescendents();
2449         ListOfBuffers::const_iterator cit = clist.begin();
2450         ListOfBuffers::const_iterator const cen = clist.end();
2451         for (; cit != cen; ++cit)
2452                 (*cit)->getLanguages(languages);
2453 }
2454
2455
2456 DocIterator Buffer::getParFromID(int const id) const
2457 {
2458         Buffer * buf = const_cast<Buffer *>(this);
2459         if (id < 0) {
2460                 // John says this is called with id == -1 from undo
2461                 lyxerr << "getParFromID(), id: " << id << endl;
2462                 return doc_iterator_end(buf);
2463         }
2464
2465         for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2466                 if (it.paragraph().id() == id)
2467                         return it;
2468
2469         return doc_iterator_end(buf);
2470 }
2471
2472
2473 bool Buffer::hasParWithID(int const id) const
2474 {
2475         return !getParFromID(id).atEnd();
2476 }
2477
2478
2479 ParIterator Buffer::par_iterator_begin()
2480 {
2481         return ParIterator(doc_iterator_begin(this));
2482 }
2483
2484
2485 ParIterator Buffer::par_iterator_end()
2486 {
2487         return ParIterator(doc_iterator_end(this));
2488 }
2489
2490
2491 ParConstIterator Buffer::par_iterator_begin() const
2492 {
2493         return ParConstIterator(doc_iterator_begin(this));
2494 }
2495
2496
2497 ParConstIterator Buffer::par_iterator_end() const
2498 {
2499         return ParConstIterator(doc_iterator_end(this));
2500 }
2501
2502
2503 Language const * Buffer::language() const
2504 {
2505         return params().language;
2506 }
2507
2508
2509 docstring const Buffer::B_(string const & l10n) const
2510 {
2511         return params().B_(l10n);
2512 }
2513
2514
2515 bool Buffer::isClean() const
2516 {
2517         return d->lyx_clean;
2518 }
2519
2520
2521 bool Buffer::isExternallyModified(CheckMethod method) const
2522 {
2523         LASSERT(d->filename.exists(), /**/);
2524         // if method == timestamp, check timestamp before checksum
2525         return (method == checksum_method
2526                 || d->timestamp_ != d->filename.lastModified())
2527                 && d->checksum_ != d->filename.checksum();
2528 }
2529
2530
2531 void Buffer::saveCheckSum() const
2532 {
2533         FileName const & file = d->filename;
2534
2535         file.refresh();
2536         if (file.exists()) {
2537                 d->timestamp_ = file.lastModified();
2538                 d->checksum_ = file.checksum();
2539         } else {
2540                 // in the case of save to a new file.
2541                 d->timestamp_ = 0;
2542                 d->checksum_ = 0;
2543         }
2544 }
2545
2546
2547 void Buffer::markClean() const
2548 {
2549         if (!d->lyx_clean) {
2550                 d->lyx_clean = true;
2551                 updateTitles();
2552         }
2553         // if the .lyx file has been saved, we don't need an
2554         // autosave
2555         d->bak_clean = true;
2556         d->undo_.markDirty();
2557 }
2558
2559
2560 void Buffer::setUnnamed(bool flag)
2561 {
2562         d->unnamed = flag;
2563 }
2564
2565
2566 bool Buffer::isUnnamed() const
2567 {
2568         return d->unnamed;
2569 }
2570
2571
2572 /// \note
2573 /// Don't check unnamed, here: isInternal() is used in
2574 /// newBuffer(), where the unnamed flag has not been set by anyone
2575 /// yet. Also, for an internal buffer, there should be no need for
2576 /// retrieving fileName() nor for checking if it is unnamed or not.
2577 bool Buffer::isInternal() const
2578 {
2579         return fileName().extension() == "internal";
2580 }
2581
2582
2583 void Buffer::markDirty()
2584 {
2585         if (d->lyx_clean) {
2586                 d->lyx_clean = false;
2587                 updateTitles();
2588         }
2589         d->bak_clean = false;
2590
2591         DepClean::iterator it = d->dep_clean.begin();
2592         DepClean::const_iterator const end = d->dep_clean.end();
2593
2594         for (; it != end; ++it)
2595                 it->second = false;
2596 }
2597
2598
2599 FileName Buffer::fileName() const
2600 {
2601         return d->filename;
2602 }
2603
2604
2605 string Buffer::absFileName() const
2606 {
2607         return d->filename.absFileName();
2608 }
2609
2610
2611 string Buffer::filePath() const
2612 {
2613         return d->filename.onlyPath().absFileName() + "/";
2614 }
2615
2616
2617 bool Buffer::isReadonly() const
2618 {
2619         return d->read_only;
2620 }
2621
2622
2623 void Buffer::setParent(Buffer const * buffer)
2624 {
2625         // Avoids recursive include.
2626         d->setParent(buffer == this ? 0 : buffer);
2627         updateMacros();
2628 }
2629
2630
2631 Buffer const * Buffer::parent() const
2632 {
2633         return d->parent();
2634 }
2635
2636
2637 ListOfBuffers Buffer::allRelatives() const
2638 {
2639         ListOfBuffers lb = masterBuffer()->getDescendents();
2640         lb.push_front(const_cast<Buffer *>(masterBuffer()));
2641         return lb;
2642 }
2643
2644
2645 Buffer const * Buffer::masterBuffer() const
2646 {
2647         // FIXME Should be make sure we are not in some kind
2648         // of recursive include? A -> B -> A will crash this.
2649         Buffer const * const pbuf = d->parent();
2650         if (!pbuf)
2651                 return this;
2652
2653         return pbuf->masterBuffer();
2654 }
2655
2656
2657 bool Buffer::isChild(Buffer * child) const
2658 {
2659         return d->children_positions.find(child) != d->children_positions.end();
2660 }
2661
2662
2663 DocIterator Buffer::firstChildPosition(Buffer const * child)
2664 {
2665         Impl::BufferPositionMap::iterator it;
2666         it = d->children_positions.find(child);
2667         if (it == d->children_positions.end())
2668                 return DocIterator(this);
2669         return it->second;
2670 }
2671
2672
2673 bool Buffer::hasChildren() const
2674 {
2675         return !d->children_positions.empty();
2676 }
2677
2678
2679 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
2680 {
2681         // loop over children
2682         Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2683         Impl::BufferPositionMap::iterator end = d->children_positions.end();
2684         for (; it != end; ++it) {
2685                 Buffer * child = const_cast<Buffer *>(it->first);
2686                 // No duplicates
2687                 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
2688                 if (bit != clist.end())
2689                         continue;
2690                 clist.push_back(child);
2691                 if (grand_children)
2692                         // there might be grandchildren
2693                         child->collectChildren(clist, true);
2694         }
2695 }
2696
2697
2698 ListOfBuffers Buffer::getChildren() const
2699 {
2700         ListOfBuffers v;
2701         collectChildren(v, false);
2702         // Make sure we have not included ourselves.
2703         ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
2704         if (bit != v.end()) {
2705                 LYXERR0("Recursive include detected in `" << fileName() << "'.");
2706                 v.erase(bit);
2707         }
2708         return v;
2709 }
2710
2711
2712 ListOfBuffers Buffer::getDescendents() const
2713 {
2714         ListOfBuffers v;
2715         collectChildren(v, true);
2716         // Make sure we have not included ourselves.
2717         ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
2718         if (bit != v.end()) {
2719                 LYXERR0("Recursive include detected in `" << fileName() << "'.");
2720                 v.erase(bit);
2721         }
2722         return v;
2723 }
2724
2725
2726 template<typename M>
2727 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
2728 {
2729         if (m.empty())
2730                 return m.end();
2731
2732         typename M::const_iterator it = m.lower_bound(x);
2733         if (it == m.begin())
2734                 return m.end();
2735
2736         it--;
2737         return it;
2738 }
2739
2740
2741 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
2742                                          DocIterator const & pos) const
2743 {
2744         LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
2745
2746         // if paragraphs have no macro context set, pos will be empty
2747         if (pos.empty())
2748                 return 0;
2749
2750         // we haven't found anything yet
2751         DocIterator bestPos = owner_->par_iterator_begin();
2752         MacroData const * bestData = 0;
2753
2754         // find macro definitions for name
2755         NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
2756         if (nameIt != macros.end()) {
2757                 // find last definition in front of pos or at pos itself
2758                 PositionScopeMacroMap::const_iterator it
2759                         = greatest_below(nameIt->second, pos);
2760                 if (it != nameIt->second.end()) {
2761                         while (true) {
2762                                 // scope ends behind pos?
2763                                 if (pos < it->second.first) {
2764                                         // Looks good, remember this. If there
2765                                         // is no external macro behind this,
2766                                         // we found the right one already.
2767                                         bestPos = it->first;
2768                                         bestData = &it->second.second;
2769                                         break;
2770                                 }
2771
2772                                 // try previous macro if there is one
2773                                 if (it == nameIt->second.begin())
2774                                         break;
2775                                 it--;
2776                         }
2777                 }
2778         }
2779
2780         // find macros in included files
2781         PositionScopeBufferMap::const_iterator it
2782                 = greatest_below(position_to_children, pos);
2783         if (it == position_to_children.end())
2784                 // no children before
2785                 return bestData;
2786
2787         while (true) {
2788                 // do we know something better (i.e. later) already?
2789                 if (it->first < bestPos )
2790                         break;
2791
2792                 // scope ends behind pos?
2793                 if (pos < it->second.first
2794                         && (cloned_buffer_ ||
2795                             theBufferList().isLoaded(it->second.second))) {
2796                         // look for macro in external file
2797                         macro_lock = true;
2798                         MacroData const * data
2799                                 = it->second.second->getMacro(name, false);
2800                         macro_lock = false;
2801                         if (data) {
2802                                 bestPos = it->first;
2803                                 bestData = data;
2804                                 break;
2805                         }
2806                 }
2807
2808                 // try previous file if there is one
2809                 if (it == position_to_children.begin())
2810                         break;
2811                 --it;
2812         }
2813
2814         // return the best macro we have found
2815         return bestData;
2816 }
2817
2818
2819 MacroData const * Buffer::getMacro(docstring const & name,
2820         DocIterator const & pos, bool global) const
2821 {
2822         if (d->macro_lock)
2823                 return 0;
2824
2825         // query buffer macros
2826         MacroData const * data = d->getBufferMacro(name, pos);
2827         if (data != 0)
2828                 return data;
2829
2830         // If there is a master buffer, query that
2831         Buffer const * const pbuf = d->parent();
2832         if (pbuf) {
2833                 d->macro_lock = true;
2834                 MacroData const * macro = pbuf->getMacro(
2835                         name, *this, false);
2836                 d->macro_lock = false;
2837                 if (macro)
2838                         return macro;
2839         }
2840
2841         if (global) {
2842                 data = MacroTable::globalMacros().get(name);
2843                 if (data != 0)
2844                         return data;
2845         }
2846
2847         return 0;
2848 }
2849
2850
2851 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
2852 {
2853         // set scope end behind the last paragraph
2854         DocIterator scope = par_iterator_begin();
2855         scope.pit() = scope.lastpit() + 1;
2856
2857         return getMacro(name, scope, global);
2858 }
2859
2860
2861 MacroData const * Buffer::getMacro(docstring const & name,
2862         Buffer const & child, bool global) const
2863 {
2864         // look where the child buffer is included first
2865         Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
2866         if (it == d->children_positions.end())
2867                 return 0;
2868
2869         // check for macros at the inclusion position
2870         return getMacro(name, it->second, global);
2871 }
2872
2873
2874 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
2875 {
2876         pit_type const lastpit = it.lastpit();
2877
2878         // look for macros in each paragraph
2879         while (it.pit() <= lastpit) {
2880                 Paragraph & par = it.paragraph();
2881
2882                 // iterate over the insets of the current paragraph
2883                 InsetList const & insets = par.insetList();
2884                 InsetList::const_iterator iit = insets.begin();
2885                 InsetList::const_iterator end = insets.end();
2886                 for (; iit != end; ++iit) {
2887                         it.pos() = iit->pos;
2888
2889                         // is it a nested text inset?
2890                         if (iit->inset->asInsetText()) {
2891                                 // Inset needs its own scope?
2892                                 InsetText const * itext = iit->inset->asInsetText();
2893                                 bool newScope = itext->isMacroScope();
2894
2895                                 // scope which ends just behind the inset
2896                                 DocIterator insetScope = it;
2897                                 ++insetScope.pos();
2898
2899                                 // collect macros in inset
2900                                 it.push_back(CursorSlice(*iit->inset));
2901                                 updateMacros(it, newScope ? insetScope : scope);
2902                                 it.pop_back();
2903                                 continue;
2904                         }
2905
2906                         if (iit->inset->asInsetTabular()) {
2907                                 CursorSlice slice(*iit->inset);
2908                                 size_t const numcells = slice.nargs();
2909                                 for (; slice.idx() < numcells; slice.forwardIdx()) {
2910                                         it.push_back(slice);
2911                                         updateMacros(it, scope);
2912                                         it.pop_back();
2913                                 }
2914                                 continue;
2915                         }
2916
2917                         // is it an external file?
2918                         if (iit->inset->lyxCode() == INCLUDE_CODE) {
2919                                 // get buffer of external file
2920                                 InsetInclude const & inset =
2921                                         static_cast<InsetInclude const &>(*iit->inset);
2922                                 macro_lock = true;
2923                                 Buffer * child = inset.getChildBuffer();
2924                                 macro_lock = false;
2925                                 if (!child)
2926                                         continue;
2927
2928                                 // register its position, but only when it is
2929                                 // included first in the buffer
2930                                 if (children_positions.find(child) ==
2931                                         children_positions.end())
2932                                                 children_positions[child] = it;
2933
2934                                 // register child with its scope
2935                                 position_to_children[it] = Impl::ScopeBuffer(scope, child);
2936                                 continue;
2937                         }
2938
2939                         InsetMath * im = iit->inset->asInsetMath();
2940                         if (doing_export && im)  {
2941                                 InsetMathHull * hull = im->asHullInset();
2942                                 if (hull)
2943                                         hull->recordLocation(it);
2944                         }
2945
2946                         if (iit->inset->lyxCode() != MATHMACRO_CODE)
2947                                 continue;
2948
2949                         // get macro data
2950                         MathMacroTemplate & macroTemplate =
2951                                 *iit->inset->asInsetMath()->asMacroTemplate();
2952                         MacroContext mc(owner_, it);
2953                         macroTemplate.updateToContext(mc);
2954
2955                         // valid?
2956                         bool valid = macroTemplate.validMacro();
2957                         // FIXME: Should be fixNameAndCheckIfValid() in fact,
2958                         // then the BufferView's cursor will be invalid in
2959                         // some cases which leads to crashes.
2960                         if (!valid)
2961                                 continue;
2962
2963                         // register macro
2964                         // FIXME (Abdel), I don't understandt why we pass 'it' here
2965                         // instead of 'macroTemplate' defined above... is this correct?
2966                         macros[macroTemplate.name()][it] =
2967                                 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
2968                 }
2969
2970                 // next paragraph
2971                 it.pit()++;
2972                 it.pos() = 0;
2973         }
2974 }
2975
2976
2977 void Buffer::updateMacros() const
2978 {
2979         if (d->macro_lock)
2980                 return;
2981
2982         LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
2983
2984         // start with empty table
2985         d->macros.clear();
2986         d->children_positions.clear();
2987         d->position_to_children.clear();
2988
2989         // Iterate over buffer, starting with first paragraph
2990         // The scope must be bigger than any lookup DocIterator
2991         // later. For the global lookup, lastpit+1 is used, hence
2992         // we use lastpit+2 here.
2993         DocIterator it = par_iterator_begin();
2994         DocIterator outerScope = it;
2995         outerScope.pit() = outerScope.lastpit() + 2;
2996         d->updateMacros(it, outerScope);
2997 }
2998
2999
3000 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3001 {
3002         InsetIterator it  = inset_iterator_begin(inset());
3003         InsetIterator const end = inset_iterator_end(inset());
3004         for (; it != end; ++it) {
3005                 if (it->lyxCode() == BRANCH_CODE) {
3006                         InsetBranch & br = static_cast<InsetBranch &>(*it);
3007                         docstring const name = br.branch();
3008                         if (!from_master && !params().branchlist().find(name))
3009                                 result.push_back(name);
3010                         else if (from_master && !masterBuffer()->params().branchlist().find(name))
3011                                 result.push_back(name);
3012                         continue;
3013                 }
3014                 if (it->lyxCode() == INCLUDE_CODE) {
3015                         // get buffer of external file
3016                         InsetInclude const & ins =
3017                                 static_cast<InsetInclude const &>(*it);
3018                         Buffer * child = ins.getChildBuffer();
3019                         if (!child)
3020                                 continue;
3021                         child->getUsedBranches(result, true);
3022                 }
3023         }
3024         // remove duplicates
3025         result.unique();
3026 }
3027
3028
3029 void Buffer::updateMacroInstances(UpdateType utype) const
3030 {
3031         LYXERR(Debug::MACROS, "updateMacroInstances for "
3032                 << d->filename.onlyFileName());
3033         DocIterator it = doc_iterator_begin(this);
3034         it.forwardInset();
3035         DocIterator const end = doc_iterator_end(this);
3036         for (; it != end; it.forwardInset()) {
3037                 // look for MathData cells in InsetMathNest insets
3038                 InsetMath * minset = it.nextInset()->asInsetMath();
3039                 if (!minset)
3040                         continue;
3041
3042                 // update macro in all cells of the InsetMathNest
3043                 DocIterator::idx_type n = minset->nargs();
3044                 MacroContext mc = MacroContext(this, it);
3045                 for (DocIterator::idx_type i = 0; i < n; ++i) {
3046                         MathData & data = minset->cell(i);
3047                         data.updateMacros(0, mc, utype);
3048                 }
3049         }
3050 }
3051
3052
3053 void Buffer::listMacroNames(MacroNameSet & macros) const
3054 {
3055         if (d->macro_lock)
3056                 return;
3057
3058         d->macro_lock = true;
3059
3060         // loop over macro names
3061         Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
3062         Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
3063         for (; nameIt != nameEnd; ++nameIt)
3064                 macros.insert(nameIt->first);
3065
3066         // loop over children
3067         Impl::BufferPositionMap::iterator it = d->children_positions.begin();
3068         Impl::BufferPositionMap::iterator end = d->children_positions.end();
3069         for (; it != end; ++it)
3070                 it->first->listMacroNames(macros);
3071
3072         // call parent
3073         Buffer const * const pbuf = d->parent();
3074         if (pbuf)
3075                 pbuf->listMacroNames(macros);
3076
3077         d->macro_lock = false;
3078 }
3079
3080
3081 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3082 {
3083         Buffer const * const pbuf = d->parent();
3084         if (!pbuf)
3085                 return;
3086
3087         MacroNameSet names;
3088         pbuf->listMacroNames(names);
3089
3090         // resolve macros
3091         MacroNameSet::iterator it = names.begin();
3092         MacroNameSet::iterator end = names.end();
3093         for (; it != end; ++it) {
3094                 // defined?
3095                 MacroData const * data =
3096                 pbuf->getMacro(*it, *this, false);
3097                 if (data) {
3098                         macros.insert(data);
3099
3100                         // we cannot access the original MathMacroTemplate anymore
3101                         // here to calls validate method. So we do its work here manually.
3102                         // FIXME: somehow make the template accessible here.
3103                         if (data->optionals() > 0)
3104                                 features.require("xargs");
3105                 }
3106         }
3107 }
3108
3109
3110 Buffer::References & Buffer::references(docstring const & label)
3111 {
3112         if (d->parent())
3113                 return const_cast<Buffer *>(masterBuffer())->references(label);
3114
3115         RefCache::iterator it = d->ref_cache_.find(label);
3116         if (it != d->ref_cache_.end())
3117                 return it->second.second;
3118
3119         static InsetLabel const * dummy_il = 0;
3120         static References const dummy_refs;
3121         it = d->ref_cache_.insert(
3122                 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
3123         return it->second.second;
3124 }
3125
3126
3127 Buffer::References const & Buffer::references(docstring const & label) const
3128 {
3129         return const_cast<Buffer *>(this)->references(label);
3130 }
3131
3132
3133 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
3134 {
3135         masterBuffer()->d->ref_cache_[label].first = il;
3136 }
3137
3138
3139 InsetLabel const * Buffer::insetLabel(docstring const & label) const
3140 {
3141         return masterBuffer()->d->ref_cache_[label].first;
3142 }
3143
3144
3145 void Buffer::clearReferenceCache() const
3146 {
3147         if (!d->parent())
3148                 d->ref_cache_.clear();
3149 }
3150
3151
3152 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
3153         InsetCode code)
3154 {
3155         //FIXME: This does not work for child documents yet.
3156         LASSERT(code == CITE_CODE, /**/);
3157
3158         reloadBibInfoCache();
3159
3160         // Check if the label 'from' appears more than once
3161         BiblioInfo const & keys = masterBibInfo();
3162         BiblioInfo::const_iterator bit  = keys.begin();
3163         BiblioInfo::const_iterator bend = keys.end();
3164         vector<docstring> labels;
3165
3166         for (; bit != bend; ++bit)
3167                 // FIXME UNICODE
3168                 labels.push_back(bit->first);
3169
3170         if (count(labels.begin(), labels.end(), from) > 1)
3171                 return;
3172
3173         string const paramName = "key";
3174         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
3175                 if (it->lyxCode() == code) {
3176                         InsetCommand * inset = it->asInsetCommand();
3177                         if (!inset)
3178                                 continue;
3179                         docstring const oldValue = inset->getParam(paramName);
3180                         if (oldValue == from)
3181                                 inset->setParam(paramName, to);
3182                 }
3183         }
3184 }
3185
3186
3187 void Buffer::getSourceCode(odocstream & os, string const format,
3188                            pit_type par_begin, pit_type par_end,
3189                            OutputWhat output) const
3190 {
3191         OutputParams runparams(&params().encoding());
3192         runparams.nice = true;
3193         runparams.flavor = params().getOutputFlavor(format);
3194         runparams.linelen = lyxrc.plaintext_linelen;
3195         // No side effect of file copying and image conversion
3196         runparams.dryrun = true;
3197
3198         if (output == CurrentParagraph) {
3199                 runparams.par_begin = par_begin;
3200                 runparams.par_end = par_end;
3201                 if (par_begin + 1 == par_end) {
3202                         os << "% "
3203                            << bformat(_("Preview source code for paragraph %1$d"), par_begin)
3204                            << "\n\n";
3205                 } else {
3206                         os << "% "
3207                            << bformat(_("Preview source code from paragraph %1$s to %2$s"),
3208                                         convert<docstring>(par_begin),
3209                                         convert<docstring>(par_end - 1))
3210                            << "\n\n";
3211                 }
3212                 TexRow texrow;
3213                 texrow.reset();
3214                 texrow.newline();
3215                 texrow.newline();
3216                 // output paragraphs
3217                 if (params().isDocBook())
3218                         docbookParagraphs(text(), *this, os, runparams);
3219                 else if (runparams.flavor == OutputParams::HTML) {
3220                         XHTMLStream xs(os);
3221                         xhtmlParagraphs(text(), *this, xs, runparams);
3222                 } else {
3223                         // latex or literate
3224                         otexstream ots(os, texrow);
3225                         latexParagraphs(*this, text(), ots, runparams);
3226                 }
3227         } else {
3228                 os << "% ";
3229                 if (output == FullSource)
3230                         os << _("Preview source code");
3231                 else if (output == OnlyPreamble)
3232                         os << _("Preview preamble");
3233                 else if (output == OnlyBody)
3234                         os << _("Preview body");
3235                 os << "\n\n";
3236                 d->texrow.reset();
3237                 d->texrow.newline();
3238                 d->texrow.newline();
3239                 if (params().isDocBook())
3240                         writeDocBookSource(os, absFileName(), runparams, output);
3241                 else if (runparams.flavor == OutputParams::HTML)
3242                         writeLyXHTMLSource(os, runparams, output);
3243                 else {
3244                         // latex or literate
3245                         otexstream ots(os, d->texrow);
3246                         writeLaTeXSource(ots, string(), runparams, output);
3247                 }
3248         }
3249 }
3250
3251
3252 ErrorList & Buffer::errorList(string const & type) const
3253 {
3254         return d->errorLists[type];
3255 }
3256
3257
3258 void Buffer::updateTocItem(std::string const & type,
3259         DocIterator const & dit) const
3260 {
3261         if (d->gui_)
3262                 d->gui_->updateTocItem(type, dit);
3263 }
3264
3265
3266 void Buffer::structureChanged() const
3267 {
3268         if (d->gui_)
3269                 d->gui_->structureChanged();
3270 }
3271
3272
3273 void Buffer::errors(string const & err, bool from_master) const
3274 {
3275         if (d->gui_)
3276                 d->gui_->errors(err, from_master);
3277 }
3278
3279
3280 void Buffer::message(docstring const & msg) const
3281 {
3282         if (d->gui_)
3283                 d->gui_->message(msg);
3284 }
3285
3286
3287 void Buffer::setBusy(bool on) const
3288 {
3289         if (d->gui_)
3290                 d->gui_->setBusy(on);
3291 }
3292
3293
3294 void Buffer::updateTitles() const
3295 {
3296         if (d->wa_)
3297                 d->wa_->updateTitles();
3298 }
3299
3300
3301 void Buffer::resetAutosaveTimers() const
3302 {
3303         if (d->gui_)
3304                 d->gui_->resetAutosaveTimers();
3305 }
3306
3307
3308 bool Buffer::hasGuiDelegate() const
3309 {
3310         return d->gui_;
3311 }
3312
3313
3314 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
3315 {
3316         d->gui_ = gui;
3317 }
3318
3319
3320
3321 namespace {
3322
3323 class AutoSaveBuffer : public ForkedProcess {
3324 public:
3325         ///
3326         AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
3327                 : buffer_(buffer), fname_(fname) {}
3328         ///
3329         virtual shared_ptr<ForkedProcess> clone() const
3330         {
3331                 return shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
3332         }
3333         ///
3334         int start()
3335         {
3336                 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
3337                                                  from_utf8(fname_.absFileName())));
3338                 return run(DontWait);
3339         }
3340 private:
3341         ///
3342         virtual int generateChild();
3343         ///
3344         Buffer const & buffer_;
3345         FileName fname_;
3346 };
3347
3348
3349 int AutoSaveBuffer::generateChild()
3350 {
3351 #if defined(__APPLE__)
3352         /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
3353          *   We should use something else like threads.
3354          *
3355          * Since I do not know how to determine at run time what is the OS X
3356          * version, I just disable forking altogether for now (JMarc)
3357          */
3358         pid_t const pid = -1;
3359 #else
3360         // tmp_ret will be located (usually) in /tmp
3361         // will that be a problem?
3362         // Note that this calls ForkedCalls::fork(), so it's
3363         // ok cross-platform.
3364         pid_t const pid = fork();
3365         // If you want to debug the autosave
3366         // you should set pid to -1, and comment out the fork.
3367         if (pid != 0 && pid != -1)
3368                 return pid;
3369 #endif
3370
3371         // pid = -1 signifies that lyx was unable
3372         // to fork. But we will do the save
3373         // anyway.
3374         bool failed = false;
3375         FileName const tmp_ret = FileName::tempName("lyxauto");
3376         if (!tmp_ret.empty()) {
3377                 buffer_.writeFile(tmp_ret);
3378                 // assume successful write of tmp_ret
3379                 if (!tmp_ret.moveTo(fname_))
3380                         failed = true;
3381         } else
3382                 failed = true;
3383
3384         if (failed) {
3385                 // failed to write/rename tmp_ret so try writing direct
3386                 if (!buffer_.writeFile(fname_)) {
3387                         // It is dangerous to do this in the child,
3388                         // but safe in the parent, so...
3389                         if (pid == -1) // emit message signal.
3390                                 buffer_.message(_("Autosave failed!"));
3391                 }
3392         }
3393
3394         if (pid == 0) // we are the child so...
3395                 _exit(0);
3396
3397         return pid;
3398 }
3399
3400 } // namespace anon
3401
3402
3403 FileName Buffer::getEmergencyFileName() const
3404 {
3405         return FileName(d->filename.absFileName() + ".emergency");
3406 }
3407
3408
3409 FileName Buffer::getAutosaveFileName() const
3410 {
3411         // if the document is unnamed try to save in the backup dir, else
3412         // in the default document path, and as a last try in the filePath,
3413         // which will most often be the temporary directory
3414         string fpath;
3415         if (isUnnamed())
3416                 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
3417                         : lyxrc.backupdir_path;
3418         if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
3419                 fpath = filePath();
3420
3421         string const fname = "#" + d->filename.onlyFileName() + "#";
3422
3423         return makeAbsPath(fname, fpath);
3424 }
3425
3426
3427 void Buffer::removeAutosaveFile() const
3428 {
3429         FileName const f = getAutosaveFileName();
3430         if (f.exists())
3431                 f.removeFile();
3432 }
3433
3434
3435 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
3436 {
3437         FileName const newauto = getAutosaveFileName();
3438         oldauto.refresh();
3439         if (newauto != oldauto && oldauto.exists())
3440                 if (!oldauto.moveTo(newauto))
3441                         LYXERR0("Unable to move autosave file `" << oldauto << "'!");
3442 }
3443
3444
3445 bool Buffer::autoSave() const
3446 {
3447         Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
3448         if (buf->d->bak_clean || isReadonly())
3449                 return true;
3450
3451         message(_("Autosaving current document..."));
3452         buf->d->bak_clean = true;
3453
3454         FileName const fname = getAutosaveFileName();
3455         if (d->cloned_buffer_) {
3456                 // If this buffer is cloned, we assume that
3457                 // we are running in a separate thread already.
3458                 FileName const tmp_ret = FileName::tempName("lyxauto");
3459                 if (!tmp_ret.empty()) {
3460                         writeFile(tmp_ret);
3461                         // assume successful write of tmp_ret
3462                         if (tmp_ret.moveTo(fname))
3463                                 return true;
3464                 }
3465                 // failed to write/rename tmp_ret so try writing direct
3466                 return writeFile(fname);
3467         } else {
3468                 /// This function is deprecated as the frontend needs to take care
3469                 /// of cloning the buffer and autosaving it in another thread. It
3470                 /// is still here to allow (QT_VERSION < 0x040400).
3471                 AutoSaveBuffer autosave(*this, fname);
3472                 autosave.start();
3473                 return true;
3474         }
3475 }
3476
3477
3478 namespace {
3479         // helper class, to guarantee this gets reset properly
3480         class MarkAsExporting   {
3481         public:
3482                 MarkAsExporting(Buffer const * buf) : buf_(buf)
3483                 {
3484                         LASSERT(buf_, /* */);
3485                         buf_->setExportStatus(true);
3486                 }
3487                 ~MarkAsExporting()
3488                 {
3489                         buf_->setExportStatus(false);
3490                 }
3491         private:
3492                 Buffer const * const buf_;
3493         };
3494 }
3495
3496
3497 void Buffer::setExportStatus(bool e) const
3498 {
3499         d->doing_export = e;
3500         ListOfBuffers clist = getDescendents();
3501         ListOfBuffers::const_iterator cit = clist.begin();
3502         ListOfBuffers::const_iterator const cen = clist.end();
3503         for (; cit != cen; ++cit)
3504                 (*cit)->d->doing_export = e;
3505 }
3506
3507
3508 bool Buffer::isExporting() const
3509 {
3510         return d->doing_export;
3511 }
3512
3513
3514 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
3515         const
3516 {
3517         string result_file;
3518         return doExport(target, put_in_tempdir, result_file);
3519 }
3520
3521 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
3522         string & result_file) const
3523 {
3524         bool const update_unincluded =
3525                         params().maintain_unincluded_children
3526                         && !params().getIncludedChildren().empty();
3527
3528         // (1) export with all included children (omit \includeonly)
3529         if (update_unincluded) {
3530                 ExportStatus const status =
3531                         doExport(target, put_in_tempdir, true, result_file);
3532                 if (status != ExportSuccess)
3533                         return status;
3534         }
3535         // (2) export with included children only
3536         return doExport(target, put_in_tempdir, false, result_file);
3537 }
3538
3539
3540 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
3541         bool includeall, string & result_file) const
3542 {
3543         LYXERR(Debug::FILES, "target=" << target);
3544         OutputParams runparams(&params().encoding());
3545         string format = target;
3546         string dest_filename;
3547         size_t pos = target.find(' ');
3548         if (pos != string::npos) {
3549                 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
3550                 format = target.substr(0, pos);
3551                 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
3552                 FileName(dest_filename).onlyPath().createPath();
3553                 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
3554         }
3555         MarkAsExporting exporting(this);
3556         string backend_format;
3557         runparams.flavor = OutputParams::LATEX;
3558         runparams.linelen = lyxrc.plaintext_linelen;
3559         runparams.includeall = includeall;
3560         vector<string> backs = params().backends();
3561         Converters converters = theConverters();
3562         if (find(backs.begin(), backs.end(), format) == backs.end()) {
3563                 // Get shortest path to format
3564                 converters.buildGraph();
3565                 Graph::EdgePath path;
3566                 for (vector<string>::const_iterator it = backs.begin();
3567                      it != backs.end(); ++it) {
3568                         Graph::EdgePath p = converters.getPath(*it, format);
3569                         if (!p.empty() && (path.empty() || p.size() < path.size())) {
3570                                 backend_format = *it;
3571                                 path = p;
3572                         }
3573                 }
3574                 if (path.empty()) {
3575                         if (!put_in_tempdir) {
3576                                 // Only show this alert if this is an export to a non-temporary
3577                                 // file (not for previewing).
3578                                 Alert::error(_("Couldn't export file"), bformat(
3579                                         _("No information for exporting the format %1$s."),
3580                                         formats.prettyName(format)));
3581                         }
3582                         return ExportNoPathToFormat;
3583                 }
3584                 runparams.flavor = converters.getFlavor(path);
3585
3586         } else {
3587                 backend_format = format;
3588                 LYXERR(Debug::FILES, "backend_format=" << backend_format);
3589                 // FIXME: Don't hardcode format names here, but use a flag
3590                 if (backend_format == "pdflatex")
3591                         runparams.flavor = OutputParams::PDFLATEX;
3592                 else if (backend_format == "luatex")
3593                         runparams.flavor = OutputParams::LUATEX;
3594                 else if (backend_format == "dviluatex")
3595                         runparams.flavor = OutputParams::DVILUATEX;
3596                 else if (backend_format == "xetex")
3597                         runparams.flavor = OutputParams::XETEX;
3598         }
3599
3600         string filename = latexName(false);
3601         filename = addName(temppath(), filename);
3602         filename = changeExtension(filename,
3603                                    formats.extension(backend_format));
3604         LYXERR(Debug::FILES, "filename=" << filename);
3605
3606         // Plain text backend
3607         if (backend_format == "text") {
3608                 runparams.flavor = OutputParams::TEXT;
3609                 writePlaintextFile(*this, FileName(filename), runparams);
3610         }
3611         // HTML backend
3612         else if (backend_format == "xhtml") {
3613                 runparams.flavor = OutputParams::HTML;
3614                 switch (params().html_math_output) {
3615                 case BufferParams::MathML:
3616                         runparams.math_flavor = OutputParams::MathAsMathML;
3617                         break;
3618                 case BufferParams::HTML:
3619                         runparams.math_flavor = OutputParams::MathAsHTML;
3620                         break;
3621                 case BufferParams::Images:
3622                         runparams.math_flavor = OutputParams::MathAsImages;
3623                         break;
3624                 case BufferParams::LaTeX:
3625                         runparams.math_flavor = OutputParams::MathAsLaTeX;
3626                         break;
3627                 }
3628                 makeLyXHTMLFile(FileName(filename), runparams);
3629         } else if (backend_format == "lyx")
3630                 writeFile(FileName(filename));
3631         // Docbook backend
3632         else if (params().isDocBook()) {
3633                 runparams.nice = !put_in_tempdir;
3634                 makeDocBookFile(FileName(filename), runparams);
3635         }
3636         // LaTeX backend
3637         else if (backend_format == format) {
3638                 runparams.nice = true;
3639                 if (!makeLaTeXFile(FileName(filename), string(), runparams)) {
3640                         if (d->cloned_buffer_) {
3641                                 d->cloned_buffer_->d->errorLists["Export"] =
3642                                         d->errorLists["Export"];
3643                         }
3644                         return ExportError;
3645                 }
3646         } else if (!lyxrc.tex_allows_spaces
3647                    && contains(filePath(), ' ')) {
3648                 Alert::error(_("File name error"),
3649                            _("The directory path to the document cannot contain spaces."));
3650                 return ExportTexPathHasSpaces;
3651         } else {
3652                 runparams.nice = false;
3653                 if (!makeLaTeXFile(FileName(filename), filePath(), runparams)) {
3654                         if (d->cloned_buffer_) {
3655                                 d->cloned_buffer_->d->errorLists["Export"] =
3656                                         d->errorLists["Export"];
3657                         }
3658                         return ExportError;
3659                 }
3660         }
3661
3662         string const error_type = (format == "program")
3663                 ? "Build" : params().bufferFormat();
3664         ErrorList & error_list = d->errorLists[error_type];
3665         string const ext = formats.extension(format);
3666         FileName const tmp_result_file(changeExtension(filename, ext));
3667         bool const success = converters.convert(this, FileName(filename),
3668                 tmp_result_file, FileName(absFileName()), backend_format, format,
3669                 error_list);
3670
3671         // Emit the signal to show the error list or copy it back to the
3672         // cloned Buffer so that it can be emitted afterwards.
3673         if (format != backend_format) {
3674                 if (d->cloned_buffer_) {
3675                         d->cloned_buffer_->d->errorLists[error_type] =
3676                                 d->errorLists[error_type];
3677                 } else
3678                         errors(error_type);
3679                 // also to the children, in case of master-buffer-view
3680                 ListOfBuffers clist = getDescendents();
3681                 ListOfBuffers::const_iterator cit = clist.begin();
3682                 ListOfBuffers::const_iterator const cen = clist.end();
3683                 for (; cit != cen; ++cit) {
3684                         if (d->cloned_buffer_) {
3685                                 // Enable reverse search by copying back the
3686                                 // texrow object to the cloned buffer.
3687                                 // FIXME: this is not thread safe.
3688                                 (*cit)->d->cloned_buffer_->d->texrow = (*cit)->d->texrow;
3689                                 (*cit)->d->cloned_buffer_->d->errorLists[error_type] =
3690                                         (*cit)->d->errorLists[error_type];
3691                         } else
3692                                 (*cit)->errors(error_type, true);
3693                 }
3694         }
3695
3696         if (d->cloned_buffer_) {
3697                 // Enable reverse dvi or pdf to work by copying back the texrow
3698                 // object to the cloned buffer.
3699                 // FIXME: There is a possibility of concurrent access to texrow
3700                 // here from the main GUI thread that should be securized.
3701                 d->cloned_buffer_->d->texrow = d->texrow;
3702                 string const error_type = params().bufferFormat();
3703                 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[error_type];
3704         }
3705
3706         if (!success)
3707                 return ExportConverterError;
3708
3709         if (put_in_tempdir) {
3710                 result_file = tmp_result_file.absFileName();
3711                 return ExportSuccess;
3712         }
3713
3714         if (dest_filename.empty())
3715                 result_file = changeExtension(d->exportFileName().absFileName(), ext);
3716         else
3717                 result_file = dest_filename;
3718         // We need to copy referenced files (e. g. included graphics
3719         // if format == "dvi") to the result dir.
3720         vector<ExportedFile> const files =
3721                 runparams.exportdata->externalFiles(format);
3722         string const dest = runparams.export_folder.empty() ?
3723                 onlyPath(result_file) : runparams.export_folder;
3724         bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
3725                                  : force_overwrite == ALL_FILES;
3726         CopyStatus status = use_force ? FORCE : SUCCESS;
3727
3728         vector<ExportedFile>::const_iterator it = files.begin();
3729         vector<ExportedFile>::const_iterator const en = files.end();
3730         for (; it != en && status != CANCEL; ++it) {
3731                 string const fmt = formats.getFormatFromFile(it->sourceName);
3732                 string fixedName = it->exportName;
3733                 if (!runparams.export_folder.empty()) {
3734                         // Relative pathnames starting with ../ will be sanitized
3735                         // if exporting to a different folder
3736                         while (fixedName.substr(0, 3) == "../")
3737                                 fixedName = fixedName.substr(3, fixedName.length() - 3);
3738                 }
3739                 FileName fixedFileName = makeAbsPath(fixedName, dest);
3740                 fixedFileName.onlyPath().createPath();
3741                 status = copyFile(fmt, it->sourceName,
3742                         fixedFileName,
3743                         it->exportName, status == FORCE,
3744                         runparams.export_folder.empty());
3745         }
3746
3747         if (status == CANCEL) {
3748                 message(_("Document export cancelled."));
3749         } else if (tmp_result_file.exists()) {
3750                 // Finally copy the main file
3751                 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
3752                                     : force_overwrite != NO_FILES;
3753                 if (status == SUCCESS && use_force)
3754                         status = FORCE;
3755                 status = copyFile(format, tmp_result_file,
3756                         FileName(result_file), result_file,
3757                         status == FORCE);
3758                 message(bformat(_("Document exported as %1$s "
3759                         "to file `%2$s'"),
3760                         formats.prettyName(format),
3761                         makeDisplayPath(result_file)));
3762         } else {
3763                 // This must be a dummy converter like fax (bug 1888)
3764                 message(bformat(_("Document exported as %1$s"),
3765                         formats.prettyName(format)));
3766         }
3767
3768         return ExportSuccess;
3769 }
3770
3771
3772 Buffer::ExportStatus Buffer::preview(string const & format) const
3773 {
3774         bool const update_unincluded =
3775                         params().maintain_unincluded_children
3776                         && !params().getIncludedChildren().empty();
3777         return preview(format, update_unincluded);
3778 }
3779
3780 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
3781 {
3782         MarkAsExporting exporting(this);
3783         string result_file;
3784         // (1) export with all included children (omit \includeonly)
3785         if (includeall) {
3786                 ExportStatus const status = doExport(format, true, true, result_file);
3787                 if (status != ExportSuccess)
3788                         return status;
3789         }
3790         // (2) export with included children only
3791         ExportStatus const status = doExport(format, true, false, result_file);
3792         if (status != ExportSuccess)
3793                 return status;
3794         if (!formats.view(*this, FileName(result_file), format))
3795                 return PreviewError;
3796         return PreviewSuccess;
3797 }
3798
3799
3800 Buffer::ReadStatus Buffer::extractFromVC()
3801 {
3802         bool const found = LyXVC::file_not_found_hook(d->filename);
3803         if (!found)
3804                 return ReadFileNotFound;
3805         if (!d->filename.isReadableFile())
3806                 return ReadVCError;
3807         return ReadSuccess;
3808 }
3809
3810
3811 Buffer::ReadStatus Buffer::loadEmergency()
3812 {
3813         FileName const emergencyFile = getEmergencyFileName();
3814         if (!emergencyFile.exists()
3815                   || emergencyFile.lastModified() <= d->filename.lastModified())
3816                 return ReadFileNotFound;
3817
3818         docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
3819         docstring const text = bformat(_("An emergency save of the document "
3820                 "%1$s exists.\n\nRecover emergency save?"), file);
3821
3822         int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
3823                 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
3824
3825         switch (load_emerg)
3826         {
3827         case 0: {
3828                 docstring str;
3829                 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
3830                 bool const success = (ret_llf == ReadSuccess);
3831                 if (success) {
3832                         if (isReadonly()) {
3833                                 Alert::warning(_("File is read-only"),
3834                                         bformat(_("An emergency file is successfully loaded, "
3835                                         "but the original file %1$s is marked read-only. "
3836                                         "Please make sure to save the document as a different "
3837                                         "file."), from_utf8(d->filename.absFileName())));
3838                         }
3839                         markDirty();
3840                         str = _("Document was successfully recovered.");
3841                 } else
3842                         str = _("Document was NOT successfully recovered.");
3843                 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
3844                         makeDisplayPath(emergencyFile.absFileName()));
3845
3846                 int const del_emerg =
3847                         Alert::prompt(_("Delete emergency file?"), str, 1, 1,
3848                                 _("&Remove"), _("&Keep"));
3849                 if (del_emerg == 0) {
3850                         emergencyFile.removeFile();
3851                         if (success)
3852                                 Alert::warning(_("Emergency file deleted"),
3853                                         _("Do not forget to save your file now!"), true);
3854                         }
3855                 return success ? ReadSuccess : ReadEmergencyFailure;
3856         }
3857         case 1: {
3858                 int const del_emerg =
3859                         Alert::prompt(_("Delete emergency file?"),
3860                                 _("Remove emergency file now?"), 1, 1,
3861                                 _("&Remove"), _("&Keep"));
3862                 if (del_emerg == 0)
3863                         emergencyFile.removeFile();
3864                 return ReadOriginal;
3865         }
3866
3867         default:
3868                 break;
3869         }
3870         return ReadCancel;
3871 }
3872
3873
3874 Buffer::ReadStatus Buffer::loadAutosave()
3875 {
3876         // Now check if autosave file is newer.
3877         FileName const autosaveFile = getAutosaveFileName();
3878         if (!autosaveFile.exists()
3879                   || autosaveFile.lastModified() <= d->filename.lastModified())
3880                 return ReadFileNotFound;
3881
3882         docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
3883         docstring const text = bformat(_("The backup of the document %1$s "
3884                 "is newer.\n\nLoad the backup instead?"), file);
3885         int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
3886                 _("&Load backup"), _("Load &original"), _("&Cancel"));
3887
3888         switch (ret)
3889         {
3890         case 0: {
3891                 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
3892                 // the file is not saved if we load the autosave file.
3893                 if (ret_llf == ReadSuccess) {
3894                         if (isReadonly()) {
3895                                 Alert::warning(_("File is read-only"),
3896                                         bformat(_("A backup file is successfully loaded, "
3897                                         "but the original file %1$s is marked read-only. "
3898                                         "Please make sure to save the document as a "
3899                                         "different file."),
3900                                         from_utf8(d->filename.absFileName())));
3901                         }
3902                         markDirty();
3903                         return ReadSuccess;
3904                 }
3905                 return ReadAutosaveFailure;
3906         }
3907         case 1:
3908                 // Here we delete the autosave
3909                 autosaveFile.removeFile();
3910                 return ReadOriginal;
3911         default:
3912                 break;
3913         }
3914         return ReadCancel;
3915 }
3916
3917
3918 Buffer::ReadStatus Buffer::loadLyXFile()
3919 {
3920         if (!d->filename.isReadableFile()) {
3921                 ReadStatus const ret_rvc = extractFromVC();
3922                 if (ret_rvc != ReadSuccess)
3923                         return ret_rvc;
3924         }
3925
3926         ReadStatus const ret_re = loadEmergency();
3927         if (ret_re == ReadSuccess || ret_re == ReadCancel)
3928                 return ret_re;
3929
3930         ReadStatus const ret_ra = loadAutosave();
3931         if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
3932                 return ret_ra;
3933
3934         return loadThisLyXFile(d->filename);
3935 }
3936
3937
3938 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
3939 {
3940         return readFile(fn);
3941 }
3942
3943
3944 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
3945 {
3946         TeXErrors::Errors::const_iterator it = terr.begin();
3947         TeXErrors::Errors::const_iterator end = terr.end();
3948         ListOfBuffers clist = getDescendents();
3949         ListOfBuffers::const_iterator cen = clist.end();
3950
3951         for (; it != end; ++it) {
3952                 int id_start = -1;
3953                 int pos_start = -1;
3954                 int errorRow = it->error_in_line;
3955                 Buffer const * buf = 0;
3956                 Impl const * p = d;
3957                 if (it->child_name.empty())
3958                     p->texrow.getIdFromRow(errorRow, id_start, pos_start);
3959                 else {
3960                         // The error occurred in a child
3961                         ListOfBuffers::const_iterator cit = clist.begin();
3962                         for (; cit != cen; ++cit) {
3963                                 string const child_name =
3964                                         DocFileName(changeExtension(
3965                                                 (*cit)->absFileName(), "tex")).
3966                                                         mangledFileName();
3967                                 if (it->child_name != child_name)
3968                                         continue;
3969                                 (*cit)->d->texrow.getIdFromRow(errorRow,
3970                                                         id_start, pos_start);
3971                                 if (id_start != -1) {
3972                                         buf = d->cloned_buffer_
3973                                                 ? (*cit)->d->cloned_buffer_->d->owner_
3974                                                 : (*cit)->d->owner_;
3975                                         p = (*cit)->d;
3976                                         break;
3977                                 }
3978                         }
3979                 }
3980                 int id_end = -1;
3981                 int pos_end = -1;
3982                 bool found;
3983                 do {
3984                         ++errorRow;
3985                         found = p->texrow.getIdFromRow(errorRow, id_end, pos_end);
3986                 } while (found && id_start == id_end && pos_start == pos_end);
3987
3988                 if (id_start != id_end) {
3989                         // Next registered position is outside the inset where
3990                         // the error occurred, so signal end-of-paragraph
3991                         pos_end = 0;
3992                 }
3993
3994                 errorList.push_back(ErrorItem(it->error_desc,
3995                         it->error_text, id_start, pos_start, pos_end, buf));
3996         }
3997 }
3998
3999
4000 void Buffer::setBuffersForInsets() const
4001 {
4002         inset().setBuffer(const_cast<Buffer &>(*this));
4003 }
4004
4005
4006 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4007 {
4008         // Use the master text class also for child documents
4009         Buffer const * const master = masterBuffer();
4010         DocumentClass const & textclass = master->params().documentClass();
4011
4012         // do this only if we are the top-level Buffer
4013         if (master == this)
4014                 reloadBibInfoCache();
4015
4016         // keep the buffers to be children in this set. If the call from the
4017         // master comes back we can see which of them were actually seen (i.e.
4018         // via an InsetInclude). The remaining ones in the set need still be updated.
4019         static std::set<Buffer const *> bufToUpdate;
4020         if (scope == UpdateMaster) {
4021                 // If this is a child document start with the master
4022                 if (master != this) {
4023                         bufToUpdate.insert(this);
4024                         master->updateBuffer(UpdateMaster, utype);
4025                         // Do this here in case the master has no gui associated with it. Then,
4026                         // the TocModel is not updated and TocModel::toc_ is invalid (bug 5699).
4027                         if (!master->d->gui_)
4028                                 structureChanged();
4029
4030                         // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4031                         if (bufToUpdate.find(this) == bufToUpdate.end())
4032                                 return;
4033                 }
4034
4035                 // start over the counters in the master
4036                 textclass.counters().reset();
4037         }
4038
4039         // update will be done below for this buffer
4040         bufToUpdate.erase(this);
4041
4042         // update all caches
4043         clearReferenceCache();
4044         updateMacros();
4045
4046         Buffer & cbuf = const_cast<Buffer &>(*this);
4047
4048         LASSERT(!text().paragraphs().empty(), /**/);
4049
4050         // do the real work
4051         ParIterator parit = cbuf.par_iterator_begin();
4052         updateBuffer(parit, utype);
4053
4054         if (master != this)
4055                 // TocBackend update will be done later.
4056                 return;
4057
4058         d->bibinfo_cache_valid_ = true;
4059         d->cite_labels_valid_ = true;
4060         cbuf.tocBackend().update();
4061         if (scope == UpdateMaster)
4062                 cbuf.structureChanged();
4063 }
4064
4065
4066 static depth_type getDepth(DocIterator const & it)
4067 {
4068         depth_type depth = 0;
4069         for (size_t i = 0 ; i < it.depth() ; ++i)
4070                 if (!it[i].inset().inMathed())
4071                         depth += it[i].paragraph().getDepth() + 1;
4072         // remove 1 since the outer inset does not count
4073         return depth - 1;
4074 }
4075
4076 static depth_type getItemDepth(ParIterator const & it)
4077 {
4078         Paragraph const & par = *it;
4079         LabelType const labeltype = par.layout().labeltype;
4080
4081         if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
4082                 return 0;
4083
4084         // this will hold the lowest depth encountered up to now.
4085         depth_type min_depth = getDepth(it);
4086         ParIterator prev_it = it;
4087         while (true) {
4088                 if (prev_it.pit())
4089                         --prev_it.top().pit();
4090                 else {
4091                         // start of nested inset: go to outer par
4092                         prev_it.pop_back();
4093                         if (prev_it.empty()) {
4094                                 // start of document: nothing to do
4095                                 return 0;
4096                         }
4097                 }
4098
4099                 // We search for the first paragraph with same label
4100                 // that is not more deeply nested.
4101                 Paragraph & prev_par = *prev_it;
4102                 depth_type const prev_depth = getDepth(prev_it);
4103                 if (labeltype == prev_par.layout().labeltype) {
4104                         if (prev_depth < min_depth)
4105                                 return prev_par.itemdepth + 1;
4106                         if (prev_depth == min_depth)
4107                                 return prev_par.itemdepth;
4108                 }
4109                 min_depth = min(min_depth, prev_depth);
4110                 // small optimization: if we are at depth 0, we won't
4111                 // find anything else
4112                 if (prev_depth == 0)
4113                         return 0;
4114         }
4115 }
4116
4117
4118 static bool needEnumCounterReset(ParIterator const & it)
4119 {
4120         Paragraph const & par = *it;
4121         LASSERT(par.layout().labeltype == LABEL_ENUMERATE, /**/);
4122         depth_type const cur_depth = par.getDepth();
4123         ParIterator prev_it = it;
4124         while (prev_it.pit()) {
4125                 --prev_it.top().pit();
4126                 Paragraph const & prev_par = *prev_it;
4127                 if (prev_par.getDepth() <= cur_depth)
4128                         return  prev_par.layout().labeltype != LABEL_ENUMERATE;
4129         }
4130         // start of nested inset: reset
4131         return true;
4132 }
4133
4134
4135 // set the label of a paragraph. This includes the counters.
4136 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
4137 {
4138         BufferParams const & bp = owner_->masterBuffer()->params();
4139         DocumentClass const & textclass = bp.documentClass();
4140         Paragraph & par = it.paragraph();
4141         Layout const & layout = par.layout();
4142         Counters & counters = textclass.counters();
4143
4144         if (par.params().startOfAppendix()) {
4145                 // FIXME: only the counter corresponding to toplevel
4146                 // sectioning should be reset
4147                 counters.reset();
4148                 counters.appendix(true);
4149         }
4150         par.params().appendix(counters.appendix());
4151
4152         // Compute the item depth of the paragraph
4153         par.itemdepth = getItemDepth(it);
4154
4155         if (layout.margintype == MARGIN_MANUAL) {
4156                 if (par.params().labelWidthString().empty())
4157                         par.params().labelWidthString(par.expandLabel(layout, bp));
4158         } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
4159                 // we do not need to do anything here, since the empty case is
4160                 // handled during export.
4161         } else {
4162                 par.params().labelWidthString(docstring());
4163         }
4164
4165         switch(layout.labeltype) {
4166         case LABEL_COUNTER:
4167                 if (layout.toclevel <= bp.secnumdepth
4168                       && (layout.latextype != LATEX_ENVIRONMENT
4169                           || it.text()->isFirstInSequence(it.pit()))) {
4170                         if (counters.hasCounter(layout.counter))
4171                                 counters.step(layout.counter, utype);
4172                         par.params().labelString(par.expandLabel(layout, bp));
4173                 } else
4174                         par.params().labelString(docstring());
4175                 break;
4176
4177         case LABEL_ITEMIZE: {
4178                 // At some point of time we should do something more
4179                 // clever here, like:
4180                 //   par.params().labelString(
4181                 //    bp.user_defined_bullet(par.itemdepth).getText());
4182                 // for now, use a simple hardcoded label
4183                 docstring itemlabel;
4184                 switch (par.itemdepth) {
4185                 case 0:
4186                         itemlabel = char_type(0x2022);
4187                         break;
4188                 case 1:
4189                         itemlabel = char_type(0x2013);
4190                         break;
4191                 case 2:
4192                         itemlabel = char_type(0x2217);
4193                         break;
4194                 case 3:
4195                         itemlabel = char_type(0x2219); // or 0x00b7
4196                         break;
4197                 }
4198                 par.params().labelString(itemlabel);
4199                 break;
4200         }
4201
4202         case LABEL_ENUMERATE: {
4203                 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
4204
4205                 switch (par.itemdepth) {
4206                 case 2:
4207                         enumcounter += 'i';
4208                 case 1:
4209                         enumcounter += 'i';
4210                 case 0:
4211                         enumcounter += 'i';
4212                         break;
4213                 case 3:
4214                         enumcounter += "iv";
4215                         break;
4216                 default:
4217                         // not a valid enumdepth...
4218                         break;
4219                 }
4220
4221                 // Maybe we have to reset the enumeration counter.
4222                 if (needEnumCounterReset(it))
4223                         counters.reset(enumcounter);
4224                 counters.step(enumcounter, utype);
4225
4226                 string const & lang = par.getParLanguage(bp)->code();
4227                 par.params().labelString(counters.theCounter(enumcounter, lang));
4228
4229                 break;
4230         }
4231
4232         case LABEL_SENSITIVE: {
4233                 string const & type = counters.current_float();
4234                 docstring full_label;
4235                 if (type.empty())
4236                         full_label = owner_->B_("Senseless!!! ");
4237                 else {
4238                         docstring name = owner_->B_(textclass.floats().getType(type).name());
4239                         if (counters.hasCounter(from_utf8(type))) {
4240                                 string const & lang = par.getParLanguage(bp)->code();
4241                                 counters.step(from_utf8(type), utype);
4242                                 full_label = bformat(from_ascii("%1$s %2$s:"),
4243                                                      name,
4244                                                      counters.theCounter(from_utf8(type), lang));
4245                         } else
4246                                 full_label = bformat(from_ascii("%1$s #:"), name);
4247                 }
4248                 par.params().labelString(full_label);
4249                 break;
4250         }
4251
4252         case LABEL_NO_LABEL:
4253                 par.params().labelString(docstring());
4254                 break;
4255
4256         case LABEL_MANUAL:
4257         case LABEL_TOP_ENVIRONMENT:
4258         case LABEL_CENTERED_TOP_ENVIRONMENT:
4259         case LABEL_STATIC:
4260         case LABEL_BIBLIO:
4261                 par.params().labelString(par.expandLabel(layout, bp));
4262                 break;
4263         }
4264 }
4265
4266
4267 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
4268 {
4269         LASSERT(parit.pit() == 0, /**/);
4270
4271         // Set the position of the text in the buffer to be able
4272         // to resolve macros in it.
4273         parit.text()->setMacrocontextPosition(parit);
4274
4275         depth_type maxdepth = 0;
4276         pit_type const lastpit = parit.lastpit();
4277         for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
4278                 // reduce depth if necessary
4279                 parit->params().depth(min(parit->params().depth(), maxdepth));
4280                 maxdepth = parit->getMaxDepthAfter();
4281
4282                 if (utype == OutputUpdate) {
4283                         // track the active counters
4284                         // we have to do this for the master buffer, since the local
4285                         // buffer isn't tracking anything.
4286                         masterBuffer()->params().documentClass().counters().
4287                                         setActiveLayout(parit->layout());
4288                 }
4289
4290                 // set the counter for this paragraph
4291                 d->setLabel(parit, utype);
4292
4293                 // now the insets
4294                 InsetList::const_iterator iit = parit->insetList().begin();
4295                 InsetList::const_iterator end = parit->insetList().end();
4296                 for (; iit != end; ++iit) {
4297                         parit.pos() = iit->pos;
4298                         iit->inset->updateBuffer(parit, utype);
4299                 }
4300         }
4301 }
4302
4303
4304 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
4305         WordLangTuple & word_lang, docstring_list & suggestions) const
4306 {
4307         int progress = 0;
4308         WordLangTuple wl;
4309         suggestions.clear();
4310         word_lang = WordLangTuple();
4311         bool const to_end = to.empty();
4312         DocIterator const end = to_end ? doc_iterator_end(this) : to;
4313         // OK, we start from here.
4314         for (; from != end; from.forwardPos()) {
4315                 // We are only interested in text so remove the math CursorSlice.
4316                 while (from.inMathed()) {
4317                         from.pop_back();
4318                         from.pos()++;
4319                 }
4320                 // If from is at the end of the document (which is possible
4321                 // when leaving the mathed) LyX will crash later otherwise.
4322                 if (from.atEnd() || (!to_end && from >= end))
4323                         break;
4324                 to = from;
4325                 from.paragraph().spellCheck();
4326                 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
4327                 if (SpellChecker::misspelled(res)) {
4328                         word_lang = wl;
4329                         break;
4330                 }
4331
4332                 // Do not increase progress when from == to, otherwise the word
4333                 // count will be wrong.
4334                 if (from != to) {
4335                         from = to;
4336                         ++progress;
4337                 }
4338         }
4339         return progress;
4340 }
4341
4342
4343 Buffer::ReadStatus Buffer::reload()
4344 {
4345         setBusy(true);
4346         // c.f. bug http://www.lyx.org/trac/ticket/6587
4347         removeAutosaveFile();
4348         // e.g., read-only status could have changed due to version control
4349         d->filename.refresh();
4350         docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
4351
4352         ReadStatus const status = loadLyXFile();
4353         if (status == ReadSuccess) {
4354                 updateBuffer();
4355                 changed(true);
4356                 updateTitles();
4357                 markClean();
4358                 message(bformat(_("Document %1$s reloaded."), disp_fn));
4359                 d->undo_.clear();
4360         } else {
4361                 message(bformat(_("Could not reload document %1$s."), disp_fn));
4362         }
4363         setBusy(false);
4364         removePreviews();
4365         updatePreviews();
4366         errors("Parse");
4367         return status;
4368 }
4369
4370
4371 bool Buffer::saveAs(FileName const & fn)
4372 {
4373         FileName const old_name = fileName();
4374         FileName const old_auto = getAutosaveFileName();
4375         bool const old_unnamed = isUnnamed();
4376
4377         setFileName(fn);
4378         markDirty();
4379         setUnnamed(false);
4380
4381         if (save()) {
4382                 // bring the autosave file with us, just in case.
4383                 moveAutosaveFile(old_auto);
4384                 // validate version control data and
4385                 // correct buffer title
4386                 lyxvc().file_found_hook(fileName());
4387                 updateTitles();
4388                 // the file has now been saved to the new location.
4389                 // we need to check that the locations of child buffers
4390                 // are still valid.
4391                 checkChildBuffers();
4392                 return true;
4393         } else {
4394                 // save failed
4395                 // reset the old filename and unnamed state
4396                 setFileName(old_name);
4397                 setUnnamed(old_unnamed);
4398                 return false;
4399         }
4400 }
4401
4402
4403 // FIXME We could do better here, but it is complicated. What would be
4404 // nice is to offer either (a) to save the child buffer to an appropriate
4405 // location, so that it would "move with the master", or else (b) to update
4406 // the InsetInclude so that it pointed to the same file. But (a) is a bit
4407 // complicated, because the code for this lives in GuiView.
4408 void Buffer::checkChildBuffers()
4409 {
4410         Impl::BufferPositionMap::iterator it = d->children_positions.begin();
4411         Impl::BufferPositionMap::iterator const en = d->children_positions.end();
4412         for (; it != en; ++it) {
4413                 DocIterator dit = it->second;
4414                 Buffer * cbuf = const_cast<Buffer *>(it->first);
4415                 if (!cbuf || !theBufferList().isLoaded(cbuf))
4416                         continue;
4417                 Inset * inset = dit.nextInset();
4418                 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
4419                 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
4420                 docstring const & incfile = inset_inc->getParam("filename");
4421                 string oldloc = cbuf->absFileName();
4422                 string newloc = makeAbsPath(to_utf8(incfile),
4423                                 onlyPath(absFileName())).absFileName();
4424                 if (oldloc == newloc)
4425                         continue;
4426                 // the location of the child file is incorrect.
4427                 Alert::warning(_("Included File Invalid"),
4428                                 bformat(_("Saving this document to a new location has made the file:\n"
4429                                 "  %1$s\n"
4430                                 "inaccessible. You will need to update the included filename."),
4431                                 from_utf8(oldloc)));
4432                 cbuf->setParent(0);
4433                 inset_inc->setChildBuffer(0);
4434         }
4435         // invalidate cache of children
4436         d->children_positions.clear();
4437         d->position_to_children.clear();
4438 }
4439
4440 } // namespace lyx