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 "BiblioInfo.h"
  18 #include "BranchList.h"
  19 #include "buffer_funcs.h"
  20 #include "BufferList.h"
  21 #include "BufferParams.h"
  22 #include "Bullet.h"
  23 #include "Chktex.h"
  24 #include "Converter.h"
  25 #include "Counters.h"
  26 #include "DocIterator.h"
  27 #include "EmbeddedFiles.h"
  28 #include "Encoding.h"
  29 #include "ErrorList.h"
  30 #include "Exporter.h"
  31 #include "Format.h"
  32 #include "FuncRequest.h"
  33 #include "InsetIterator.h"
  34 #include "InsetList.h"
  35 #include "Language.h"
  36 #include "LaTeXFeatures.h"
  37 #include "LaTeX.h"
  38 #include "Layout.h"
  39 #include "Lexer.h"
  40 #include "LyXAction.h"
  41 #include "LyX.h"
  42 #include "LyXRC.h"
  43 #include "LyXVC.h"
  44 #include "output_docbook.h"
  45 #include "output.h"
  46 #include "output_latex.h"
  47 #include "output_plaintext.h"
  48 #include "paragraph_funcs.h"
  49 #include "Paragraph.h"
  50 #include "ParagraphParameters.h"
  51 #include "ParIterator.h"
  52 #include "PDFOptions.h"
  53 #include "Session.h"
  54 #include "sgml.h"
  55 #include "TexRow.h"
  56 #include "TexStream.h"
  57 #include "TextClassList.h"
  58 #include "Text.h"
  59 #include "TocBackend.h"
  60 #include "Undo.h"
  61 #include "VCBackend.h"
  62 #include "version.h"
  63
  64 #include "insets/InsetBibitem.h"
  65 #include "insets/InsetBibtex.h"
  66 #include "insets/InsetInclude.h"
  67 #include "insets/InsetText.h"
  68
  69 #include "mathed/MacroTable.h"
  70 #include "mathed/MathMacroTemplate.h"
  71 #include "mathed/MathSupport.h"
  72
  73 #include "frontends/alert.h"
  74 #include "frontends/Delegates.h"
  75 #include "frontends/WorkAreaManager.h"
  76
  77 #include "graphics/Previews.h"
  78
  79 #include "support/convert.h"
  80 #include "support/debug.h"
  81 #include "support/ExceptionMessage.h"
  82 #include "support/FileFilterList.h"
  83 #include "support/FileName.h"
  84 #include "support/FileNameList.h"
  85 #include "support/filetools.h"
  86 #include "support/ForkedCalls.h"
  87 #include "support/gettext.h"
  88 #include "support/gzstream.h"
  89 #include "support/lstrings.h"
  90 #include "support/lyxalgo.h"
  91 #include "support/os.h"
  92 #include "support/Package.h"
  93 #include "support/Path.h"
  94 #include "support/textutils.h"
  95 #include "support/types.h"
  96 #include "support/FileZipListDir.h"
  97
  98 #if !defined (HAVE_FORK)
  99 # define fork() -1
 100 #endif
 101
 102 #include <boost/bind.hpp>
 103 #include <boost/shared_ptr.hpp>
 104
 105 #include <algorithm>
 106 #include <iomanip>
 107 #include <stack>
 108 #include <sstream>
 109 #include <fstream>
 110
 111 using namespace std;
 112 using namespace lyx::support;
 113
 114 namespace lyx {
 115
 116 namespace Alert = frontend::Alert;
 117 namespace os = support::os;
 118
 119 namespace {
 120
 121 int const LYX_FORMAT = 311; // Richard Heck: a dummy format to drive the AMS conversion
 122
 123 } // namespace anon
 124
 125
 126 typedef map<string, bool> DepClean;
 127
 128 class Buffer::Impl
 129 {
 130 public:
 131         Impl(Buffer & parent, FileName const & file, bool readonly);
 132
 133         ~Impl()
 134         {
 135                 if (wa_) {
 136                         wa_->closeAll();
 137                         delete wa_;
 138                 }
 139         }
 140
 141         BufferParams params;
 142         LyXVC lyxvc;
 143         FileName temppath;
 144         mutable TexRow texrow;
 145         Buffer const * parent_buffer;
 146
 147         /// need to regenerate .tex?
 148         DepClean dep_clean;
 149
 150         /// is save needed?
 151         mutable bool lyx_clean;
 152
 153         /// is autosave needed?
 154         mutable bool bak_clean;
 155
 156         /// is this a unnamed file (New...)?
 157         bool unnamed;
 158
 159         /// buffer is r/o
 160         bool read_only;
 161
 162         /// name of the file the buffer is associated with.
 163         FileName filename;
 164
 165         /** Set to true only when the file is fully loaded.
 166          *  Used to prevent the premature generation of previews
 167          *  and by the citation inset.
 168          */
 169         bool file_fully_loaded;
 170
 171         /// our Text that should be wrapped in an InsetText
 172         InsetText inset;
 173
 174         ///
 175         mutable TocBackend toc_backend;
 176
 177         /// macro tables
 178         typedef pair<DocIterator, MacroData> ScopeMacro;
 179         typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
 180         typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
 181         NamePositionScopeMacroMap macros;
 182         bool macro_lock;
 183
 184         /// positions of child buffers in the buffer
 185         typedef map<Buffer const * const, DocIterator> BufferPositionMap;
 186         typedef pair<DocIterator, Buffer const *> ScopeBuffer;
 187         typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
 188         BufferPositionMap children_positions;
 189         PositionScopeBufferMap position_to_children;
 190
 191         /// Container for all sort of Buffer dependant errors.
 192         map<string, ErrorList> errorLists;
 193
 194         /// all embedded files of this buffer
 195         EmbeddedFileList embedded_files;
 196
 197         /// timestamp and checksum used to test if the file has been externally
 198         /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
 199         time_t timestamp_;
 200         unsigned long checksum_;
 201
 202         ///
 203         frontend::WorkAreaManager * wa_;
 204
 205         ///
 206         Undo undo_;
 207
 208         /// A cache for the bibfiles (including bibfiles of loaded child
 209         /// documents), needed for appropriate update of natbib labels.
 210         mutable EmbeddedFileList bibfilesCache_;
 211 };
 212
 213 /// Creates the per buffer temporary directory
 214 static FileName createBufferTmpDir()
 215 {
 216         static int count;
 217         // We are in our own directory.  Why bother to mangle name?
 218         // In fact I wrote this code to circumvent a problematic behaviour
 219         // (bug?) of EMX mkstemp().
 220         FileName tmpfl(package().temp_dir().absFilename() + "/lyx_tmpbuf" +
 221                 convert<string>(count++));
 222
 223         if (!tmpfl.createDirectory(0777)) {
 224                 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
 225                         _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
 226                         from_utf8(tmpfl.absFilename())));
 227         }
 228         return tmpfl;
 229 }
 230
 231
 232 Buffer::Impl::Impl(Buffer & parent, FileName const & file, bool readonly_)
 233         : parent_buffer(0), lyx_clean(true), bak_clean(true), unnamed(false),
 234           read_only(readonly_), filename(file), file_fully_loaded(false),
 235           inset(params), toc_backend(&parent), macro_lock(false),
 236           embedded_files(), timestamp_(0), checksum_(0), wa_(0),
 237           undo_(parent)
 238 {
 239         temppath = createBufferTmpDir();
 240         inset.setAutoBreakRows(true);
 241         lyxvc.setBuffer(&parent);
 242         if (use_gui)
 243                 wa_ = new frontend::WorkAreaManager;
 244 }
 245
 246
 247 Buffer::Buffer(string const & file, bool readonly)
 248         : d(new Impl(*this, FileName(file), readonly)), gui_(0)
 249 {
 250         LYXERR(Debug::INFO, "Buffer::Buffer()");
 251
 252         d->inset.getText(0)->setMacrocontextPosition(par_iterator_begin());
 253 }
 254
 255
 256 Buffer::~Buffer()
 257 {
 258         LYXERR(Debug::INFO, "Buffer::~Buffer()");
 259         // here the buffer should take care that it is
 260         // saved properly, before it goes into the void.
 261
 262         // GuiView already destroyed
 263         gui_ = 0;
 264
 265         Buffer const * master = masterBuffer();
 266         if (master != this && use_gui) {
 267                 // We are closing buf which was a child document so we
 268                 // must update the labels and section numbering of its master
 269                 // Buffer.
 270                 updateLabels(*master);
 271                 master->updateMacros();
 272         }
 273
 274         resetChildDocuments(false);
 275
 276         if (!d->temppath.destroyDirectory()) {
 277                 Alert::warning(_("Could not remove temporary directory"),
 278                         bformat(_("Could not remove the temporary directory %1$s"),
 279                         from_utf8(d->temppath.absFilename())));
 280         }
 281
 282         // Remove any previewed LaTeX snippets associated with this buffer.
 283         graphics::Previews::get().removeLoader(*this);
 284
 285         delete d;
 286 }
 287
 288
 289 void Buffer::changed() const
 290 {
 291         if (d->wa_)
 292                 d->wa_->redrawAll();
 293 }
 294
 295
 296 frontend::WorkAreaManager & Buffer::workAreaManager() const
 297 {
 298         BOOST_ASSERT(d->wa_);
 299         return *d->wa_;
 300 }
 301
 302
 303 Text & Buffer::text() const
 304 {
 305         return const_cast<Text &>(d->inset.text_);
 306 }
 307
 308
 309 Inset & Buffer::inset() const
 310 {
 311         return const_cast<InsetText &>(d->inset);
 312 }
 313
 314
 315 BufferParams & Buffer::params()
 316 {
 317         return d->params;
 318 }
 319
 320
 321 BufferParams const & Buffer::params() const
 322 {
 323         return d->params;
 324 }
 325
 326
 327 ParagraphList & Buffer::paragraphs()
 328 {
 329         return text().paragraphs();
 330 }
 331
 332
 333 ParagraphList const & Buffer::paragraphs() const
 334 {
 335         return text().paragraphs();
 336 }
 337
 338
 339 LyXVC & Buffer::lyxvc()
 340 {
 341         return d->lyxvc;
 342 }
 343
 344
 345 LyXVC const & Buffer::lyxvc() const
 346 {
 347         return d->lyxvc;
 348 }
 349
 350
 351 string const Buffer::temppath() const
 352 {
 353         return d->temppath.absFilename();
 354 }
 355
 356
 357 TexRow const & Buffer::texrow() const
 358 {
 359         return d->texrow;
 360 }
 361
 362
 363 TocBackend & Buffer::tocBackend() const
 364 {
 365         return d->toc_backend;
 366 }
 367
 368
 369 EmbeddedFileList & Buffer::embeddedFiles()
 370 {
 371         return d->embedded_files;
 372 }
 373
 374
 375 EmbeddedFileList const & Buffer::embeddedFiles() const
 376 {
 377         return d->embedded_files;
 378 }
 379
 380
 381 bool Buffer::embedded() const
 382 {
 383         return params().embedded;
 384 }
 385
 386
 387 Undo & Buffer::undo()
 388 {
 389         return d->undo_;
 390 }
 391
 392
 393 string Buffer::latexName(bool const no_path) const
 394 {
 395         FileName latex_name = makeLatexName(d->filename);
 396         return no_path ? latex_name.onlyFileName()
 397                 : latex_name.absFilename();
 398 }
 399
 400
 401 string Buffer::logName(LogType * type) const
 402 {
 403         string const filename = latexName(false);
 404
 405         if (filename.empty()) {
 406                 if (type)
 407                         *type = latexlog;
 408                 return string();
 409         }
 410
 411         string const path = temppath();
 412
 413         FileName const fname(addName(temppath(),
 414                                      onlyFilename(changeExtension(filename,
 415                                                                   ".log"))));
 416         FileName const bname(
 417                 addName(path, onlyFilename(
 418                         changeExtension(filename,
 419                                         formats.extension("literate") + ".out"))));
 420
 421         // If no Latex log or Build log is newer, show Build log
 422
 423         if (bname.exists() &&
 424             (!fname.exists() || fname.lastModified() < bname.lastModified())) {
 425                 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
 426                 if (type)
 427                         *type = buildlog;
 428                 return bname.absFilename();
 429         }
 430         LYXERR(Debug::FILES, "Log name calculated as: " << fname);
 431         if (type)
 432                         *type = latexlog;
 433         return fname.absFilename();
 434 }
 435
 436
 437 void Buffer::setReadonly(bool const flag)
 438 {
 439         if (d->read_only != flag) {
 440                 d->read_only = flag;
 441                 setReadOnly(flag);
 442         }
 443 }
 444
 445
 446 void Buffer::setFileName(string const & newfile)
 447 {
 448         d->filename = makeAbsPath(newfile);
 449         setReadonly(d->filename.isReadOnly());
 450         updateTitles();
 451 }
 452
 453
 454 int Buffer::readHeader(Lexer & lex)
 455 {
 456         int unknown_tokens = 0;
 457         int line = -1;
 458         int begin_header_line = -1;
 459
 460         // Initialize parameters that may be/go lacking in header:
 461         params().branchlist().clear();
 462         params().preamble.erase();
 463         params().options.erase();
 464         params().float_placement.erase();
 465         params().paperwidth.erase();
 466         params().paperheight.erase();
 467         params().leftmargin.erase();
 468         params().rightmargin.erase();
 469         params().topmargin.erase();
 470         params().bottommargin.erase();
 471         params().headheight.erase();
 472         params().headsep.erase();
 473         params().footskip.erase();
 474         params().listings_params.clear();
 475         params().clearLayoutModules();
 476         params().pdfoptions().clear();
 477
 478         for (int i = 0; i < 4; ++i) {
 479                 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
 480                 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
 481         }
 482
 483         ErrorList & errorList = d->errorLists["Parse"];
 484
 485         while (lex.isOK()) {
 486                 lex.next();
 487                 string const token = lex.getString();
 488
 489                 if (token.empty())
 490                         continue;
 491
 492                 if (token == "\\end_header")
 493                         break;
 494
 495                 ++line;
 496                 if (token == "\\begin_header") {
 497                         begin_header_line = line;
 498                         continue;
 499                 }
 500
 501                 LYXERR(Debug::PARSER, "Handling document header token: `"
 502                                       << token << '\'');
 503
 504                 string unknown = params().readToken(lex, token, d->filename.onlyPath());
 505                 if (!unknown.empty()) {
 506                         if (unknown[0] != '\\' && token == "\\textclass") {
 507                                 Alert::warning(_("Unknown document class"),
 508                        bformat(_("Using the default document class, because the "
 509                                               "class %1$s is unknown."), from_utf8(unknown)));
 510                         } else {
 511                                 ++unknown_tokens;
 512                                 docstring const s = bformat(_("Unknown token: "
 513                                                                         "%1$s %2$s\n"),
 514                                                          from_utf8(token),
 515                                                          lex.getDocString());
 516                                 errorList.push_back(ErrorItem(_("Document header error"),
 517                                         s, -1, 0, 0));
 518                         }
 519                 }
 520         }
 521         if (begin_header_line) {
 522                 docstring const s = _("\\begin_header is missing");
 523                 errorList.push_back(ErrorItem(_("Document header error"),
 524                         s, -1, 0, 0));
 525         }
 526
 527         params().makeTextClass();
 528
 529         return unknown_tokens;
 530 }
 531
 532
 533 // Uwe C. Schroeder
 534 // changed to be public and have one parameter
 535 // Returns false if "\end_document" is not read (Asger)
 536 bool Buffer::readDocument(Lexer & lex)
 537 {
 538         ErrorList & errorList = d->errorLists["Parse"];
 539         errorList.clear();
 540
 541         lex.next();
 542         string const token = lex.getString();
 543         if (token != "\\begin_document") {
 544                 docstring const s = _("\\begin_document is missing");
 545                 errorList.push_back(ErrorItem(_("Document header error"),
 546                         s, -1, 0, 0));
 547         }
 548
 549         // we are reading in a brand new document
 550         BOOST_ASSERT(paragraphs().empty());
 551
 552         readHeader(lex);
 553
 554         if (params().outputChanges) {
 555                 bool dvipost    = LaTeXFeatures::isAvailable("dvipost");
 556                 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
 557                                   LaTeXFeatures::isAvailable("xcolor");
 558
 559                 if (!dvipost && !xcolorsoul) {
 560                         Alert::warning(_("Changes not shown in LaTeX output"),
 561                                        _("Changes will not be highlighted in LaTeX output, "
 562                                          "because neither dvipost nor xcolor/soul are installed.\n"
 563                                          "Please install these packages or redefine "
 564                                          "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
 565                 } else if (!xcolorsoul) {
 566                         Alert::warning(_("Changes not shown in LaTeX output"),
 567                                        _("Changes will not be highlighted in LaTeX output "
 568                                          "when using pdflatex, because xcolor and soul are not installed.\n"
 569                                          "Please install both packages or redefine "
 570                                          "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
 571                 }
 572         }
 573
 574         // read main text
 575         bool const res = text().read(*this, lex, errorList);
 576         for_each(text().paragraphs().begin(),
 577                  text().paragraphs().end(),
 578                  bind(&Paragraph::setInsetOwner, _1, &inset()));
 579
 580         updateMacros();
 581         updateMacroInstances();
 582         return res;
 583 }
 584
 585
 586 // needed to insert the selection
 587 void Buffer::insertStringAsLines(ParagraphList & pars,
 588         pit_type & pit, pos_type & pos,
 589         Font const & fn, docstring const & str, bool autobreakrows)
 590 {
 591         Font font = fn;
 592
 593         // insert the string, don't insert doublespace
 594         bool space_inserted = true;
 595         for (docstring::const_iterator cit = str.begin();
 596             cit != str.end(); ++cit) {
 597                 Paragraph & par = pars[pit];
 598                 if (*cit == '\n') {
 599                         if (autobreakrows && (!par.empty() || par.allowEmpty())) {
 600                                 breakParagraph(params(), pars, pit, pos,
 601                                                par.layout()->isEnvironment());
 602                                 ++pit;
 603                                 pos = 0;
 604                                 space_inserted = true;
 605                         } else {
 606                                 continue;
 607                         }
 608                         // do not insert consecutive spaces if !free_spacing
 609                 } else if ((*cit == ' ' || *cit == '\t') &&
 610                            space_inserted && !par.isFreeSpacing()) {
 611                         continue;
 612                 } else if (*cit == '\t') {
 613                         if (!par.isFreeSpacing()) {
 614                                 // tabs are like spaces here
 615                                 par.insertChar(pos, ' ', font, params().trackChanges);
 616                                 ++pos;
 617                                 space_inserted = true;
 618                         } else {
 619                                 const pos_type n = 8 - pos % 8;
 620                                 for (pos_type i = 0; i < n; ++i) {
 621                                         par.insertChar(pos, ' ', font, params().trackChanges);
 622                                         ++pos;
 623                                 }
 624                                 space_inserted = true;
 625                         }
 626                 } else if (!isPrintable(*cit)) {
 627                         // Ignore unprintables
 628                         continue;
 629                 } else {
 630                         // just insert the character
 631                         par.insertChar(pos, *cit, font, params().trackChanges);
 632                         ++pos;
 633                         space_inserted = (*cit == ' ');
 634                 }
 635
 636         }
 637 }
 638
 639
 640 bool Buffer::readString(string const & s)
 641 {
 642         params().compressed = false;
 643
 644         // remove dummy empty par
 645         paragraphs().clear();
 646         Lexer lex(0, 0);
 647         istringstream is(s);
 648         lex.setStream(is);
 649         FileName const name = FileName::tempName();
 650         switch (readFile(lex, name, true)) {
 651         case failure:
 652                 return false;
 653         case wrongversion: {
 654                 // We need to call lyx2lyx, so write the input to a file
 655                 ofstream os(name.toFilesystemEncoding().c_str());
 656                 os << s;
 657                 os.close();
 658                 return readFile(name);
 659         }
 660         case success:
 661                 break;
 662         }
 663
 664         return true;
 665 }
 666
 667
 668 bool Buffer::readFile(FileName const & filename)
 669 {
 670         FileName fname(filename);
 671         // Check if the file is compressed.
 672         string format = filename.guessFormatFromContents();
 673         if (format == "zip") {
 674                 // decompress to a temp directory
 675                 LYXERR(Debug::FILES, filename << " is in zip format. Unzip to " << temppath());
 676                 ::unzipToDir(filename.toFilesystemEncoding(), temppath());
 677                 //
 678                 FileName lyxfile(addName(temppath(), "content.lyx"));
 679                 // if both manifest.txt and file.lyx exist, this is am embedded file
 680                 if (lyxfile.exists()) {
 681                         // if in bundled format, save checksum of the compressed file, not content.lyx
 682                         saveCheckSum(filename);
 683                         params().embedded = true;
 684                         fname = lyxfile;
 685                 }
 686         }
 687         // The embedded lyx file can also be compressed, for backward compatibility
 688         format = fname.guessFormatFromContents();
 689         if (format == "gzip" || format == "zip" || format == "compress")
 690                 params().compressed = true;
 691
 692         // remove dummy empty par
 693         paragraphs().clear();
 694         Lexer lex(0, 0);
 695         lex.setFile(fname);
 696         if (readFile(lex, fname) != success)
 697                 return false;
 698
 699         return true;
 700 }
 701
 702
 703 bool Buffer::isFullyLoaded() const
 704 {
 705         return d->file_fully_loaded;
 706 }
 707
 708
 709 void Buffer::setFullyLoaded(bool value)
 710 {
 711         d->file_fully_loaded = value;
 712 }
 713
 714
 715 Buffer::ReadStatus Buffer::readFile(Lexer & lex, FileName const & filename,
 716                 bool fromstring)
 717 {
 718         BOOST_ASSERT(!filename.empty());
 719
 720         if (!lex.isOK()) {
 721                 Alert::error(_("Document could not be read"),
 722                              bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
 723                 return failure;
 724         }
 725
 726         lex.next();
 727         string const token = lex.getString();
 728
 729         if (!lex) {
 730                 Alert::error(_("Document could not be read"),
 731                              bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
 732                 return failure;
 733         }
 734
 735         // the first token _must_ be...
 736         if (token != "\\lyxformat") {
 737                 lyxerr << "Token: " << token << endl;
 738
 739                 Alert::error(_("Document format failure"),
 740                              bformat(_("%1$s is not a LyX document."),
 741                                        from_utf8(filename.absFilename())));
 742                 return failure;
 743         }
 744
 745         lex.next();
 746         string tmp_format = lex.getString();
 747         //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
 748         // if present remove ".," from string.
 749         string::size_type dot = tmp_format.find_first_of(".,");
 750         //lyxerr << "           dot found at " << dot << endl;
 751         if (dot != string::npos)
 752                         tmp_format.erase(dot, 1);
 753         int const file_format = convert<int>(tmp_format);
 754         //lyxerr << "format: " << file_format << endl;
 755
 756         // save timestamp and checksum of the original disk file, making sure
 757         // to not overwrite them with those of the file created in the tempdir
 758         // when it has to be converted to the current format.
 759         if (!d->checksum_) {
 760                 // Save the timestamp and checksum of disk file. If filename is an
 761                 // emergency file, save the timestamp and checksum of the original lyx file
 762                 // because isExternallyModified will check for this file. (BUG4193)
 763                 string diskfile = filename.absFilename();
 764                 if (suffixIs(diskfile, ".emergency"))
 765                         diskfile = diskfile.substr(0, diskfile.size() - 10);
 766                 saveCheckSum(FileName(diskfile));
 767         }
 768
 769         if (file_format != LYX_FORMAT) {
 770
 771                 if (fromstring)
 772                         // lyx2lyx would fail
 773                         return wrongversion;
 774
 775                 FileName const tmpfile = FileName::tempName();
 776                 if (tmpfile.empty()) {
 777                         Alert::error(_("Conversion failed"),
 778                                      bformat(_("%1$s is from a different"
 779                                               " version of LyX, but a temporary"
 780                                               " file for converting it could"
 781                                                             " not be created."),
 782                                               from_utf8(filename.absFilename())));
 783                         return failure;
 784                 }
 785                 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
 786                 if (lyx2lyx.empty()) {
 787                         Alert::error(_("Conversion script not found"),
 788                                      bformat(_("%1$s is from a different"
 789                                                " version of LyX, but the"
 790                                                " conversion script lyx2lyx"
 791                                                             " could not be found."),
 792                                                from_utf8(filename.absFilename())));
 793                         return failure;
 794                 }
 795                 ostringstream command;
 796                 command << os::python()
 797                         << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
 798                         << " -t " << convert<string>(LYX_FORMAT)
 799                         << " -o " << quoteName(tmpfile.toFilesystemEncoding())
 800                         << ' ' << quoteName(filename.toFilesystemEncoding());
 801                 string const command_str = command.str();
 802
 803                 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
 804
 805                 cmd_ret const ret = runCommand(command_str);
 806                 if (ret.first != 0) {
 807                         Alert::error(_("Conversion script failed"),
 808                                      bformat(_("%1$s is from a different version"
 809                                               " of LyX, but the lyx2lyx script"
 810                                                             " failed to convert it."),
 811                                               from_utf8(filename.absFilename())));
 812                         return failure;
 813                 } else {
 814                         bool const ret = readFile(tmpfile);
 815                         // Do stuff with tmpfile name and buffer name here.
 816                         return ret ? success : failure;
 817                 }
 818
 819         }
 820
 821         if (readDocument(lex)) {
 822                 Alert::error(_("Document format failure"),
 823                              bformat(_("%1$s ended unexpectedly, which means"
 824                                                     " that it is probably corrupted."),
 825                                        from_utf8(filename.absFilename())));
 826         }
 827
 828         d->file_fully_loaded = true;
 829         return success;
 830 }
 831
 832
 833 // Should probably be moved to somewhere else: BufferView? LyXView?
 834 bool Buffer::save() const
 835 {
 836         // We don't need autosaves in the immediate future. (Asger)
 837         resetAutosaveTimers();
 838
 839         string const encodedFilename = d->filename.toFilesystemEncoding();
 840
 841         FileName backupName;
 842         bool madeBackup = false;
 843
 844         // make a backup if the file already exists
 845         if (lyxrc.make_backup && fileName().exists()) {
 846                 backupName = FileName(absFileName() + '~');
 847                 if (!lyxrc.backupdir_path.empty()) {
 848                         string const mangledName =
 849                                 subst(subst(backupName.absFilename(), '/', '!'), ':', '!');
 850                         backupName = FileName(addName(lyxrc.backupdir_path,
 851                                                       mangledName));
 852                 }
 853                 if (fileName().copyTo(backupName)) {
 854                         madeBackup = true;
 855                 } else {
 856                         Alert::error(_("Backup failure"),
 857                                      bformat(_("Cannot create backup file %1$s.\n"
 858                                                "Please check whether the directory exists and is writeable."),
 859                                              from_utf8(backupName.absFilename())));
 860                         //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
 861                 }
 862         }
 863
 864         // ask if the disk file has been externally modified (use checksum method)
 865         if (fileName().exists() && isExternallyModified(checksum_method)) {
 866                 docstring const file = makeDisplayPath(absFileName(), 20);
 867                 docstring text = bformat(_("Document %1$s has been externally modified. Are you sure "
 868                                                              "you want to overwrite this file?"), file);
 869                 int const ret = Alert::prompt(_("Overwrite modified file?"),
 870                         text, 1, 1, _("&Overwrite"), _("&Cancel"));
 871                 if (ret == 1)
 872                         return false;
 873         }
 874
 875         if (writeFile(d->filename)) {
 876                 markClean();
 877                 return true;
 878         } else {
 879                 // Saving failed, so backup is not backup
 880                 if (madeBackup)
 881                         backupName.moveTo(d->filename);
 882                 return false;
 883         }
 884 }
 885
 886
 887 bool Buffer::writeFile(FileName const & fname) const
 888 {
 889         if (d->read_only && fname == d->filename)
 890                 return false;
 891
 892         bool retval = false;
 893
 894         FileName content;
 895         if (params().embedded)
 896                 // first write the .lyx file to the temporary directory
 897                 content = FileName(addName(temppath(), "content.lyx"));
 898         else
 899                 content = fname;
 900
 901         docstring const str = bformat(_("Saving document %1$s..."),
 902                 makeDisplayPath(content.absFilename()));
 903         message(str);
 904
 905         if (params().compressed) {
 906                 gz::ogzstream ofs(content.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
 907                 retval = ofs && write(ofs);
 908         } else {
 909                 ofstream ofs(content.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
 910                 retval = ofs && write(ofs);
 911         }
 912
 913         if (!retval) {
 914                 message(str + _(" could not write file!."));
 915                 return false;
 916         }
 917
 918         removeAutosaveFile(d->filename.absFilename());
 919
 920         if (params().embedded) {
 921                 message(str + _(" writing embedded files!."));
 922                 // if embedding is enabled, write file.lyx and all the embedded files
 923                 // to the zip file fname.
 924                 if (!d->embedded_files.writeFile(fname, *this)) {
 925                         message(str + _(" could not write embedded files!."));
 926                         return false;
 927                 }
 928         }
 929         saveCheckSum(d->filename);
 930         message(str + _(" done."));
 931
 932         return true;
 933 }
 934
 935
 936 bool Buffer::write(ostream & ofs) const
 937 {
 938 #ifdef HAVE_LOCALE
 939         // Use the standard "C" locale for file output.
 940         ofs.imbue(locale::classic());
 941 #endif
 942
 943         // The top of the file should not be written by params().
 944
 945         // write out a comment in the top of the file
 946         ofs << "#LyX " << lyx_version
 947             << " created this file. For more info see http://www.lyx.org/\n"
 948             << "\\lyxformat " << LYX_FORMAT << "\n"
 949             << "\\begin_document\n";
 950
 951
 952         /// For each author, set 'used' to true if there is a change
 953         /// by this author in the document; otherwise set it to 'false'.
 954         AuthorList::Authors::const_iterator a_it = params().authors().begin();
 955         AuthorList::Authors::const_iterator a_end = params().authors().end();
 956         for (; a_it != a_end; ++a_it)
 957                 a_it->second.setUsed(false);
 958
 959         ParIterator const end = par_iterator_end();
 960         ParIterator it = par_iterator_begin();
 961         for ( ; it != end; ++it)
 962                 it->checkAuthors(params().authors());
 963
 964         // now write out the buffer parameters.
 965         ofs << "\\begin_header\n";
 966         params().writeFile(ofs);
 967         ofs << "\\end_header\n";
 968
 969         // write the text
 970         ofs << "\n\\begin_body\n";
 971         text().write(*this, ofs);
 972         ofs << "\n\\end_body\n";
 973
 974         // Write marker that shows file is complete
 975         ofs << "\\end_document" << endl;
 976
 977         // Shouldn't really be needed....
 978         //ofs.close();
 979
 980         // how to check if close went ok?
 981         // Following is an attempt... (BE 20001011)
 982
 983         // good() returns false if any error occured, including some
 984         //        formatting error.
 985         // bad()  returns true if something bad happened in the buffer,
 986         //        which should include file system full errors.
 987
 988         bool status = true;
 989         if (!ofs) {
 990                 status = false;
 991                 lyxerr << "File was not closed properly." << endl;
 992         }
 993
 994         return status;
 995 }
 996
 997
 998 bool Buffer::makeLaTeXFile(FileName const & fname,
 999                            string const & original_path,
1000                            OutputParams const & runparams,
1001                            bool output_preamble, bool output_body) const
1002 {
1003         string const encoding = runparams.encoding->iconvName();
1004         LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << "...");
1005
1006         odocfstream ofs;
1007         try { ofs.reset(encoding); }
1008         catch (iconv_codecvt_facet_exception & e) {
1009                 lyxerr << "Caught iconv exception: " << e.what() << endl;
1010                 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1011                         "verify that the support software for your encoding (%1$s) is "
1012                         "properly installed"), from_ascii(encoding)));
1013                 return false;
1014         }
1015         if (!openFileWrite(ofs, fname))
1016                 return false;
1017
1018         //TexStream ts(ofs.rdbuf(), &texrow());
1019         ErrorList & errorList = d->errorLists["Export"];
1020         errorList.clear();
1021         bool failed_export = false;
1022         try {
1023                 d->texrow.reset();
1024                 writeLaTeXSource(ofs, original_path,
1025                       runparams, output_preamble, output_body);
1026         }
1027         catch (EncodingException & e) {
1028                 odocstringstream ods;
1029                 ods.put(e.failed_char);
1030                 ostringstream oss;
1031                 oss << "0x" << hex << e.failed_char << dec;
1032                 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1033                                           " (code point %2$s)"),
1034                                           ods.str(), from_utf8(oss.str()));
1035                 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1036                                 "representable in the chosen encoding.\n"
1037                                 "Changing the document encoding to utf8 could help."),
1038                                 e.par_id, e.pos, e.pos + 1));
1039                 failed_export = true;
1040         }
1041         catch (iconv_codecvt_facet_exception & e) {
1042                 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1043                         _(e.what()), -1, 0, 0));
1044                 failed_export = true;
1045         }
1046         catch (exception const & e) {
1047                 errorList.push_back(ErrorItem(_("conversion failed"),
1048                         _(e.what()), -1, 0, 0));
1049                 failed_export = true;
1050         }
1051         catch (...) {
1052                 lyxerr << "Caught some really weird exception..." << endl;
1053                 LyX::cref().exit(1);
1054         }
1055
1056         ofs.close();
1057         if (ofs.fail()) {
1058                 failed_export = true;
1059                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1060         }
1061
1062         errors("Export");
1063         return !failed_export;
1064 }
1065
1066
1067 void Buffer::writeLaTeXSource(odocstream & os,
1068                            string const & original_path,
1069                            OutputParams const & runparams_in,
1070                            bool const output_preamble, bool const output_body) const
1071 {
1072         OutputParams runparams = runparams_in;
1073
1074         // validate the buffer.
1075         LYXERR(Debug::LATEX, "  Validating buffer...");
1076         LaTeXFeatures features(*this, params(), runparams);
1077         validate(features);
1078         LYXERR(Debug::LATEX, "  Buffer validation done.");
1079
1080         // The starting paragraph of the coming rows is the
1081         // first paragraph of the document. (Asger)
1082         if (output_preamble && runparams.nice) {
1083                 os << "%% LyX " << lyx_version << " created this file.  "
1084                         "For more info, see http://www.lyx.org/.\n"
1085                         "%% Do not edit unless you really know what "
1086                         "you are doing.\n";
1087                 d->texrow.newline();
1088                 d->texrow.newline();
1089         }
1090         LYXERR(Debug::INFO, "lyx document header finished");
1091         // There are a few differences between nice LaTeX and usual files:
1092         // usual is \batchmode and has a
1093         // special input@path to allow the including of figures
1094         // with either \input or \includegraphics (what figinsets do).
1095         // input@path is set when the actual parameter
1096         // original_path is set. This is done for usual tex-file, but not
1097         // for nice-latex-file. (Matthias 250696)
1098         // Note that input@path is only needed for something the user does
1099         // in the preamble, included .tex files or ERT, files included by
1100         // LyX work without it.
1101         if (output_preamble) {
1102                 if (!runparams.nice) {
1103                         // code for usual, NOT nice-latex-file
1104                         os << "\\batchmode\n"; // changed
1105                         // from \nonstopmode
1106                         d->texrow.newline();
1107                 }
1108                 if (!original_path.empty()) {
1109                         // FIXME UNICODE
1110                         // We don't know the encoding of inputpath
1111                         docstring const inputpath = from_utf8(latex_path(original_path));
1112                         os << "\\makeatletter\n"
1113                            << "\\def\\input@path{{"
1114                            << inputpath << "/}}\n"
1115                            << "\\makeatother\n";
1116                         d->texrow.newline();
1117                         d->texrow.newline();
1118                         d->texrow.newline();
1119                 }
1120
1121                 // Write the preamble
1122                 runparams.use_babel = params().writeLaTeX(os, features, d->texrow);
1123
1124                 if (!output_body)
1125                         return;
1126
1127                 // make the body.
1128                 os << "\\begin{document}\n";
1129                 d->texrow.newline();
1130         } // output_preamble
1131
1132         d->texrow.start(paragraphs().begin()->id(), 0);
1133
1134         LYXERR(Debug::INFO, "preamble finished, now the body.");
1135
1136         // fold macros if possible, still with parent buffer as the
1137         // macros will be put in the prefix anyway.
1138         updateMacros();
1139         updateMacroInstances();
1140
1141         // if we are doing a real file with body, even if this is the
1142         // child of some other buffer, let's cut the link here.
1143         // This happens for example if only a child document is printed.
1144         Buffer const * save_parent = 0;
1145         if (output_preamble) {
1146                 // output the macros visible for this buffer
1147                 writeParentMacros(os);
1148
1149                 save_parent = d->parent_buffer;
1150                 d->parent_buffer = 0;
1151         }
1152
1153         loadChildDocuments();
1154
1155         // the real stuff
1156         latexParagraphs(*this, paragraphs(), os, d->texrow, runparams);
1157
1158         // Restore the parenthood if needed
1159         if (output_preamble) {
1160                 d->parent_buffer = save_parent;
1161
1162                 // restore macros with correct parent buffer (especially
1163                 // important for the redefinition flag which depends on the
1164                 // parent)
1165                 updateMacros();
1166         }
1167
1168         // add this just in case after all the paragraphs
1169         os << endl;
1170         d->texrow.newline();
1171
1172         if (output_preamble) {
1173                 os << "\\end{document}\n";
1174                 d->texrow.newline();
1175                 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1176         } else {
1177                 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1178         }
1179         runparams_in.encoding = runparams.encoding;
1180
1181         // Just to be sure. (Asger)
1182         d->texrow.newline();
1183
1184         LYXERR(Debug::INFO, "Finished making LaTeX file.");
1185         LYXERR(Debug::INFO, "Row count was " << d->texrow.rows() - 1 << '.');
1186 }
1187
1188
1189 bool Buffer::isLatex() const
1190 {
1191         return params().getTextClass().outputType() == LATEX;
1192 }
1193
1194
1195 bool Buffer::isLiterate() const
1196 {
1197         return params().getTextClass().outputType() == LITERATE;
1198 }
1199
1200
1201 bool Buffer::isDocBook() const
1202 {
1203         return params().getTextClass().outputType() == DOCBOOK;
1204 }
1205
1206
1207 void Buffer::makeDocBookFile(FileName const & fname,
1208                               OutputParams const & runparams,
1209                               bool const body_only) const
1210 {
1211         LYXERR(Debug::LATEX, "makeDocBookFile...");
1212
1213         odocfstream ofs;
1214         if (!openFileWrite(ofs, fname))
1215                 return;
1216
1217         writeDocBookSource(ofs, fname.absFilename(), runparams, body_only);
1218
1219         ofs.close();
1220         if (ofs.fail())
1221                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1222 }
1223
1224
1225 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1226                              OutputParams const & runparams,
1227                              bool const only_body) const
1228 {
1229         LaTeXFeatures features(*this, params(), runparams);
1230         validate(features);
1231
1232         d->texrow.reset();
1233
1234         TextClass const & tclass = params().getTextClass();
1235         string const top_element = tclass.latexname();
1236
1237         if (!only_body) {
1238                 if (runparams.flavor == OutputParams::XML)
1239                         os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1240
1241                 // FIXME UNICODE
1242                 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1243
1244                 // FIXME UNICODE
1245                 if (! tclass.class_header().empty())
1246                         os << from_ascii(tclass.class_header());
1247                 else if (runparams.flavor == OutputParams::XML)
1248                         os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1249                             << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1250                 else
1251                         os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1252
1253                 docstring preamble = from_utf8(params().preamble);
1254                 if (runparams.flavor != OutputParams::XML ) {
1255                         preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1256                         preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1257                         preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1258                         preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1259                 }
1260
1261                 string const name = runparams.nice
1262                         ? changeExtension(absFileName(), ".sgml") : fname;
1263                 preamble += features.getIncludedFiles(name);
1264                 preamble += features.getLyXSGMLEntities();
1265
1266                 if (!preamble.empty()) {
1267                         os << "\n [ " << preamble << " ]";
1268                 }
1269                 os << ">\n\n";
1270         }
1271
1272         string top = top_element;
1273         top += " lang=\"";
1274         if (runparams.flavor == OutputParams::XML)
1275                 top += params().language->code();
1276         else
1277                 top += params().language->code().substr(0,2);
1278         top += '"';
1279
1280         if (!params().options.empty()) {
1281                 top += ' ';
1282                 top += params().options;
1283         }
1284
1285         os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1286             << " file was created by LyX " << lyx_version
1287             << "\n  See http://www.lyx.org/ for more information -->\n";
1288
1289         params().getTextClass().counters().reset();
1290
1291         loadChildDocuments();
1292
1293         sgml::openTag(os, top);
1294         os << '\n';
1295         docbookParagraphs(paragraphs(), *this, os, runparams);
1296         sgml::closeTag(os, top_element);
1297 }
1298
1299
1300 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1301 // Other flags: -wall -v0 -x
1302 int Buffer::runChktex()
1303 {
1304         setBusy(true);
1305
1306         // get LaTeX-Filename
1307         FileName const path(temppath());
1308         string const name = addName(path.absFilename(), latexName());
1309         string const org_path = filePath();
1310
1311         PathChanger p(path); // path to LaTeX file
1312         message(_("Running chktex..."));
1313
1314         // Generate the LaTeX file if neccessary
1315         OutputParams runparams(&params().encoding());
1316         runparams.flavor = OutputParams::LATEX;
1317         runparams.nice = false;
1318         makeLaTeXFile(FileName(name), org_path, runparams);
1319
1320         TeXErrors terr;
1321         Chktex chktex(lyxrc.chktex_command, onlyFilename(name), filePath());
1322         int const res = chktex.run(terr); // run chktex
1323
1324         if (res == -1) {
1325                 Alert::error(_("chktex failure"),
1326                              _("Could not run chktex successfully."));
1327         } else if (res > 0) {
1328                 ErrorList & errlist = d->errorLists["ChkTeX"];
1329                 errlist.clear();
1330                 bufferErrors(terr, errlist);
1331         }
1332
1333         setBusy(false);
1334
1335         errors("ChkTeX");
1336
1337         return res;
1338 }
1339
1340
1341 void Buffer::validate(LaTeXFeatures & features) const
1342 {
1343         params().validate(features);
1344
1345         loadChildDocuments();
1346
1347         for_each(paragraphs().begin(), paragraphs().end(),
1348                  boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1349
1350         if (lyxerr.debugging(Debug::LATEX)) {
1351                 features.showStruct();
1352         }
1353 }
1354
1355
1356 void Buffer::getLabelList(vector<docstring> & list) const
1357 {
1358         /// if this is a child document and the parent is already loaded
1359         /// Use the parent's list instead  [ale990407]
1360         Buffer const * tmp = masterBuffer();
1361         if (!tmp) {
1362                 lyxerr << "masterBuffer() failed!" << endl;
1363                 BOOST_ASSERT(tmp);
1364         }
1365         if (tmp != this) {
1366                 tmp->getLabelList(list);
1367                 return;
1368         }
1369
1370         loadChildDocuments();
1371
1372         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1373                 it.nextInset()->getLabelList(*this, list);
1374 }
1375
1376
1377 void Buffer::updateBibfilesCache() const
1378 {
1379         // if this is a child document and the parent is already loaded
1380         // update the parent's cache instead
1381         Buffer const * tmp = masterBuffer();
1382         BOOST_ASSERT(tmp);
1383         if (tmp != this) {
1384                 tmp->updateBibfilesCache();
1385                 return;
1386         }
1387
1388         d->bibfilesCache_.clear();
1389         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1390                 if (it->lyxCode() == BIBTEX_CODE) {
1391                         InsetBibtex const & inset =
1392                                 static_cast<InsetBibtex const &>(*it);
1393                         EmbeddedFileList const bibfiles = inset.getFiles(*this);
1394                         d->bibfilesCache_.insert(d->bibfilesCache_.end(),
1395                                 bibfiles.begin(),
1396                                 bibfiles.end());
1397                 } else if (it->lyxCode() == INCLUDE_CODE) {
1398                         InsetInclude & inset =
1399                                 static_cast<InsetInclude &>(*it);
1400                         inset.updateBibfilesCache(*this);
1401                         EmbeddedFileList const & bibfiles =
1402                                         inset.getBibfilesCache(*this);
1403                         d->bibfilesCache_.insert(d->bibfilesCache_.end(),
1404                                 bibfiles.begin(),
1405                                 bibfiles.end());
1406                 }
1407         }
1408 }
1409
1410
1411 EmbeddedFileList const & Buffer::getBibfilesCache() const
1412 {
1413         // if this is a child document and the parent is already loaded
1414         // use the parent's cache instead
1415         Buffer const * tmp = masterBuffer();
1416         BOOST_ASSERT(tmp);
1417         if (tmp != this)
1418                 return tmp->getBibfilesCache();
1419
1420         // We update the cache when first used instead of at loading time.
1421         if (d->bibfilesCache_.empty())
1422                 const_cast<Buffer *>(this)->updateBibfilesCache();
1423
1424         return d->bibfilesCache_;
1425 }
1426
1427
1428 bool Buffer::isDepClean(string const & name) const
1429 {
1430         DepClean::const_iterator const it = d->dep_clean.find(name);
1431         if (it == d->dep_clean.end())
1432                 return true;
1433         return it->second;
1434 }
1435
1436
1437 void Buffer::markDepClean(string const & name)
1438 {
1439         d->dep_clean[name] = true;
1440 }
1441
1442
1443 bool Buffer::dispatch(string const & command, bool * result)
1444 {
1445         return dispatch(lyxaction.lookupFunc(command), result);
1446 }
1447
1448
1449 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1450 {
1451         bool dispatched = true;
1452
1453         switch (func.action) {
1454                 case LFUN_BUFFER_EXPORT: {
1455                         bool const tmp = doExport(to_utf8(func.argument()), false);
1456                         if (result)
1457                                 *result = tmp;
1458                         break;
1459                 }
1460
1461                 default:
1462                         dispatched = false;
1463         }
1464         return dispatched;
1465 }
1466
1467
1468 void Buffer::changeLanguage(Language const * from, Language const * to)
1469 {
1470         BOOST_ASSERT(from);
1471         BOOST_ASSERT(to);
1472
1473         for_each(par_iterator_begin(),
1474                  par_iterator_end(),
1475                  bind(&Paragraph::changeLanguage, _1, params(), from, to));
1476 }
1477
1478
1479 bool Buffer::isMultiLingual() const
1480 {
1481         ParConstIterator end = par_iterator_end();
1482         for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1483                 if (it->isMultiLingual(params()))
1484                         return true;
1485
1486         return false;
1487 }
1488
1489
1490 ParIterator Buffer::getParFromID(int const id) const
1491 {
1492         ParConstIterator it = par_iterator_begin();
1493         ParConstIterator const end = par_iterator_end();
1494
1495         if (id < 0) {
1496                 // John says this is called with id == -1 from undo
1497                 lyxerr << "getParFromID(), id: " << id << endl;
1498                 return end;
1499         }
1500
1501         for (; it != end; ++it)
1502                 if (it->id() == id)
1503                         return it;
1504
1505         return end;
1506 }
1507
1508
1509 bool Buffer::hasParWithID(int const id) const
1510 {
1511         ParConstIterator const it = getParFromID(id);
1512         return it != par_iterator_end();
1513 }
1514
1515
1516 ParIterator Buffer::par_iterator_begin()
1517 {
1518         return lyx::par_iterator_begin(inset());
1519 }
1520
1521
1522 ParIterator Buffer::par_iterator_end()
1523 {
1524         return lyx::par_iterator_end(inset());
1525 }
1526
1527
1528 ParConstIterator Buffer::par_iterator_begin() const
1529 {
1530         return lyx::par_const_iterator_begin(inset());
1531 }
1532
1533
1534 ParConstIterator Buffer::par_iterator_end() const
1535 {
1536         return lyx::par_const_iterator_end(inset());
1537 }
1538
1539
1540 Language const * Buffer::language() const
1541 {
1542         return params().language;
1543 }
1544
1545
1546 docstring const Buffer::B_(string const & l10n) const
1547 {
1548         return params().B_(l10n);
1549 }
1550
1551
1552 bool Buffer::isClean() const
1553 {
1554         return d->lyx_clean;
1555 }
1556
1557
1558 bool Buffer::isBakClean() const
1559 {
1560         return d->bak_clean;
1561 }
1562
1563
1564 bool Buffer::isExternallyModified(CheckMethod method) const
1565 {
1566         BOOST_ASSERT(d->filename.exists());
1567         // if method == timestamp, check timestamp before checksum
1568         return (method == checksum_method
1569                 || d->timestamp_ != d->filename.lastModified())
1570                 && d->checksum_ != d->filename.checksum();
1571 }
1572
1573
1574 void Buffer::saveCheckSum(FileName const & file) const
1575 {
1576         if (file.exists()) {
1577                 d->timestamp_ = file.lastModified();
1578                 d->checksum_ = file.checksum();
1579         } else {
1580                 // in the case of save to a new file.
1581                 d->timestamp_ = 0;
1582                 d->checksum_ = 0;
1583         }
1584 }
1585
1586
1587 void Buffer::markClean() const
1588 {
1589         if (!d->lyx_clean) {
1590                 d->lyx_clean = true;
1591                 updateTitles();
1592         }
1593         // if the .lyx file has been saved, we don't need an
1594         // autosave
1595         d->bak_clean = true;
1596 }
1597
1598
1599 void Buffer::markBakClean() const
1600 {
1601         d->bak_clean = true;
1602 }
1603
1604
1605 void Buffer::setUnnamed(bool flag)
1606 {
1607         d->unnamed = flag;
1608 }
1609
1610
1611 bool Buffer::isUnnamed() const
1612 {
1613         return d->unnamed;
1614 }
1615
1616
1617 // FIXME: this function should be moved to buffer_pimpl.C
1618 void Buffer::markDirty()
1619 {
1620         if (d->lyx_clean) {
1621                 d->lyx_clean = false;
1622                 updateTitles();
1623         }
1624         d->bak_clean = false;
1625
1626         DepClean::iterator it = d->dep_clean.begin();
1627         DepClean::const_iterator const end = d->dep_clean.end();
1628
1629         for (; it != end; ++it)
1630                 it->second = false;
1631 }
1632
1633
1634 FileName Buffer::fileName() const
1635 {
1636         return d->filename;
1637 }
1638
1639
1640 string Buffer::absFileName() const
1641 {
1642         return d->filename.absFilename();
1643 }
1644
1645
1646 string Buffer::filePath() const
1647 {
1648         return d->filename.onlyPath().absFilename() + "/";
1649 }
1650
1651
1652 bool Buffer::isReadonly() const
1653 {
1654         return d->read_only;
1655 }
1656
1657
1658 void Buffer::setParent(Buffer const * buffer)
1659 {
1660         // Avoids recursive include.
1661         d->parent_buffer = buffer == this ? 0 : buffer;
1662         updateMacros();
1663 }
1664
1665
1666 Buffer const * Buffer::parent()
1667 {
1668         return d->parent_buffer;
1669 }
1670
1671
1672 Buffer const * Buffer::masterBuffer() const
1673 {
1674         if (!d->parent_buffer)
1675                 return this;
1676
1677         return d->parent_buffer->masterBuffer();
1678 }
1679
1680
1681 template<typename M>
1682 typename M::iterator greatest_below(M & m, typename M::key_type const & x)
1683 {
1684         if (m.empty())
1685                 return m.end();
1686
1687         typename M::iterator it = m.lower_bound(x);
1688         if (it == m.begin())
1689                 return m.end();
1690
1691         it--;
1692         return it;
1693 }
1694
1695
1696 MacroData const * Buffer::getBufferMacro(docstring const & name,
1697                                          DocIterator const & pos) const
1698 {
1699         LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
1700
1701         // if paragraphs have no macro context set, pos will be empty
1702         if (pos.empty())
1703                 return 0;
1704
1705         // we haven't found anything yet
1706         DocIterator bestPos = par_iterator_begin();
1707         MacroData const * bestData = 0;
1708
1709         // find macro definitions for name
1710         Impl::NamePositionScopeMacroMap::iterator nameIt
1711         = d->macros.find(name);
1712         if (nameIt != d->macros.end()) {
1713                 // find last definition in front of pos or at pos itself
1714                 Impl::PositionScopeMacroMap::const_iterator it
1715                 = greatest_below(nameIt->second, pos);
1716                 if (it != nameIt->second.end()) {
1717                         while (true) {
1718                                 // scope ends behind pos?
1719                                 if (pos < it->second.first) {
1720                                         // Looks good, remember this. If there
1721                                         // is no external macro behind this,
1722                                         // we found the right one already.
1723                                         bestPos = it->first;
1724                                         bestData = &it->second.second;
1725                                         break;
1726                                 }
1727
1728                                 // try previous macro if there is one
1729                                 if (it == nameIt->second.begin())
1730                                         break;
1731                                 it--;
1732                         }
1733                 }
1734         }
1735
1736         // find macros in included files
1737         Impl::PositionScopeBufferMap::const_iterator it
1738         = greatest_below(d->position_to_children, pos);
1739         if (it != d->position_to_children.end()) {
1740                 while (true) {
1741                         // do we know something better (i.e. later) already?
1742                         if (it->first < bestPos )
1743                                 break;
1744
1745                         // scope ends behind pos?
1746                         if (pos < it->second.first) {
1747                                 // look for macro in external file
1748                                 d->macro_lock = true;
1749                                 MacroData const * data
1750                                 = it->second.second->getMacro(name, false);
1751                                 d->macro_lock = false;
1752                                 if (data) {
1753                                         bestPos = it->first;
1754                                         bestData = data;
1755                                         break;
1756                                 }
1757                         }
1758
1759                         // try previous file if there is one
1760                         if (it == d->position_to_children.begin())
1761                                 break;
1762                         --it;
1763                 }
1764         }
1765
1766         // return the best macro we have found
1767         return bestData;
1768 }
1769
1770
1771 MacroData const * Buffer::getMacro(docstring const & name,
1772         DocIterator const & pos, bool global) const
1773 {
1774         if (d->macro_lock)
1775                 return 0;
1776
1777         // query buffer macros
1778         MacroData const * data = getBufferMacro(name, pos);
1779         if (data != 0)
1780                 return data;
1781
1782         // If there is a master buffer, query that
1783         if (d->parent_buffer) {
1784                 d->macro_lock = true;
1785                 MacroData const * macro
1786                 = d->parent_buffer->getMacro(name, *this, false);
1787                 d->macro_lock = false;
1788                 if (macro)
1789                         return macro;
1790         }
1791
1792         if (global) {
1793                 data = MacroTable::globalMacros().get(name);
1794                 if (data != 0)
1795                         return data;
1796         }
1797
1798         return 0;
1799 }
1800
1801
1802 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
1803 {
1804         // set scope end behind the last paragraph
1805         DocIterator scope = par_iterator_begin();
1806         scope.pit() = scope.lastpit() + 1;
1807
1808         return getMacro(name, scope, global);
1809 }
1810
1811
1812 MacroData const * Buffer::getMacro(docstring const & name, Buffer const & child, bool global) const
1813 {
1814         // look where the child buffer is included first
1815         Impl::BufferPositionMap::iterator it
1816         = d->children_positions.find(&child);
1817         if (it == d->children_positions.end())
1818                 return 0;
1819
1820         // check for macros at the inclusion position
1821         return getMacro(name, it->second, global);
1822 }
1823
1824
1825 void Buffer::updateEnvironmentMacros(DocIterator & it,
1826                                      pit_type lastpit,
1827                                      DocIterator & scope) const
1828 {
1829         Paragraph & par = it.paragraph();
1830         depth_type depth
1831         = par.params().depth();
1832         Length const & leftIndent
1833         = par.params().leftIndent();
1834
1835         // look for macros in each paragraph
1836         while (it.pit() <= lastpit) {
1837                 Paragraph & par = it.paragraph();
1838
1839                 // increased depth?
1840                 if ((par.params().depth() > depth
1841                      || par.params().leftIndent() != leftIndent)
1842                     && par.layout()->isEnvironment()) {
1843                         updateBlockMacros(it, scope);
1844                         continue;
1845                 }
1846
1847                 // iterate over the insets of the current paragraph
1848                 InsetList const & insets = par.insetList();
1849                 InsetList::const_iterator iit = insets.begin();
1850                 InsetList::const_iterator end = insets.end();
1851                 for (; iit != end; ++iit) {
1852                         it.pos() = iit->pos;
1853
1854                         // is it a nested text inset?
1855                         if (iit->inset->asInsetText()) {
1856                                 // Inset needs its own scope?
1857                                 InsetText const * itext
1858                                 = iit->inset->asInsetText();
1859                                 bool newScope = itext->isMacroScope(*this);
1860
1861                                 // scope which ends just behind die inset
1862                                 DocIterator insetScope = it;
1863                                 insetScope.pos()++;
1864
1865                                 // collect macros in inset
1866                                 it.push_back(CursorSlice(*iit->inset));
1867                                 updateInsetMacros(it, newScope ? insetScope : scope);
1868                                 it.pop_back();
1869                                 continue;
1870                         }
1871
1872                         // is it an external file?
1873                         if (iit->inset->lyxCode() == INCLUDE_CODE) {
1874                                 // get buffer of external file
1875                                 InsetCommand const & inset
1876                                 = static_cast<InsetCommand const &>(*iit->inset);
1877                                 InsetCommandParams const & ip = inset.params();
1878                                 d->macro_lock = true;
1879                                 Buffer * child = loadIfNeeded(*this, ip);
1880                                 d->macro_lock = false;
1881                                 if (!child)
1882                                         continue;
1883
1884                                 // register it, but only when it is
1885                                 // included first in the buffer
1886                                 if (d->children_positions.find(child)
1887                                     == d->children_positions.end())
1888                                         d->children_positions[child] = it;
1889
1890                                 // register child with its scope
1891                                 d->position_to_children[it] = Impl::ScopeBuffer(scope, child);
1892
1893                                 continue;
1894                         }
1895
1896                         if (iit->inset->lyxCode() != MATHMACRO_CODE)
1897                                 continue;
1898
1899                         // get macro data
1900                         MathMacroTemplate & macroTemplate
1901                         = static_cast<MathMacroTemplate &>(*iit->inset);
1902                         MacroContext mc(*this, it);
1903                         macroTemplate.updateToContext(mc);
1904
1905                         // valid?
1906                         bool valid = macroTemplate.validMacro();
1907                         // FIXME: Should be fixNameAndCheckIfValid() in fact,
1908                         // then the BufferView's cursor will be invalid in
1909                         // some cases which leads to crashes.
1910                         if (!valid)
1911                                 continue;
1912
1913                         // register macro
1914                         d->macros[macroTemplate.name()][it]
1915                         = Impl::ScopeMacro(scope, MacroData(*this, it));
1916                 }
1917
1918                 // next paragraph
1919                 it.pit()++;
1920                 it.pos() = 0;
1921         }
1922 }
1923
1924
1925 void Buffer::updateBlockMacros(DocIterator & it, DocIterator & scope) const
1926 {
1927         Paragraph & par = it.paragraph();
1928
1929         // set scope for macros in this paragraph:
1930         // * either the "old" outer scope
1931         // * or the scope ending after the environment
1932         if (par.layout()->isEnvironment()) {
1933                 // find end of environment block,
1934                 DocIterator envEnd = it;
1935                 pit_type n = it.lastpit() + 1;
1936                 depth_type depth = par.params().depth();
1937                 Length const & length = par.params().leftIndent();
1938                 // looping through the paragraph, basically until
1939                 // the layout changes or the depth gets smaller.
1940                 // (the logic of output_latex.cpp's TeXEnvironment)
1941                 do {
1942                         envEnd.pit()++;
1943                         if (envEnd.pit() == n)
1944                                 break;
1945                 } while (par.layout() == envEnd.paragraph().layout()
1946                          || depth < envEnd.paragraph().params().depth()
1947                          || length != envEnd.paragraph().params().leftIndent());
1948
1949                 // collect macros from environment block
1950                 updateEnvironmentMacros(it, envEnd.pit() - 1, envEnd);
1951         } else {
1952                 // collect macros from paragraph
1953                 updateEnvironmentMacros(it, it.pit(), scope);
1954         }
1955 }
1956
1957
1958 void Buffer::updateInsetMacros(DocIterator & it, DocIterator & scope) const
1959 {
1960         // look for macros in each paragraph
1961         pit_type n = it.lastpit() + 1;
1962         while (it.pit() < n)
1963                 updateBlockMacros(it, scope);
1964 }
1965
1966
1967 void Buffer::updateMacros() const
1968 {
1969         if (d->macro_lock)
1970                 return;
1971
1972         LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
1973
1974         // start with empty table
1975         d->macros.clear();
1976         d->children_positions.clear();
1977         d->position_to_children.clear();
1978
1979         // Iterate over buffer, starting with first paragraph
1980         // The scope must be bigger than any lookup DocIterator
1981         // later. For the global lookup, lastpit+1 is used, hence
1982         // we use lastpit+2 here.
1983         DocIterator it = par_iterator_begin();
1984         DocIterator outerScope = it;
1985         outerScope.pit() = outerScope.lastpit() + 2;
1986         updateInsetMacros(it, outerScope);
1987 }
1988
1989
1990 void Buffer::updateMacroInstances() const
1991 {
1992         LYXERR(Debug::MACROS, "updateMacroInstances for " << d->filename.onlyFileName());
1993         ParIterator it = par_iterator_begin();
1994         ParIterator end = par_iterator_end();
1995         for (; it != end; it.forwardPos()) {
1996                 // look for MathData cells in InsetMathNest insets
1997                 Inset * inset = it.nextInset();
1998                 if (!inset)
1999                         continue;
2000
2001                 InsetMath * minset = inset->asInsetMath();
2002                 if (!minset)
2003                         continue;
2004
2005                 // update macro in all cells of the InsetMathNest
2006                 DocIterator::idx_type n = minset->nargs();
2007                 MacroContext mc = MacroContext(*this, it);
2008                 for (DocIterator::idx_type i = 0; i < n; ++i) {
2009                         MathData & data = minset->cell(i);
2010                         data.updateMacros(0, mc);
2011                 }
2012         }
2013 }
2014
2015
2016 void Buffer::listMacroNames(MacroNameSet & macros) const
2017 {
2018         if (d->macro_lock)
2019                 return;
2020
2021         d->macro_lock = true;
2022
2023         // loop over macro names
2024         Impl::NamePositionScopeMacroMap::iterator nameIt
2025         = d->macros.begin();
2026         Impl::NamePositionScopeMacroMap::iterator nameEnd
2027         = d->macros.end();
2028         for (; nameIt != nameEnd; ++nameIt)
2029                 macros.insert(nameIt->first);
2030
2031         // loop over children
2032         Impl::BufferPositionMap::iterator it
2033         = d->children_positions.begin();
2034         Impl::BufferPositionMap::iterator end
2035         = d->children_positions.end();
2036         for (; it != end; ++it)
2037                 it->first->listMacroNames(macros);
2038
2039         // call parent
2040         if (d->parent_buffer)
2041                 d->parent_buffer->listMacroNames(macros);
2042
2043         d->macro_lock = false;
2044 }
2045
2046
2047 void Buffer::writeParentMacros(odocstream & os) const
2048 {
2049         if (!d->parent_buffer)
2050                 return;
2051
2052         // collect macro names
2053         MacroNameSet names;
2054         d->parent_buffer->listMacroNames(names);
2055
2056         // resolve and output them
2057         MacroNameSet::iterator it = names.begin();
2058         MacroNameSet::iterator end = names.end();
2059         for (; it != end; ++it) {
2060                 // defined?
2061                 MacroData const * data =
2062                 d->parent_buffer->getMacro(*it, *this, false);
2063                 if (data)
2064                         data->write(os, true);
2065         }
2066 }
2067
2068
2069 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
2070         InsetCode code)
2071 {
2072         //FIXME: This does not work for child documents yet.
2073         BOOST_ASSERT(code == CITE_CODE || code == REF_CODE);
2074         // Check if the label 'from' appears more than once
2075         vector<docstring> labels;
2076
2077         string paramName;
2078         if (code == CITE_CODE) {
2079                 BiblioInfo keys;
2080                 keys.fillWithBibKeys(this);
2081                 BiblioInfo::const_iterator bit  = keys.begin();
2082                 BiblioInfo::const_iterator bend = keys.end();
2083
2084                 for (; bit != bend; ++bit)
2085                         // FIXME UNICODE
2086                         labels.push_back(bit->first);
2087                 paramName = "key";
2088         } else {
2089                 getLabelList(labels);
2090                 paramName = "reference";
2091         }
2092
2093         if (count(labels.begin(), labels.end(), from) > 1)
2094                 return;
2095
2096         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2097                 if (it->lyxCode() == code) {
2098                         InsetCommand & inset = static_cast<InsetCommand &>(*it);
2099                         docstring const oldValue = inset.getParam(paramName);
2100                         if (oldValue == from)
2101                                 inset.setParam(paramName, to);
2102                 }
2103         }
2104 }
2105
2106
2107 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
2108         pit_type par_end, bool full_source)
2109 {
2110         OutputParams runparams(&params().encoding());
2111         runparams.nice = true;
2112         runparams.flavor = OutputParams::LATEX;
2113         runparams.linelen = lyxrc.plaintext_linelen;
2114         // No side effect of file copying and image conversion
2115         runparams.dryrun = true;
2116
2117         d->texrow.reset();
2118         if (full_source) {
2119                 os << "% " << _("Preview source code") << "\n\n";
2120                 d->texrow.newline();
2121                 d->texrow.newline();
2122                 if (isLatex())
2123                         writeLaTeXSource(os, filePath(), runparams, true, true);
2124                 else {
2125                         writeDocBookSource(os, absFileName(), runparams, false);
2126                 }
2127         } else {
2128                 runparams.par_begin = par_begin;
2129                 runparams.par_end = par_end;
2130                 if (par_begin + 1 == par_end)
2131                         os << "% "
2132                            << bformat(_("Preview source code for paragraph %1$d"), par_begin)
2133                            << "\n\n";
2134                 else
2135                         os << "% "
2136                            << bformat(_("Preview source code from paragraph %1$s to %2$s"),
2137                                         convert<docstring>(par_begin),
2138                                         convert<docstring>(par_end - 1))
2139                            << "\n\n";
2140                 d->texrow.newline();
2141                 d->texrow.newline();
2142                 // output paragraphs
2143                 if (isLatex()) {
2144                         latexParagraphs(*this, paragraphs(), os, d->texrow, runparams);
2145                 } else {
2146                         // DocBook
2147                         docbookParagraphs(paragraphs(), *this, os, runparams);
2148                 }
2149         }
2150 }
2151
2152
2153 ErrorList & Buffer::errorList(string const & type) const
2154 {
2155         static ErrorList emptyErrorList;
2156         map<string, ErrorList>::iterator I = d->errorLists.find(type);
2157         if (I == d->errorLists.end())
2158                 return emptyErrorList;
2159
2160         return I->second;
2161 }
2162
2163
2164 void Buffer::structureChanged() const
2165 {
2166         if (gui_)
2167                 gui_->structureChanged();
2168 }
2169
2170
2171 void Buffer::errors(string const & err) const
2172 {
2173         if (gui_)
2174                 gui_->errors(err);
2175 }
2176
2177
2178 void Buffer::message(docstring const & msg) const
2179 {
2180         if (gui_)
2181                 gui_->message(msg);
2182 }
2183
2184
2185 void Buffer::setBusy(bool on) const
2186 {
2187         if (gui_)
2188                 gui_->setBusy(on);
2189 }
2190
2191
2192 void Buffer::setReadOnly(bool on) const
2193 {
2194         if (d->wa_)
2195                 d->wa_->setReadOnly(on);
2196 }
2197
2198
2199 void Buffer::updateTitles() const
2200 {
2201         if (d->wa_)
2202                 d->wa_->updateTitles();
2203 }
2204
2205
2206 void Buffer::resetAutosaveTimers() const
2207 {
2208         if (gui_)
2209                 gui_->resetAutosaveTimers();
2210 }
2211
2212
2213 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
2214 {
2215         gui_ = gui;
2216 }
2217
2218
2219
2220 namespace {
2221
2222 class AutoSaveBuffer : public ForkedProcess {
2223 public:
2224         ///
2225         AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
2226                 : buffer_(buffer), fname_(fname) {}
2227         ///
2228         virtual boost::shared_ptr<ForkedProcess> clone() const
2229         {
2230                 return boost::shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
2231         }
2232         ///
2233         int start()
2234         {
2235                 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
2236                                                  from_utf8(fname_.absFilename())));
2237                 return run(DontWait);
2238         }
2239 private:
2240         ///
2241         virtual int generateChild();
2242         ///
2243         Buffer const & buffer_;
2244         FileName fname_;
2245 };
2246
2247
2248 #if !defined (HAVE_FORK)
2249 # define fork() -1
2250 #endif
2251
2252 int AutoSaveBuffer::generateChild()
2253 {
2254         // tmp_ret will be located (usually) in /tmp
2255         // will that be a problem?
2256         pid_t const pid = fork();
2257         // If you want to debug the autosave
2258         // you should set pid to -1, and comment out the fork.
2259         if (pid == 0 || pid == -1) {
2260                 // pid = -1 signifies that lyx was unable
2261                 // to fork. But we will do the save
2262                 // anyway.
2263                 bool failed = false;
2264
2265                 FileName const tmp_ret = FileName::tempName("lyxauto");
2266                 if (!tmp_ret.empty()) {
2267                         buffer_.writeFile(tmp_ret);
2268                         // assume successful write of tmp_ret
2269                         if (!tmp_ret.moveTo(fname_)) {
2270                                 failed = true;
2271                                 // most likely couldn't move between
2272                                 // filesystems unless write of tmp_ret
2273                                 // failed so remove tmp file (if it
2274                                 // exists)
2275                                 tmp_ret.removeFile();
2276                         }
2277                 } else {
2278                         failed = true;
2279                 }
2280
2281                 if (failed) {
2282                         // failed to write/rename tmp_ret so try writing direct
2283                         if (!buffer_.writeFile(fname_)) {
2284                                 // It is dangerous to do this in the child,
2285                                 // but safe in the parent, so...
2286                                 if (pid == -1) // emit message signal.
2287                                         buffer_.message(_("Autosave failed!"));
2288                         }
2289                 }
2290                 if (pid == 0) { // we are the child so...
2291                         _exit(0);
2292                 }
2293         }
2294         return pid;
2295 }
2296
2297 } // namespace anon
2298
2299
2300 // Perfect target for a thread...
2301 void Buffer::autoSave() const
2302 {
2303         if (isBakClean() || isReadonly()) {
2304                 // We don't save now, but we'll try again later
2305                 resetAutosaveTimers();
2306                 return;
2307         }
2308
2309         // emit message signal.
2310         message(_("Autosaving current document..."));
2311
2312         // create autosave filename
2313         string fname = filePath();
2314         fname += '#';
2315         fname += d->filename.onlyFileName();
2316         fname += '#';
2317
2318         AutoSaveBuffer autosave(*this, FileName(fname));
2319         autosave.start();
2320
2321         markBakClean();
2322         resetAutosaveTimers();
2323 }
2324
2325
2326 void Buffer::resetChildDocuments(bool close_them) const
2327 {
2328         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2329                 if (it->lyxCode() != INCLUDE_CODE)
2330                         continue;
2331                 InsetCommand const & inset = static_cast<InsetCommand const &>(*it);
2332                 InsetCommandParams const & ip = inset.params();
2333
2334                 resetParentBuffer(this, ip, close_them);
2335         }
2336
2337         if (use_gui && masterBuffer() == this)
2338                 updateLabels(*this);
2339
2340         // clear references to children in macro tables
2341         d->children_positions.clear();
2342         d->position_to_children.clear();
2343 }
2344
2345
2346 void Buffer::loadChildDocuments() const
2347 {
2348         bool parse_error = false;
2349
2350         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2351                 if (it->lyxCode() != INCLUDE_CODE)
2352                         continue;
2353                 InsetCommand const & inset = static_cast<InsetCommand const &>(*it);
2354                 InsetCommandParams const & ip = inset.params();
2355                 Buffer * child = loadIfNeeded(*this, ip);
2356                 if (!child)
2357                         continue;
2358                 parse_error |= !child->errorList("Parse").empty();
2359                 child->loadChildDocuments();
2360         }
2361
2362         if (use_gui && masterBuffer() == this)
2363                 updateLabels(*this);
2364
2365         updateMacros();
2366 }
2367
2368
2369 string Buffer::bufferFormat() const
2370 {
2371         if (isDocBook())
2372                 return "docbook";
2373         if (isLiterate())
2374                 return "literate";
2375         return "latex";
2376 }
2377
2378
2379 bool Buffer::doExport(string const & format, bool put_in_tempdir,
2380         string & result_file) const
2381 {
2382         string backend_format;
2383         OutputParams runparams(&params().encoding());
2384         runparams.flavor = OutputParams::LATEX;
2385         runparams.linelen = lyxrc.plaintext_linelen;
2386         vector<string> backs = backends();
2387         if (find(backs.begin(), backs.end(), format) == backs.end()) {
2388                 // Get shortest path to format
2389                 Graph::EdgePath path;
2390                 for (vector<string>::const_iterator it = backs.begin();
2391                      it != backs.end(); ++it) {
2392                         Graph::EdgePath p = theConverters().getPath(*it, format);
2393                         if (!p.empty() && (path.empty() || p.size() < path.size())) {
2394                                 backend_format = *it;
2395                                 path = p;
2396                         }
2397                 }
2398                 if (!path.empty())
2399                         runparams.flavor = theConverters().getFlavor(path);
2400                 else {
2401                         Alert::error(_("Couldn't export file"),
2402                                 bformat(_("No information for exporting the format %1$s."),
2403                                    formats.prettyName(format)));
2404                         return false;
2405                 }
2406         } else {
2407                 backend_format = format;
2408                 // FIXME: Don't hardcode format names here, but use a flag
2409                 if (backend_format == "pdflatex")
2410                         runparams.flavor = OutputParams::PDFLATEX;
2411         }
2412
2413         string filename = latexName(false);
2414         filename = addName(temppath(), filename);
2415         filename = changeExtension(filename,
2416                                    formats.extension(backend_format));
2417
2418         // fix macros
2419         updateMacroInstances();
2420
2421         // Plain text backend
2422         if (backend_format == "text")
2423                 writePlaintextFile(*this, FileName(filename), runparams);
2424         // no backend
2425         else if (backend_format == "lyx")
2426                 writeFile(FileName(filename));
2427         // Docbook backend
2428         else if (isDocBook()) {
2429                 runparams.nice = !put_in_tempdir;
2430                 makeDocBookFile(FileName(filename), runparams);
2431         }
2432         // LaTeX backend
2433         else if (backend_format == format) {
2434                 runparams.nice = true;
2435                 if (!makeLaTeXFile(FileName(filename), string(), runparams))
2436                         return false;
2437         } else if (!lyxrc.tex_allows_spaces
2438                    && contains(filePath(), ' ')) {
2439                 Alert::error(_("File name error"),
2440                            _("The directory path to the document cannot contain spaces."));
2441                 return false;
2442         } else {
2443                 runparams.nice = false;
2444                 if (!makeLaTeXFile(FileName(filename), filePath(), runparams))
2445                         return false;
2446         }
2447
2448         string const error_type = (format == "program")
2449                 ? "Build" : bufferFormat();
2450         string const ext = formats.extension(format);
2451         FileName const tmp_result_file(changeExtension(filename, ext));
2452         bool const success = theConverters().convert(this, FileName(filename),
2453                 tmp_result_file, FileName(absFileName()), backend_format, format,
2454                 errorList(error_type));
2455         // Emit the signal to show the error list.
2456         if (format != backend_format)
2457                 errors(error_type);
2458         if (!success)
2459                 return false;
2460
2461         if (put_in_tempdir)
2462                 result_file = tmp_result_file.absFilename();
2463         else {
2464                 result_file = changeExtension(absFileName(), ext);
2465                 // We need to copy referenced files (e. g. included graphics
2466                 // if format == "dvi") to the result dir.
2467                 vector<ExportedFile> const files =
2468                         runparams.exportdata->externalFiles(format);
2469                 string const dest = onlyPath(result_file);
2470                 CopyStatus status = SUCCESS;
2471                 for (vector<ExportedFile>::const_iterator it = files.begin();
2472                                 it != files.end() && status != CANCEL; ++it) {
2473                         string const fmt =
2474                                 formats.getFormatFromFile(it->sourceName);
2475                         status = copyFile(fmt, it->sourceName,
2476                                           makeAbsPath(it->exportName, dest),
2477                                           it->exportName, status == FORCE);
2478                 }
2479                 if (status == CANCEL) {
2480                         message(_("Document export cancelled."));
2481                 } else if (tmp_result_file.exists()) {
2482                         // Finally copy the main file
2483                         status = copyFile(format, tmp_result_file,
2484                                           FileName(result_file), result_file,
2485                                           status == FORCE);
2486                         message(bformat(_("Document exported as %1$s "
2487                                                                "to file `%2$s'"),
2488                                                 formats.prettyName(format),
2489                                                 makeDisplayPath(result_file)));
2490                 } else {
2491                         // This must be a dummy converter like fax (bug 1888)
2492                         message(bformat(_("Document exported as %1$s"),
2493                                                 formats.prettyName(format)));
2494                 }
2495         }
2496
2497         return true;
2498 }
2499
2500
2501 bool Buffer::doExport(string const & format, bool put_in_tempdir) const
2502 {
2503         string result_file;
2504         return doExport(format, put_in_tempdir, result_file);
2505 }
2506
2507
2508 bool Buffer::preview(string const & format) const
2509 {
2510         string result_file;
2511         if (!doExport(format, true, result_file))
2512                 return false;
2513         return formats.view(*this, FileName(result_file), format);
2514 }
2515
2516
2517 bool Buffer::isExportable(string const & format) const
2518 {
2519         vector<string> backs = backends();
2520         for (vector<string>::const_iterator it = backs.begin();
2521              it != backs.end(); ++it)
2522                 if (theConverters().isReachable(*it, format))
2523                         return true;
2524         return false;
2525 }
2526
2527
2528 vector<Format const *> Buffer::exportableFormats(bool only_viewable) const
2529 {
2530         vector<string> backs = backends();
2531         vector<Format const *> result =
2532                 theConverters().getReachable(backs[0], only_viewable, true);
2533         for (vector<string>::const_iterator it = backs.begin() + 1;
2534              it != backs.end(); ++it) {
2535                 vector<Format const *>  r =
2536                         theConverters().getReachable(*it, only_viewable, false);
2537                 result.insert(result.end(), r.begin(), r.end());
2538         }
2539         return result;
2540 }
2541
2542
2543 vector<string> Buffer::backends() const
2544 {
2545         vector<string> v;
2546         if (params().getTextClass().isTeXClassAvailable()) {
2547                 v.push_back(bufferFormat());
2548                 // FIXME: Don't hardcode format names here, but use a flag
2549                 if (v.back() == "latex")
2550                         v.push_back("pdflatex");
2551         }
2552         v.push_back("text");
2553         v.push_back("lyx");
2554         return v;
2555 }
2556
2557
2558 bool Buffer::readFileHelper(FileName const & s)
2559 {
2560         // File information about normal file
2561         if (!s.exists()) {
2562                 docstring const file = makeDisplayPath(s.absFilename(), 50);
2563                 docstring text = bformat(_("The specified document\n%1$s"
2564                                                      "\ncould not be read."), file);
2565                 Alert::error(_("Could not read document"), text);
2566                 return false;
2567         }
2568
2569         // Check if emergency save file exists and is newer.
2570         FileName const e(s.absFilename() + ".emergency");
2571
2572         if (e.exists() && s.exists() && e.lastModified() > s.lastModified()) {
2573                 docstring const file = makeDisplayPath(s.absFilename(), 20);
2574                 docstring const text =
2575                         bformat(_("An emergency save of the document "
2576                                   "%1$s exists.\n\n"
2577                                                "Recover emergency save?"), file);
2578                 switch (Alert::prompt(_("Load emergency save?"), text, 0, 2,
2579                                       _("&Recover"),  _("&Load Original"),
2580                                       _("&Cancel")))
2581                 {
2582                 case 0:
2583                         // the file is not saved if we load the emergency file.
2584                         markDirty();
2585                         return readFile(e);
2586                 case 1:
2587                         break;
2588                 default:
2589                         return false;
2590                 }
2591         }
2592
2593         // Now check if autosave file is newer.
2594         FileName const a(onlyPath(s.absFilename()) + '#' + onlyFilename(s.absFilename()) + '#');
2595
2596         if (a.exists() && s.exists() && a.lastModified() > s.lastModified()) {
2597                 docstring const file = makeDisplayPath(s.absFilename(), 20);
2598                 docstring const text =
2599                         bformat(_("The backup of the document "
2600                                   "%1$s is newer.\n\nLoad the "
2601                                                "backup instead?"), file);
2602                 switch (Alert::prompt(_("Load backup?"), text, 0, 2,
2603                                       _("&Load backup"), _("Load &original"),
2604                                       _("&Cancel") ))
2605                 {
2606                 case 0:
2607                         // the file is not saved if we load the autosave file.
2608                         markDirty();
2609                         return readFile(a);
2610                 case 1:
2611                         // Here we delete the autosave
2612                         a.removeFile();
2613                         break;
2614                 default:
2615                         return false;
2616                 }
2617         }
2618         return readFile(s);
2619 }
2620
2621
2622 bool Buffer::loadLyXFile(FileName const & s)
2623 {
2624         if (s.isReadableFile()) {
2625                 if (readFileHelper(s)) {
2626                         lyxvc().file_found_hook(s);
2627                         if (!s.isWritable())
2628                                 setReadonly(true);
2629                         return true;
2630                 }
2631         } else {
2632                 docstring const file = makeDisplayPath(s.absFilename(), 20);
2633                 // Here we probably should run
2634                 if (LyXVC::file_not_found_hook(s)) {
2635                         docstring const text =
2636                                 bformat(_("Do you want to retrieve the document"
2637                                                        " %1$s from version control?"), file);
2638                         int const ret = Alert::prompt(_("Retrieve from version control?"),
2639                                 text, 0, 1, _("&Retrieve"), _("&Cancel"));
2640
2641                         if (ret == 0) {
2642                                 // How can we know _how_ to do the checkout?
2643                                 // With the current VC support it has to be,
2644                                 // a RCS file since CVS do not have special ,v files.
2645                                 RCS::retrieve(s);
2646                                 return loadLyXFile(s);
2647                         }
2648                 }
2649         }
2650         return false;
2651 }
2652
2653
2654 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
2655 {
2656         TeXErrors::Errors::const_iterator cit = terr.begin();
2657         TeXErrors::Errors::const_iterator end = terr.end();
2658
2659         for (; cit != end; ++cit) {
2660                 int id_start = -1;
2661                 int pos_start = -1;
2662                 int errorRow = cit->error_in_line;
2663                 bool found = d->texrow.getIdFromRow(errorRow, id_start,
2664                                                        pos_start);
2665                 int id_end = -1;
2666                 int pos_end = -1;
2667                 do {
2668                         ++errorRow;
2669                         found = d->texrow.getIdFromRow(errorRow, id_end, pos_end);
2670                 } while (found && id_start == id_end && pos_start == pos_end);
2671
2672                 errorList.push_back(ErrorItem(cit->error_desc,
2673                         cit->error_text, id_start, pos_start, pos_end));
2674         }
2675 }
2676
2677 } // namespace lyx