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