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