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