src/Buffer.cpp

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