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