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