src/Buffer.cpp

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