src/Buffer.cpp

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