src/Buffer.cpp

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