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