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  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "Buffer.h"
  14
  15 #include "Author.h"
  16 #include "BiblioInfo.h"
  17 #include "BranchList.h"
  18 #include "buffer_funcs.h"
  19 #include "BufferList.h"
  20 #include "BufferParams.h"
  21 #include "Counters.h"
  22 #include "Bullet.h"
  23 #include "Chktex.h"
  24 #include "debug.h"
  25 #include "DocIterator.h"
  26 #include "Encoding.h"
  27 #include "ErrorList.h"
  28 #include "Exporter.h"
  29 #include "Format.h"
  30 #include "FuncRequest.h"
  31 #include "gettext.h"
  32 #include "InsetIterator.h"
  33 #include "Language.h"
  34 #include "LaTeX.h"
  35 #include "LaTeXFeatures.h"
  36 #include "LyXAction.h"
  37 #include "Lexer.h"
  38 #include "Text.h"
  39 #include "LyX.h"
  40 #include "LyXRC.h"
  41 #include "LyXVC.h"
  42 #include "Messages.h"
  43 #include "output.h"
  44 #include "output_docbook.h"
  45 #include "output_latex.h"
  46 #include "Paragraph.h"
  47 #include "paragraph_funcs.h"
  48 #include "ParagraphParameters.h"
  49 #include "ParIterator.h"
  50 #include "sgml.h"
  51 #include "TexRow.h"
  52 #include "TextClassList.h"
  53 #include "TexStream.h"
  54 #include "TocBackend.h"
  55 #include "Undo.h"
  56 #include "version.h"
  57 #include "EmbeddedFiles.h"
  58
  59 #include "insets/InsetBibitem.h"
  60 #include "insets/InsetBibtex.h"
  61 #include "insets/InsetInclude.h"
  62 #include "insets/InsetText.h"
  63
  64 #include "mathed/MathMacroTemplate.h"
  65 #include "mathed/MacroTable.h"
  66 #include "mathed/MathSupport.h"
  67
  68 #include "frontends/alert.h"
  69
  70 #include "graphics/Previews.h"
  71
  72 #include "support/types.h"
  73 #include "support/lyxalgo.h"
  74 #include "support/filetools.h"
  75 #include "support/fs_extras.h"
  76 #include "support/gzstream.h"
  77 #include "support/lyxlib.h"
  78 #include "support/os.h"
  79 #include "support/Path.h"
  80 #include "support/textutils.h"
  81 #include "support/convert.h"
  82
  83 #include <boost/bind.hpp>
  84 #include <boost/filesystem/exception.hpp>
  85 #include <boost/filesystem/operations.hpp>
  86
  87 #include <algorithm>
  88 #include <iomanip>
  89 #include <stack>
  90 #include <sstream>
  91 #include <fstream>
  92
  93 using std::endl;
  94 using std::for_each;
  95 using std::make_pair;
  96
  97 using std::ios;
  98 using std::map;
  99 using std::ostream;
 100 using std::ostringstream;
 101 using std::ofstream;
 102 using std::ifstream;
 103 using std::pair;
 104 using std::stack;
 105 using std::vector;
 106 using std::string;
 107 using std::time_t;
 108
 109
 110 namespace lyx {
 111
 112 using support::addName;
 113 using support::bformat;
 114 using support::changeExtension;
 115 using support::cmd_ret;
 116 using support::createBufferTmpDir;
 117 using support::destroyDir;
 118 using support::FileName;
 119 using support::getFormatFromContents;
 120 using support::libFileSearch;
 121 using support::latex_path;
 122 using support::ltrim;
 123 using support::makeAbsPath;
 124 using support::makeDisplayPath;
 125 using support::makeLatexName;
 126 using support::onlyFilename;
 127 using support::onlyPath;
 128 using support::quoteName;
 129 using support::removeAutosaveFile;
 130 using support::rename;
 131 using support::runCommand;
 132 using support::split;
 133 using support::subst;
 134 using support::tempName;
 135 using support::trim;
 136 using support::sum;
 137 using support::suffixIs;
 138
 139 namespace Alert = frontend::Alert;
 140 namespace os = support::os;
 141 namespace fs = boost::filesystem;
 142
 143 namespace {
 144
 145 int const LYX_FORMAT = 283;
 146
 147 } // namespace anon
 148
 149
 150 typedef std::map<string, bool> DepClean;
 151
 152 class Buffer::Impl
 153 {
 154 public:
 155         Impl(Buffer & parent, FileName const & file, bool readonly);
 156
 157         limited_stack<Undo> undostack;
 158         limited_stack<Undo> redostack;
 159         BufferParams params;
 160         LyXVC lyxvc;
 161         string temppath;
 162         TexRow texrow;
 163
 164         /// need to regenerate .tex?
 165         DepClean dep_clean;
 166
 167         /// is save needed?
 168         mutable bool lyx_clean;
 169
 170         /// is autosave needed?
 171         mutable bool bak_clean;
 172
 173         /// is this a unnamed file (New...)?
 174         bool unnamed;
 175
 176         /// buffer is r/o
 177         bool read_only;
 178
 179         /// name of the file the buffer is associated with.
 180         FileName filename;
 181
 182         /** Set to true only when the file is fully loaded.
 183          *  Used to prevent the premature generation of previews
 184          *  and by the citation inset.
 185          */
 186         bool file_fully_loaded;
 187
 188         /// our Text that should be wrapped in an InsetText
 189         InsetText inset;
 190
 191         ///
 192         MacroTable macros;
 193
 194         ///
 195         TocBackend toc_backend;
 196
 197         /// Container for all sort of Buffer dependant errors.
 198         map<string, ErrorList> errorLists;
 199
 200         /// all embedded files of this buffer
 201         EmbeddedFiles embedded_files;
 202
 203         /// timestamp and checksum used to test if the file has been externally
 204         /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
 205         time_t timestamp_;
 206         unsigned long checksum_;
 207 };
 208
 209
 210 Buffer::Impl::Impl(Buffer & parent, FileName const & file, bool readonly_)
 211         : lyx_clean(true), bak_clean(true), unnamed(false), read_only(readonly_),
 212           filename(file), file_fully_loaded(false), inset(params),
 213           toc_backend(&parent), embedded_files(&parent), timestamp_(0), checksum_(0)
 214 {
 215         inset.setAutoBreakRows(true);
 216         lyxvc.buffer(&parent);
 217         temppath = createBufferTmpDir();
 218         params.filepath = onlyPath(file.absFilename());
 219         // FIXME: And now do something if temppath == string(), because we
 220         // assume from now on that temppath points to a valid temp dir.
 221         // See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg67406.html
 222 }
 223
 224
 225 Buffer::Buffer(string const & file, bool readonly)
 226         : pimpl_(new Impl(*this, FileName(file), readonly))
 227 {
 228         LYXERR(Debug::INFO) << "Buffer::Buffer()" << endl;
 229 }
 230
 231
 232 Buffer::~Buffer()
 233 {
 234         LYXERR(Debug::INFO) << "Buffer::~Buffer()" << endl;
 235         // here the buffer should take care that it is
 236         // saved properly, before it goes into the void.
 237
 238         Buffer * master = getMasterBuffer();
 239         if (master != this && use_gui)
 240                 // We are closing buf which was a child document so we
 241                 // must update the labels and section numbering of its master
 242                 // Buffer.
 243                 updateLabels(*master);
 244
 245         if (!temppath().empty() && !destroyDir(FileName(temppath()))) {
 246                 Alert::warning(_("Could not remove temporary directory"),
 247                         bformat(_("Could not remove the temporary directory %1$s"),
 248                         from_utf8(temppath())));
 249         }
 250
 251         // Remove any previewed LaTeX snippets associated with this buffer.
 252         graphics::Previews::get().removeLoader(*this);
 253
 254         closing(this);
 255 }
 256
 257
 258 Text & Buffer::text() const
 259 {
 260         return const_cast<Text &>(pimpl_->inset.text_);
 261 }
 262
 263
 264 Inset & Buffer::inset() const
 265 {
 266         return const_cast<InsetText &>(pimpl_->inset);
 267 }
 268
 269
 270 limited_stack<Undo> & Buffer::undostack()
 271 {
 272         return pimpl_->undostack;
 273 }
 274
 275
 276 limited_stack<Undo> const & Buffer::undostack() const
 277 {
 278         return pimpl_->undostack;
 279 }
 280
 281
 282 limited_stack<Undo> & Buffer::redostack()
 283 {
 284         return pimpl_->redostack;
 285 }
 286
 287
 288 limited_stack<Undo> const & Buffer::redostack() const
 289 {
 290         return pimpl_->redostack;
 291 }
 292
 293
 294 BufferParams & Buffer::params()
 295 {
 296         return pimpl_->params;
 297 }
 298
 299
 300 BufferParams const & Buffer::params() const
 301 {
 302         return pimpl_->params;
 303 }
 304
 305
 306 ParagraphList & Buffer::paragraphs()
 307 {
 308         return text().paragraphs();
 309 }
 310
 311
 312 ParagraphList const & Buffer::paragraphs() const
 313 {
 314         return text().paragraphs();
 315 }
 316
 317
 318 LyXVC & Buffer::lyxvc()
 319 {
 320         return pimpl_->lyxvc;
 321 }
 322
 323
 324 LyXVC const & Buffer::lyxvc() const
 325 {
 326         return pimpl_->lyxvc;
 327 }
 328
 329
 330 string const & Buffer::temppath() const
 331 {
 332         return pimpl_->temppath;
 333 }
 334
 335
 336 TexRow & Buffer::texrow()
 337 {
 338         return pimpl_->texrow;
 339 }
 340
 341
 342 TexRow const & Buffer::texrow() const
 343 {
 344         return pimpl_->texrow;
 345 }
 346
 347
 348 TocBackend & Buffer::tocBackend()
 349 {
 350         return pimpl_->toc_backend;
 351 }
 352
 353
 354 TocBackend const & Buffer::tocBackend() const
 355 {
 356         return pimpl_->toc_backend;
 357 }
 358
 359
 360 EmbeddedFiles & Buffer::embeddedFiles()
 361 {
 362         return pimpl_->embedded_files;
 363 }
 364
 365
 366 EmbeddedFiles const & Buffer::embeddedFiles() const
 367 {
 368         return pimpl_->embedded_files;
 369 }
 370
 371
 372 string const Buffer::getLatexName(bool const no_path) const
 373 {
 374         string const name = changeExtension(makeLatexName(fileName()), ".tex");
 375         return no_path ? onlyFilename(name) : name;
 376 }
 377
 378
 379 pair<Buffer::LogType, string> const Buffer::getLogName() const
 380 {
 381         string const filename = getLatexName(false);
 382
 383         if (filename.empty())
 384                 return make_pair(Buffer::latexlog, string());
 385
 386         string const path = temppath();
 387
 388         FileName const fname(addName(temppath(),
 389                                      onlyFilename(changeExtension(filename,
 390                                                                   ".log"))));
 391         FileName const bname(
 392                 addName(path, onlyFilename(
 393                         changeExtension(filename,
 394                                         formats.extension("literate") + ".out"))));
 395
 396         // If no Latex log or Build log is newer, show Build log
 397
 398         if (fs::exists(bname.toFilesystemEncoding()) &&
 399             (!fs::exists(fname.toFilesystemEncoding()) ||
 400              fs::last_write_time(fname.toFilesystemEncoding()) < fs::last_write_time(bname.toFilesystemEncoding()))) {
 401                 LYXERR(Debug::FILES) << "Log name calculated as: " << bname << endl;
 402                 return make_pair(Buffer::buildlog, bname.absFilename());
 403         }
 404         LYXERR(Debug::FILES) << "Log name calculated as: " << fname << endl;
 405         return make_pair(Buffer::latexlog, fname.absFilename());
 406 }
 407
 408
 409 void Buffer::setReadonly(bool const flag)
 410 {
 411         if (pimpl_->read_only != flag) {
 412                 pimpl_->read_only = flag;
 413                 readonly(flag);
 414         }
 415 }
 416
 417
 418 void Buffer::setFileName(string const & newfile)
 419 {
 420         pimpl_->filename = makeAbsPath(newfile);
 421         params().filepath = onlyPath(pimpl_->filename.absFilename());
 422         setReadonly(fs::is_readonly(pimpl_->filename.toFilesystemEncoding()));
 423         updateTitles();
 424 }
 425
 426
 427 // We'll remove this later. (Lgb)
 428 namespace {
 429
 430 void unknownClass(string const & unknown)
 431 {
 432         Alert::warning(_("Unknown document class"),
 433                        bformat(_("Using the default document class, because the "
 434                                               "class %1$s is unknown."), from_utf8(unknown)));
 435 }
 436
 437 } // anon
 438
 439
 440 int Buffer::readHeader(Lexer & lex)
 441 {
 442         int unknown_tokens = 0;
 443         int line = -1;
 444         int begin_header_line = -1;
 445
 446         // Initialize parameters that may be/go lacking in header:
 447         params().branchlist().clear();
 448         params().preamble.erase();
 449         params().options.erase();
 450         params().float_placement.erase();
 451         params().paperwidth.erase();
 452         params().paperheight.erase();
 453         params().leftmargin.erase();
 454         params().rightmargin.erase();
 455         params().topmargin.erase();
 456         params().bottommargin.erase();
 457         params().headheight.erase();
 458         params().headsep.erase();
 459         params().footskip.erase();
 460         params().listings_params.clear();
 461         params().clearLayoutModules();
 462
 463         for (int i = 0; i < 4; ++i) {
 464                 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
 465                 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
 466         }
 467
 468         ErrorList & errorList = pimpl_->errorLists["Parse"];
 469
 470         while (lex.isOK()) {
 471                 lex.next();
 472                 string const token = lex.getString();
 473
 474                 if (token.empty())
 475                         continue;
 476
 477                 if (token == "\\end_header")
 478                         break;
 479
 480                 ++line;
 481                 if (token == "\\begin_header") {
 482                         begin_header_line = line;
 483                         continue;
 484                 }
 485
 486                 LYXERR(Debug::PARSER) << "Handling document header token: `"
 487                                       << token << '\'' << endl;
 488
 489                 string unknown = params().readToken(lex, token);
 490                 if (!unknown.empty()) {
 491                         if (unknown[0] != '\\' && token == "\\textclass") {
 492                                 unknownClass(unknown);
 493                         } else {
 494                                 ++unknown_tokens;
 495                                 docstring const s = bformat(_("Unknown token: "
 496                                                                         "%1$s %2$s\n"),
 497                                                          from_utf8(token),
 498                                                          lex.getDocString());
 499                                 errorList.push_back(ErrorItem(_("Document header error"),
 500                                         s, -1, 0, 0));
 501                         }
 502                 }
 503         }
 504         if (begin_header_line) {
 505                 docstring const s = _("\\begin_header is missing");
 506                 errorList.push_back(ErrorItem(_("Document header error"),
 507                         s, -1, 0, 0));
 508         }
 509
 510         return unknown_tokens;
 511 }
 512
 513
 514 // Uwe C. Schroeder
 515 // changed to be public and have one parameter
 516 // Returns false if "\end_document" is not read (Asger)
 517 bool Buffer::readDocument(Lexer & lex)
 518 {
 519         ErrorList & errorList = pimpl_->errorLists["Parse"];
 520         errorList.clear();
 521
 522         lex.next();
 523         string const token = lex.getString();
 524         if (token != "\\begin_document") {
 525                 docstring const s = _("\\begin_document is missing");
 526                 errorList.push_back(ErrorItem(_("Document header error"),
 527                         s, -1, 0, 0));
 528         }
 529
 530         // we are reading in a brand new document
 531         BOOST_ASSERT(paragraphs().empty());
 532
 533         readHeader(lex);
 534         TextClass const & baseClass = textclasslist[params().getBaseClass()];
 535         if (!baseClass.load(filePath())) {
 536                 string theclass = baseClass.name();
 537                 Alert::error(_("Can't load document class"), bformat(
 538                         _("Using the default document class, because the "
 539                                      "class %1$s could not be loaded."), from_utf8(theclass)));
 540                 params().setBaseClass(defaultTextclass());
 541         }
 542
 543         if (params().outputChanges) {
 544                 bool dvipost    = LaTeXFeatures::isAvailable("dvipost");
 545                 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
 546                                   LaTeXFeatures::isAvailable("xcolor");
 547
 548                 if (!dvipost && !xcolorsoul) {
 549                         Alert::warning(_("Changes not shown in LaTeX output"),
 550                                        _("Changes will not be highlighted in LaTeX output, "
 551                                          "because neither dvipost nor xcolor/soul are installed.\n"
 552                                          "Please install these packages or redefine "
 553                                          "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
 554                 } else if (!xcolorsoul) {
 555                         Alert::warning(_("Changes not shown in LaTeX output"),
 556                                        _("Changes will not be highlighted in LaTeX output "
 557                                          "when using pdflatex, because xcolor and soul are not installed.\n"
 558                                          "Please install both packages or redefine "
 559                                          "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
 560                 }
 561         }
 562
 563         bool const res = text().read(*this, lex, errorList);
 564         for_each(text().paragraphs().begin(),
 565                  text().paragraphs().end(),
 566                  bind(&Paragraph::setInsetOwner, _1, &inset()));
 567
 568         return res;
 569 }
 570
 571
 572 // needed to insert the selection
 573 void Buffer::insertStringAsLines(ParagraphList & pars,
 574         pit_type & pit, pos_type & pos,
 575         Font const & fn, docstring const & str, bool autobreakrows)
 576 {
 577         Font font = fn;
 578
 579         // insert the string, don't insert doublespace
 580         bool space_inserted = true;
 581         for (docstring::const_iterator cit = str.begin();
 582             cit != str.end(); ++cit) {
 583                 Paragraph & par = pars[pit];
 584                 if (*cit == '\n') {
 585                         if (autobreakrows && (!par.empty() || par.allowEmpty())) {
 586                                 breakParagraph(params(), pars, pit, pos,
 587                                                par.layout()->isEnvironment());
 588                                 ++pit;
 589                                 pos = 0;
 590                                 space_inserted = true;
 591                         } else {
 592                                 continue;
 593                         }
 594                         // do not insert consecutive spaces if !free_spacing
 595                 } else if ((*cit == ' ' || *cit == '\t') &&
 596                            space_inserted && !par.isFreeSpacing()) {
 597                         continue;
 598                 } else if (*cit == '\t') {
 599                         if (!par.isFreeSpacing()) {
 600                                 // tabs are like spaces here
 601                                 par.insertChar(pos, ' ', font, params().trackChanges);
 602                                 ++pos;
 603                                 space_inserted = true;
 604                         } else {
 605                                 const pos_type n = 8 - pos % 8;
 606                                 for (pos_type i = 0; i < n; ++i) {
 607                                         par.insertChar(pos, ' ', font, params().trackChanges);
 608                                         ++pos;
 609                                 }
 610                                 space_inserted = true;
 611                         }
 612                 } else if (!isPrintable(*cit)) {
 613                         // Ignore unprintables
 614                         continue;
 615                 } else {
 616                         // just insert the character
 617                         par.insertChar(pos, *cit, font, params().trackChanges);
 618                         ++pos;
 619                         space_inserted = (*cit == ' ');
 620                 }
 621
 622         }
 623 }
 624
 625
 626 bool Buffer::readString(std::string const & s)
 627 {
 628         params().compressed = false;
 629
 630         // remove dummy empty par
 631         paragraphs().clear();
 632         Lexer lex(0, 0);
 633         std::istringstream is(s);
 634         lex.setStream(is);
 635         FileName const name(tempName());
 636         switch (readFile(lex, name, true)) {
 637         case failure:
 638                 return false;
 639         case wrongversion: {
 640                 // We need to call lyx2lyx, so write the input to a file
 641                 std::ofstream os(name.toFilesystemEncoding().c_str());
 642                 os << s;
 643                 os.close();
 644                 return readFile(name);
 645         }
 646         case success:
 647                 break;
 648         }
 649
 650         return true;
 651 }
 652
 653
 654 bool Buffer::readFile(FileName const & filename)
 655 {
 656         FileName fname(filename);
 657         // Check if the file is compressed.
 658         string format = getFormatFromContents(filename);
 659         if (format == "zip") {
 660                 // decompress to a temp directory
 661                 LYXERR(Debug::FILES) << filename << " is in zip format. Unzip to " << temppath() << endl;
 662                 ::unzipToDir(filename.toFilesystemEncoding(), temppath());
 663                 //
 664                 FileName manifest(addName(temppath(), "manifest.txt"));
 665                 FileName lyxfile(addName(temppath(),
 666                         onlyFilename(filename.toFilesystemEncoding())));
 667                 // if both manifest.txt and file.lyx exist, this is am embedded file
 668                 if (fs::exists(manifest.toFilesystemEncoding()) &&
 669                         fs::exists(lyxfile.toFilesystemEncoding())) {
 670                         params().embedded = true;
 671                         fname = lyxfile;
 672                         // read manifest file
 673                         ifstream is(manifest.toFilesystemEncoding().c_str());
 674                         is >> pimpl_->embedded_files;
 675                         is.close();
 676                         LYXERR(Debug::FILES) << filename << " is a embedded file. Its manifest is:\n"
 677                                         << pimpl_->embedded_files;
 678                 }
 679         }
 680         // The embedded lyx file can also be compressed, for backward compatibility
 681         format = getFormatFromContents(fname);
 682         if (format == "gzip" || format == "zip" || format == "compress") {
 683                 params().compressed = true;
 684         }
 685
 686         // remove dummy empty par
 687         paragraphs().clear();
 688         Lexer lex(0, 0);
 689         lex.setFile(fname);
 690         if (readFile(lex, fname) != success)
 691                 return false;
 692
 693         return true;
 694 }
 695
 696
 697 bool Buffer::fully_loaded() const
 698 {
 699         return pimpl_->file_fully_loaded;
 700 }
 701
 702
 703 void Buffer::fully_loaded(bool const value)
 704 {
 705         pimpl_->file_fully_loaded = value;
 706 }
 707
 708
 709 Buffer::ReadStatus Buffer::readFile(Lexer & lex, FileName const & filename,
 710                 bool fromstring)
 711 {
 712         BOOST_ASSERT(!filename.empty());
 713
 714         if (!lex.isOK()) {
 715                 Alert::error(_("Document could not be read"),
 716                              bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
 717                 return failure;
 718         }
 719
 720         lex.next();
 721         string const token(lex.getString());
 722
 723         if (!lex) {
 724                 Alert::error(_("Document could not be read"),
 725                              bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
 726                 return failure;
 727         }
 728
 729         // the first token _must_ be...
 730         if (token != "\\lyxformat") {
 731                 lyxerr << "Token: " << token << endl;
 732
 733                 Alert::error(_("Document format failure"),
 734                              bformat(_("%1$s is not a LyX document."),
 735                                        from_utf8(filename.absFilename())));
 736                 return failure;
 737         }
 738
 739         lex.next();
 740         string tmp_format = lex.getString();
 741         //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
 742         // if present remove ".," from string.
 743         string::size_type dot = tmp_format.find_first_of(".,");
 744         //lyxerr << "           dot found at " << dot << endl;
 745         if (dot != string::npos)
 746                         tmp_format.erase(dot, 1);
 747         int const file_format = convert<int>(tmp_format);
 748         //lyxerr << "format: " << file_format << endl;
 749
 750         // save timestamp and checksum of the original disk file, making sure
 751         // to not overwrite them with those of the file created in the tempdir
 752         // when it has to be converted to the current format.
 753         if (!pimpl_->checksum_) {
 754                 // Save the timestamp and checksum of disk file. If filename is an
 755                 // emergency file, save the timestamp and sum of the original lyx file
 756                 // because isExternallyModified will check for this file. (BUG4193)
 757                 string diskfile = filename.toFilesystemEncoding();
 758                 if (suffixIs(diskfile, ".emergency"))
 759                         diskfile = diskfile.substr(0, diskfile.size() - 10);
 760                 saveCheckSum(diskfile);
 761         }
 762
 763         if (file_format != LYX_FORMAT) {
 764
 765                 if (fromstring)
 766                         // lyx2lyx would fail
 767                         return wrongversion;
 768
 769                 FileName const tmpfile(tempName());
 770                 if (tmpfile.empty()) {
 771                         Alert::error(_("Conversion failed"),
 772                                      bformat(_("%1$s is from a different"
 773                                               " version of LyX, but a temporary"
 774                                               " file for converting it could"
 775                                                             " not be created."),
 776                                               from_utf8(filename.absFilename())));
 777                         return failure;
 778                 }
 779                 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
 780                 if (lyx2lyx.empty()) {
 781                         Alert::error(_("Conversion script not found"),
 782                                      bformat(_("%1$s is from a different"
 783                                                " version of LyX, but the"
 784                                                " conversion script lyx2lyx"
 785                                                             " could not be found."),
 786                                                from_utf8(filename.absFilename())));
 787                         return failure;
 788                 }
 789                 ostringstream command;
 790                 command << os::python()
 791                         << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
 792                         << " -t " << convert<string>(LYX_FORMAT)
 793                         << " -o " << quoteName(tmpfile.toFilesystemEncoding())
 794                         << ' ' << quoteName(filename.toFilesystemEncoding());
 795                 string const command_str = command.str();
 796
 797                 LYXERR(Debug::INFO) << "Running '"
 798                                     << command_str << '\''
 799                                     << endl;
 800
 801                 cmd_ret const ret = runCommand(command_str);
 802                 if (ret.first != 0) {
 803                         Alert::error(_("Conversion script failed"),
 804                                      bformat(_("%1$s is from a different version"
 805                                               " of LyX, but the lyx2lyx script"
 806                                                             " failed to convert it."),
 807                                               from_utf8(filename.absFilename())));
 808                         return failure;
 809                 } else {
 810                         bool const ret = readFile(tmpfile);
 811                         // Do stuff with tmpfile name and buffer name here.
 812                         return ret ? success : failure;
 813                 }
 814
 815         }
 816
 817         if (readDocument(lex)) {
 818                 Alert::error(_("Document format failure"),
 819                              bformat(_("%1$s ended unexpectedly, which means"
 820                                                     " that it is probably corrupted."),
 821                                        from_utf8(filename.absFilename())));
 822         }
 823
 824         //lyxerr << "removing " << MacroTable::localMacros().size()
 825         //      << " temporary macro entries" << endl;
 826         //MacroTable::localMacros().clear();
 827
 828         pimpl_->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 = pimpl_->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 && fs::exists(encodedFilename)) {
 846                 backupName = FileName(fileName() + '~');
 847                 if (!lyxrc.backupdir_path.empty())
 848                         backupName = FileName(addName(lyxrc.backupdir_path,
 849                                               subst(os::internal_path(backupName.absFilename()), '/', '!')));
 850
 851                 try {
 852                         fs::copy_file(encodedFilename, backupName.toFilesystemEncoding(), false);
 853                         madeBackup = true;
 854                 } catch (fs::filesystem_error const & fe) {
 855                         Alert::error(_("Backup failure"),
 856                                      bformat(_("Cannot create backup file %1$s.\n"
 857                                                "Please check whether the directory exists and is writeable."),
 858                                              from_utf8(backupName.absFilename())));
 859                         LYXERR(Debug::DEBUG) << "Fs error: " << fe.what() << endl;
 860                 }
 861         }
 862
 863         // ask if the disk file has been externally modified (use checksum method)
 864         if (fs::exists(encodedFilename) && isExternallyModified(checksum_method)) {
 865                 docstring const file = makeDisplayPath(fileName(), 20);
 866                 docstring text = bformat(_("Document %1$s has been externally modified. Are you sure "
 867                                                              "you want to overwrite this file?"), file);
 868                 int const ret = Alert::prompt(_("Overwrite modified file?"),
 869                         text, 1, 1, _("&Overwrite"), _("&Cancel"));
 870                 if (ret == 1)
 871                         return false;
 872         }
 873
 874         if (writeFile(pimpl_->filename)) {
 875                 markClean();
 876                 removeAutosaveFile(fileName());
 877                 saveCheckSum(pimpl_->filename.toFilesystemEncoding());
 878                 return true;
 879         } else {
 880                 // Saving failed, so backup is not backup
 881                 if (madeBackup)
 882                         rename(backupName, pimpl_->filename);
 883                 return false;
 884         }
 885 }
 886
 887
 888 bool Buffer::writeFile(FileName const & fname) const
 889 {
 890         if (pimpl_->read_only && fname == pimpl_->filename)
 891                 return false;
 892
 893         bool retval = false;
 894
 895         FileName content;
 896         if (params().embedded)
 897                 // first write the .lyx file to the temporary directory
 898                 content = FileName(addName(temppath(),
 899                         onlyFilename(fname.toFilesystemEncoding())));
 900         else
 901                 content = fname;
 902
 903         if (params().compressed) {
 904                 gz::ogzstream ofs(content.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
 905                 if (!ofs)
 906                         return false;
 907
 908                 retval = write(ofs);
 909         } else {
 910                 ofstream ofs(content.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
 911                 if (!ofs)
 912                         return false;
 913
 914                 retval = write(ofs);
 915         }
 916
 917         if (retval && params().embedded) {
 918                 // write file.lyx and all the embedded files to the zip file fname
 919                 // if embedding is enabled, and there is any embedded file
 920                 pimpl_->embedded_files.update();
 921                 return pimpl_->embedded_files.write(fname);
 922         }
 923         return retval;
 924 }
 925
 926
 927 bool Buffer::write(ostream & ofs) const
 928 {
 929 #ifdef HAVE_LOCALE
 930         // Use the standard "C" locale for file output.
 931         ofs.imbue(std::locale::classic());
 932 #endif
 933
 934         // The top of the file should not be written by params().
 935
 936         // write out a comment in the top of the file
 937         ofs << "#LyX " << lyx_version
 938             << " created this file. For more info see http://www.lyx.org/\n"
 939             << "\\lyxformat " << LYX_FORMAT << "\n"
 940             << "\\begin_document\n";
 941
 942
 943         /// For each author, set 'used' to true if there is a change
 944         /// by this author in the document; otherwise set it to 'false'.
 945         AuthorList::Authors::const_iterator a_it = params().authors().begin();
 946         AuthorList::Authors::const_iterator a_end = params().authors().end();
 947         for (; a_it != a_end; ++a_it)
 948                 a_it->second.used(false);
 949
 950         ParIterator const end = par_iterator_end();
 951         ParIterator it = par_iterator_begin();
 952         for ( ; it != end; ++it)
 953                 it->checkAuthors(params().authors());
 954
 955         // now write out the buffer parameters.
 956         ofs << "\\begin_header\n";
 957         params().writeFile(ofs);
 958         ofs << "\\end_header\n";
 959
 960         // write the text
 961         ofs << "\n\\begin_body\n";
 962         text().write(*this, ofs);
 963         ofs << "\n\\end_body\n";
 964
 965         // Write marker that shows file is complete
 966         ofs << "\\end_document" << endl;
 967
 968         // Shouldn't really be needed....
 969         //ofs.close();
 970
 971         // how to check if close went ok?
 972         // Following is an attempt... (BE 20001011)
 973
 974         // good() returns false if any error occured, including some
 975         //        formatting error.
 976         // bad()  returns true if something bad happened in the buffer,
 977         //        which should include file system full errors.
 978
 979         bool status = true;
 980         if (!ofs) {
 981                 status = false;
 982                 lyxerr << "File was not closed properly." << endl;
 983         }
 984
 985         return status;
 986 }
 987
 988
 989 bool Buffer::makeLaTeXFile(FileName const & fname,
 990                            string const & original_path,
 991                            OutputParams const & runparams,
 992                            bool output_preamble, bool output_body)
 993 {
 994         string const encoding = runparams.encoding->iconvName();
 995         LYXERR(Debug::LATEX) << "makeLaTeXFile encoding: "
 996                 << encoding << "..." << endl;
 997
 998         odocfstream ofs(encoding);
 999         if (!openFileWrite(ofs, fname))
1000                 return false;
1001
1002         //TexStream ts(ofs.rdbuf(), &texrow());
1003
1004         bool failed_export = false;
1005         try {
1006                 texrow().reset();
1007                 writeLaTeXSource(ofs, original_path,
1008                       runparams, output_preamble, output_body);
1009         }
1010         catch (iconv_codecvt_facet_exception & e) {
1011                 lyxerr << "Caught iconv exception: " << e.what() << endl;
1012                 failed_export = true;
1013         }
1014         catch (std::exception const & e) {
1015                 lyxerr << "Caught \"normal\" exception: " << e.what() << endl;
1016                 failed_export = true;
1017         }
1018         catch (...) {
1019                 lyxerr << "Caught some really weird exception..." << endl;
1020                 LyX::cref().emergencyCleanup();
1021                 abort();
1022         }
1023
1024         ofs.close();
1025         if (ofs.fail()) {
1026                 failed_export = true;
1027                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1028         }
1029
1030         if (failed_export) {
1031                 Alert::error(_("Encoding error"),
1032                         _("Some characters of your document are probably not "
1033                         "representable in the chosen encoding.\n"
1034                         "Changing the document encoding to utf8 could help."));
1035                 return false;
1036         }
1037         return true;
1038 }
1039
1040
1041 void Buffer::writeLaTeXSource(odocstream & os,
1042                            string const & original_path,
1043                            OutputParams const & runparams_in,
1044                            bool const output_preamble, bool const output_body)
1045 {
1046         OutputParams runparams = runparams_in;
1047
1048         // validate the buffer.
1049         LYXERR(Debug::LATEX) << "  Validating buffer..." << endl;
1050         LaTeXFeatures features(*this, params(), runparams);
1051         validate(features);
1052         LYXERR(Debug::LATEX) << "  Buffer validation done." << endl;
1053
1054         // The starting paragraph of the coming rows is the
1055         // first paragraph of the document. (Asger)
1056         if (output_preamble && runparams.nice) {
1057                 os << "%% LyX " << lyx_version << " created this file.  "
1058                         "For more info, see http://www.lyx.org/.\n"
1059                         "%% Do not edit unless you really know what "
1060                         "you are doing.\n";
1061                 texrow().newline();
1062                 texrow().newline();
1063         }
1064         LYXERR(Debug::INFO) << "lyx document header finished" << endl;
1065         // There are a few differences between nice LaTeX and usual files:
1066         // usual is \batchmode and has a
1067         // special input@path to allow the including of figures
1068         // with either \input or \includegraphics (what figinsets do).
1069         // input@path is set when the actual parameter
1070         // original_path is set. This is done for usual tex-file, but not
1071         // for nice-latex-file. (Matthias 250696)
1072         // Note that input@path is only needed for something the user does
1073         // in the preamble, included .tex files or ERT, files included by
1074         // LyX work without it.
1075         if (output_preamble) {
1076                 if (!runparams.nice) {
1077                         // code for usual, NOT nice-latex-file
1078                         os << "\\batchmode\n"; // changed
1079                         // from \nonstopmode
1080                         texrow().newline();
1081                 }
1082                 if (!original_path.empty()) {
1083                         // FIXME UNICODE
1084                         // We don't know the encoding of inputpath
1085                         docstring const inputpath = from_utf8(latex_path(original_path));
1086                         os << "\\makeatletter\n"
1087                            << "\\def\\input@path{{"
1088                            << inputpath << "/}}\n"
1089                            << "\\makeatother\n";
1090                         texrow().newline();
1091                         texrow().newline();
1092                         texrow().newline();
1093                 }
1094
1095                 // Write the preamble
1096                 runparams.use_babel = params().writeLaTeX(os, features, texrow());
1097
1098                 if (!output_body)
1099                         return;
1100
1101                 // make the body.
1102                 os << "\\begin{document}\n";
1103                 texrow().newline();
1104         } // output_preamble
1105
1106         texrow().start(paragraphs().begin()->id(), 0);
1107
1108         LYXERR(Debug::INFO) << "preamble finished, now the body." << endl;
1109
1110         if (!lyxrc.language_auto_begin &&
1111             !params().language->babel().empty()) {
1112                 // FIXME UNICODE
1113                 os << from_utf8(subst(lyxrc.language_command_begin,
1114                                            "$$lang",
1115                                            params().language->babel()))
1116                    << '\n';
1117                 texrow().newline();
1118         }
1119
1120         Encoding const & encoding = params().encoding();
1121         if (encoding.package() == Encoding::CJK) {
1122                 // Open a CJK environment, since in contrast to the encodings
1123                 // handled by inputenc the document encoding is not set in
1124                 // the preamble if it is handled by CJK.sty.
1125                 os << "\\begin{CJK}{" << from_ascii(encoding.latexName())
1126                    << "}{}\n";
1127                 texrow().newline();
1128         }
1129
1130         // if we are doing a real file with body, even if this is the
1131         // child of some other buffer, let's cut the link here.
1132         // This happens for example if only a child document is printed.
1133         string save_parentname;
1134         if (output_preamble) {
1135                 save_parentname = params().parentname;
1136                 params().parentname.erase();
1137         }
1138
1139         loadChildDocuments(*this);
1140
1141         // the real stuff
1142         latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
1143
1144         // Restore the parenthood if needed
1145         if (output_preamble)
1146                 params().parentname = save_parentname;
1147
1148         // add this just in case after all the paragraphs
1149         os << endl;
1150         texrow().newline();
1151
1152         if (encoding.package() == Encoding::CJK) {
1153                 // Close the open CJK environment.
1154                 // latexParagraphs will have opened one even if the last text
1155                 // was not CJK.
1156                 os << "\\end{CJK}\n";
1157                 texrow().newline();
1158         }
1159
1160         if (!lyxrc.language_auto_end &&
1161             !params().language->babel().empty()) {
1162                 os << from_utf8(subst(lyxrc.language_command_end,
1163                                            "$$lang",
1164                                            params().language->babel()))
1165                    << '\n';
1166                 texrow().newline();
1167         }
1168
1169         if (output_preamble) {
1170                 os << "\\end{document}\n";
1171                 texrow().newline();
1172
1173                 LYXERR(Debug::LATEX) << "makeLaTeXFile...done" << endl;
1174         } else {
1175                 LYXERR(Debug::LATEX) << "LaTeXFile for inclusion made."
1176                                      << endl;
1177         }
1178         runparams_in.encoding = runparams.encoding;
1179
1180         // Just to be sure. (Asger)
1181         texrow().newline();
1182
1183         LYXERR(Debug::INFO) << "Finished making LaTeX file." << endl;
1184         LYXERR(Debug::INFO) << "Row count was " << texrow().rows() - 1
1185                             << '.' << endl;
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)
1210 {
1211         LYXERR(Debug::LATEX) << "makeDocBookFile..." << endl;
1212
1213         //ofstream ofs;
1214         odocfstream ofs;
1215         if (!openFileWrite(ofs, fname))
1216                 return;
1217
1218         writeDocBookSource(ofs, fname.absFilename(), runparams, body_only);
1219
1220         ofs.close();
1221         if (ofs.fail())
1222                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1223 }
1224
1225
1226 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1227                              OutputParams const & runparams,
1228                              bool const only_body)
1229 {
1230         LaTeXFeatures features(*this, params(), runparams);
1231         validate(features);
1232
1233         texrow().reset();
1234
1235         TextClass const & tclass = params().getTextClass();
1236         string const top_element = tclass.latexname();
1237
1238         if (!only_body) {
1239                 if (runparams.flavor == OutputParams::XML)
1240                         os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1241
1242                 // FIXME UNICODE
1243                 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1244
1245                 // FIXME UNICODE
1246                 if (! tclass.class_header().empty())
1247                         os << from_ascii(tclass.class_header());
1248                 else if (runparams.flavor == OutputParams::XML)
1249                         os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1250                             << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1251                 else
1252                         os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1253
1254                 docstring preamble = from_utf8(params().preamble);
1255                 if (runparams.flavor != OutputParams::XML ) {
1256                         preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1257                         preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1258                         preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1259                         preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1260                 }
1261
1262                 string const name = runparams.nice ? changeExtension(fileName(), ".sgml")
1263                          : fname;
1264                 preamble += features.getIncludedFiles(name);
1265                 preamble += features.getLyXSGMLEntities();
1266
1267                 if (!preamble.empty()) {
1268                         os << "\n [ " << preamble << " ]";
1269                 }
1270                 os << ">\n\n";
1271         }
1272
1273         string top = top_element;
1274         top += " lang=\"";
1275         if (runparams.flavor == OutputParams::XML)
1276                 top += params().language->code();
1277         else
1278                 top += params().language->code().substr(0,2);
1279         top += '"';
1280
1281         if (!params().options.empty()) {
1282                 top += ' ';
1283                 top += params().options;
1284         }
1285
1286         os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1287             << " file was created by LyX " << lyx_version
1288             << "\n  See http://www.lyx.org/ for more information -->\n";
1289
1290         params().getTextClass().counters().reset();
1291
1292         loadChildDocuments(*this);
1293
1294         sgml::openTag(os, top);
1295         os << '\n';
1296         docbookParagraphs(paragraphs(), *this, os, runparams);
1297         sgml::closeTag(os, top_element);
1298 }
1299
1300
1301 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1302 // Other flags: -wall -v0 -x
1303 int Buffer::runChktex()
1304 {
1305         busy(true);
1306
1307         // get LaTeX-Filename
1308         FileName const path(temppath());
1309         string const name = addName(path.absFilename(), getLatexName());
1310         string const org_path = filePath();
1311
1312         support::Path p(path); // path to LaTeX file
1313         message(_("Running chktex..."));
1314
1315         // Generate the LaTeX file if neccessary
1316         OutputParams runparams(&params().encoding());
1317         runparams.flavor = OutputParams::LATEX;
1318         runparams.nice = false;
1319         makeLaTeXFile(FileName(name), org_path, runparams);
1320
1321         TeXErrors terr;
1322         Chktex chktex(lyxrc.chktex_command, onlyFilename(name), filePath());
1323         int const res = chktex.run(terr); // run chktex
1324
1325         if (res == -1) {
1326                 Alert::error(_("chktex failure"),
1327                              _("Could not run chktex successfully."));
1328         } else if (res > 0) {
1329                 ErrorList & errorList = pimpl_->errorLists["ChkTeX"];
1330                 // Clear out old errors
1331                 errorList.clear();
1332                 // Fill-in the error list with the TeX errors
1333                 bufferErrors(*this, terr, errorList);
1334         }
1335
1336         busy(false);
1337
1338         errors("ChkTeX");
1339
1340         return res;
1341 }
1342
1343
1344 void Buffer::validate(LaTeXFeatures & features) const
1345 {
1346         TextClass const & tclass = params().getTextClass();
1347
1348         if (params().outputChanges) {
1349                 bool dvipost    = LaTeXFeatures::isAvailable("dvipost");
1350                 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
1351                                   LaTeXFeatures::isAvailable("xcolor");
1352
1353                 if (features.runparams().flavor == OutputParams::LATEX) {
1354                         if (dvipost) {
1355                                 features.require("ct-dvipost");
1356                                 features.require("dvipost");
1357                         } else if (xcolorsoul) {
1358                                 features.require("ct-xcolor-soul");
1359                                 features.require("soul");
1360                                 features.require("xcolor");
1361                         } else {
1362                                 features.require("ct-none");
1363                         }
1364                 } else if (features.runparams().flavor == OutputParams::PDFLATEX ) {
1365                         if (xcolorsoul) {
1366                                 features.require("ct-xcolor-soul");
1367                                 features.require("soul");
1368                                 features.require("xcolor");
1369                                 features.require("pdfcolmk"); // improves color handling in PDF output
1370                         } else {
1371                                 features.require("ct-none");
1372                         }
1373                 }
1374         }
1375
1376         // AMS Style is at document level
1377         if (params().use_amsmath == BufferParams::package_on
1378             || tclass.provides("amsmath"))
1379                 features.require("amsmath");
1380         if (params().use_esint == BufferParams::package_on)
1381                 features.require("esint");
1382
1383         loadChildDocuments(*this);
1384
1385         for_each(paragraphs().begin(), paragraphs().end(),
1386                  boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1387
1388         // the bullet shapes are buffer level not paragraph level
1389         // so they are tested here
1390         for (int i = 0; i < 4; ++i) {
1391                 if (params().user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1392                         int const font = params().user_defined_bullet(i).getFont();
1393                         if (font == 0) {
1394                                 int const c = params()
1395                                         .user_defined_bullet(i)
1396                                         .getCharacter();
1397                                 if (c == 16
1398                                    || c == 17
1399                                    || c == 25
1400                                    || c == 26
1401                                    || c == 31) {
1402                                         features.require("latexsym");
1403                                 }
1404                         } else if (font == 1) {
1405                                 features.require("amssymb");
1406                         } else if ((font >= 2 && font <= 5)) {
1407                                 features.require("pifont");
1408                         }
1409                 }
1410         }
1411
1412         if (lyxerr.debugging(Debug::LATEX)) {
1413                 features.showStruct();
1414         }
1415 }
1416
1417
1418 void Buffer::getLabelList(vector<docstring> & list) const
1419 {
1420         /// if this is a child document and the parent is already loaded
1421         /// Use the parent's list instead  [ale990407]
1422         Buffer const * tmp = getMasterBuffer();
1423         if (!tmp) {
1424                 lyxerr << "getMasterBuffer() failed!" << endl;
1425                 BOOST_ASSERT(tmp);
1426         }
1427         if (tmp != this) {
1428                 tmp->getLabelList(list);
1429                 return;
1430         }
1431
1432         loadChildDocuments(*this);
1433
1434         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1435                 it.nextInset()->getLabelList(*this, list);
1436 }
1437
1438
1439 void Buffer::updateBibfilesCache()
1440 {
1441         // if this is a child document and the parent is already loaded
1442         // update the parent's cache instead
1443         Buffer * tmp = getMasterBuffer();
1444         BOOST_ASSERT(tmp);
1445         if (tmp != this) {
1446                 tmp->updateBibfilesCache();
1447                 return;
1448         }
1449
1450         bibfilesCache_.clear();
1451         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1452                 if (it->lyxCode() == Inset::BIBTEX_CODE) {
1453                         InsetBibtex const & inset =
1454                                 static_cast<InsetBibtex const &>(*it);
1455                         vector<FileName> const bibfiles = inset.getFiles(*this);
1456                         bibfilesCache_.insert(bibfilesCache_.end(),
1457                                 bibfiles.begin(),
1458                                 bibfiles.end());
1459                 } else if (it->lyxCode() == Inset::INCLUDE_CODE) {
1460                         InsetInclude & inset =
1461                                 static_cast<InsetInclude &>(*it);
1462                         inset.updateBibfilesCache(*this);
1463                         vector<FileName> const & bibfiles =
1464                                         inset.getBibfilesCache(*this);
1465                         bibfilesCache_.insert(bibfilesCache_.end(),
1466                                 bibfiles.begin(),
1467                                 bibfiles.end());
1468                 }
1469         }
1470 }
1471
1472
1473 vector<FileName> const & Buffer::getBibfilesCache() const
1474 {
1475         // if this is a child document and the parent is already loaded
1476         // use the parent's cache instead
1477         Buffer const * tmp = getMasterBuffer();
1478         BOOST_ASSERT(tmp);
1479         if (tmp != this)
1480                 return tmp->getBibfilesCache();
1481
1482         // We update the cache when first used instead of at loading time.
1483         if (bibfilesCache_.empty())
1484                 const_cast<Buffer *>(this)->updateBibfilesCache();
1485
1486         return bibfilesCache_;
1487 }
1488
1489
1490 bool Buffer::isDepClean(string const & name) const
1491 {
1492         DepClean::const_iterator const it = pimpl_->dep_clean.find(name);
1493         if (it == pimpl_->dep_clean.end())
1494                 return true;
1495         return it->second;
1496 }
1497
1498
1499 void Buffer::markDepClean(string const & name)
1500 {
1501         pimpl_->dep_clean[name] = true;
1502 }
1503
1504
1505 bool Buffer::dispatch(string const & command, bool * result)
1506 {
1507         return dispatch(lyxaction.lookupFunc(command), result);
1508 }
1509
1510
1511 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1512 {
1513         bool dispatched = true;
1514
1515         switch (func.action) {
1516                 case LFUN_BUFFER_EXPORT: {
1517                         bool const tmp = Exporter::Export(this, to_utf8(func.argument()), false);
1518                         if (result)
1519                                 *result = tmp;
1520                         break;
1521                 }
1522
1523                 default:
1524                         dispatched = false;
1525         }
1526         return dispatched;
1527 }
1528
1529
1530 void Buffer::changeLanguage(Language const * from, Language const * to)
1531 {
1532         BOOST_ASSERT(from);
1533         BOOST_ASSERT(to);
1534
1535         for_each(par_iterator_begin(),
1536                  par_iterator_end(),
1537                  bind(&Paragraph::changeLanguage, _1, params(), from, to));
1538 }
1539
1540
1541 bool Buffer::isMultiLingual() const
1542 {
1543         ParConstIterator end = par_iterator_end();
1544         for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1545                 if (it->isMultiLingual(params()))
1546                         return true;
1547
1548         return false;
1549 }
1550
1551
1552 ParIterator Buffer::getParFromID(int const id) const
1553 {
1554         ParConstIterator it = par_iterator_begin();
1555         ParConstIterator const end = par_iterator_end();
1556
1557         if (id < 0) {
1558                 // John says this is called with id == -1 from undo
1559                 lyxerr << "getParFromID(), id: " << id << endl;
1560                 return end;
1561         }
1562
1563         for (; it != end; ++it)
1564                 if (it->id() == id)
1565                         return it;
1566
1567         return end;
1568 }
1569
1570
1571 bool Buffer::hasParWithID(int const id) const
1572 {
1573         ParConstIterator const it = getParFromID(id);
1574         return it != par_iterator_end();
1575 }
1576
1577
1578 ParIterator Buffer::par_iterator_begin()
1579 {
1580         return lyx::par_iterator_begin(inset());
1581 }
1582
1583
1584 ParIterator Buffer::par_iterator_end()
1585 {
1586         return lyx::par_iterator_end(inset());
1587 }
1588
1589
1590 ParConstIterator Buffer::par_iterator_begin() const
1591 {
1592         return lyx::par_const_iterator_begin(inset());
1593 }
1594
1595
1596 ParConstIterator Buffer::par_iterator_end() const
1597 {
1598         return lyx::par_const_iterator_end(inset());
1599 }
1600
1601
1602 Language const * Buffer::getLanguage() const
1603 {
1604         return params().language;
1605 }
1606
1607
1608 docstring const Buffer::B_(string const & l10n) const
1609 {
1610         return params().B_(l10n);
1611 }
1612
1613
1614 bool Buffer::isClean() const
1615 {
1616         return pimpl_->lyx_clean;
1617 }
1618
1619
1620 bool Buffer::isBakClean() const
1621 {
1622         return pimpl_->bak_clean;
1623 }
1624
1625
1626 bool Buffer::isExternallyModified(CheckMethod method) const
1627 {
1628         BOOST_ASSERT(fs::exists(pimpl_->filename.toFilesystemEncoding()));
1629         // if method == timestamp, check timestamp before checksum
1630         return (method == checksum_method
1631                 || pimpl_->timestamp_ != fs::last_write_time(pimpl_->filename.toFilesystemEncoding()))
1632                 && pimpl_->checksum_ != sum(pimpl_->filename);
1633 }
1634
1635
1636 void Buffer::saveCheckSum(string const & file) const
1637 {
1638         if (fs::exists(file)) {
1639                 pimpl_->timestamp_ = fs::last_write_time(file);
1640                 pimpl_->checksum_ = sum(FileName(file));
1641         } else {
1642                 // in the case of save to a new file.
1643                 pimpl_->timestamp_ = 0;
1644                 pimpl_->checksum_ = 0;
1645         }
1646 }
1647
1648
1649 void Buffer::markClean() const
1650 {
1651         if (!pimpl_->lyx_clean) {
1652                 pimpl_->lyx_clean = true;
1653                 updateTitles();
1654         }
1655         // if the .lyx file has been saved, we don't need an
1656         // autosave
1657         pimpl_->bak_clean = true;
1658 }
1659
1660
1661 void Buffer::markBakClean()
1662 {
1663         pimpl_->bak_clean = true;
1664 }
1665
1666
1667 void Buffer::setUnnamed(bool flag)
1668 {
1669         pimpl_->unnamed = flag;
1670 }
1671
1672
1673 bool Buffer::isUnnamed() const
1674 {
1675         return pimpl_->unnamed;
1676 }
1677
1678
1679 // FIXME: this function should be moved to buffer_pimpl.C
1680 void Buffer::markDirty()
1681 {
1682         if (pimpl_->lyx_clean) {
1683                 pimpl_->lyx_clean = false;
1684                 updateTitles();
1685         }
1686         pimpl_->bak_clean = false;
1687
1688         DepClean::iterator it = pimpl_->dep_clean.begin();
1689         DepClean::const_iterator const end = pimpl_->dep_clean.end();
1690
1691         for (; it != end; ++it)
1692                 it->second = false;
1693 }
1694
1695
1696 string const Buffer::fileName() const
1697 {
1698         return pimpl_->filename.absFilename();
1699 }
1700
1701
1702 string const & Buffer::filePath() const
1703 {
1704         return params().filepath;
1705 }
1706
1707
1708 bool Buffer::isReadonly() const
1709 {
1710         return pimpl_->read_only;
1711 }
1712
1713
1714 void Buffer::setParentName(string const & name)
1715 {
1716         if (name == pimpl_->filename.absFilename())
1717                 // Avoids recursive include.
1718                 params().parentname.clear();
1719         else
1720                 params().parentname = name;
1721 }
1722
1723
1724 Buffer const * Buffer::getMasterBuffer() const
1725 {
1726         if (!params().parentname.empty()
1727             && theBufferList().exists(params().parentname)) {
1728                 Buffer const * buf = theBufferList().getBuffer(params().parentname);
1729                 //We need to check if the parent is us...
1730                 //FIXME RECURSIVE INCLUDE
1731                 //This is not sufficient, since recursive includes could be downstream.
1732                 if (buf && buf != this)
1733                         return buf->getMasterBuffer();
1734         }
1735
1736         return this;
1737 }
1738
1739
1740 Buffer * Buffer::getMasterBuffer()
1741 {
1742         if (!params().parentname.empty()
1743             && theBufferList().exists(params().parentname)) {
1744                 Buffer * buf = theBufferList().getBuffer(params().parentname);
1745                 if (buf)
1746                         return buf->getMasterBuffer();
1747         }
1748
1749         return this;
1750 }
1751
1752
1753 MacroData const & Buffer::getMacro(docstring const & name) const
1754 {
1755         return pimpl_->macros.get(name);
1756 }
1757
1758
1759 bool Buffer::hasMacro(docstring const & name) const
1760 {
1761         return pimpl_->macros.has(name);
1762 }
1763
1764
1765 void Buffer::insertMacro(docstring const & name, MacroData const & data)
1766 {
1767         MacroTable::globalMacros().insert(name, data);
1768         pimpl_->macros.insert(name, data);
1769 }
1770
1771
1772 void Buffer::buildMacros()
1773 {
1774         // Start with global table.
1775         pimpl_->macros = MacroTable::globalMacros();
1776
1777         // Now add our own.
1778         ParagraphList const & pars = text().paragraphs();
1779         for (size_t i = 0, n = pars.size(); i != n; ++i) {
1780                 //lyxerr << "searching main par " << i
1781                 //      << " for macro definitions" << std::endl;
1782                 InsetList const & insets = pars[i].insetlist;
1783                 InsetList::const_iterator it = insets.begin();
1784                 InsetList::const_iterator end = insets.end();
1785                 for ( ; it != end; ++it) {
1786                         //lyxerr << "found inset code " << it->inset->lyxCode() << std::endl;
1787                         if (it->inset->lyxCode() == Inset::MATHMACRO_CODE) {
1788                                 MathMacroTemplate const & mac
1789                                         = static_cast<MathMacroTemplate const &>(*it->inset);
1790                                 insertMacro(mac.name(), mac.asMacroData());
1791                         }
1792                 }
1793         }
1794 }
1795
1796
1797 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
1798         Inset::Code code)
1799 {
1800         //FIXME: This does not work for child documents yet.
1801         BOOST_ASSERT(code == Inset::CITE_CODE || code == Inset::REF_CODE);
1802         // Check if the label 'from' appears more than once
1803         vector<docstring> labels;
1804
1805         if (code == Inset::CITE_CODE) {
1806                 BiblioInfo keys;
1807                 keys.fillWithBibKeys(this);
1808                 BiblioInfo::const_iterator bit  = keys.begin();
1809                 BiblioInfo::const_iterator bend = keys.end();
1810
1811                 for (; bit != bend; ++bit)
1812                         // FIXME UNICODE
1813                         labels.push_back(bit->first);
1814         } else
1815                 getLabelList(labels);
1816
1817         if (std::count(labels.begin(), labels.end(), from) > 1)
1818                 return;
1819
1820         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1821                 if (it->lyxCode() == code) {
1822                         InsetCommand & inset = static_cast<InsetCommand &>(*it);
1823                         inset.replaceContents(to_utf8(from), to_utf8(to));
1824                 }
1825         }
1826 }
1827
1828
1829 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
1830         pit_type par_end, bool full_source)
1831 {
1832         OutputParams runparams(&params().encoding());
1833         runparams.nice = true;
1834         runparams.flavor = OutputParams::LATEX;
1835         runparams.linelen = lyxrc.plaintext_linelen;
1836         // No side effect of file copying and image conversion
1837         runparams.dryrun = true;
1838
1839         texrow().reset();
1840         if (full_source) {
1841                 os << "% " << _("Preview source code") << "\n\n";
1842                 texrow().newline();
1843                 texrow().newline();
1844                 if (isLatex())
1845                         writeLaTeXSource(os, filePath(), runparams, true, true);
1846                 else {
1847                         writeDocBookSource(os, fileName(), runparams, false);
1848                 }
1849         } else {
1850                 runparams.par_begin = par_begin;
1851                 runparams.par_end = par_end;
1852                 if (par_begin + 1 == par_end)
1853                         os << "% "
1854                            << bformat(_("Preview source code for paragraph %1$d"), par_begin)
1855                            << "\n\n";
1856                 else
1857                         os << "% "
1858                            << bformat(_("Preview source code from paragraph %1$s to %2$s"),
1859                                         convert<docstring>(par_begin),
1860                                         convert<docstring>(par_end - 1))
1861                            << "\n\n";
1862                 texrow().newline();
1863                 texrow().newline();
1864                 // output paragraphs
1865                 if (isLatex()) {
1866                         latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
1867                 } else {
1868                         // DocBook
1869                         docbookParagraphs(paragraphs(), *this, os, runparams);
1870                 }
1871         }
1872 }
1873
1874
1875 ErrorList const & Buffer::errorList(string const & type) const
1876 {
1877         static ErrorList const emptyErrorList;
1878         std::map<string, ErrorList>::const_iterator I = pimpl_->errorLists.find(type);
1879         if (I == pimpl_->errorLists.end())
1880                 return emptyErrorList;
1881
1882         return I->second;
1883 }
1884
1885
1886 ErrorList & Buffer::errorList(string const & type)
1887 {
1888         return pimpl_->errorLists[type];
1889 }
1890
1891
1892 } // namespace lyx