src/Buffer.cpp

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