src/Buffer.cpp

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