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::unzipToDir;
 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 = 282;
 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         if (!params().getTextClass().load(filePath())) {
 535                 string theclass = params().getTextClass().name();
 536                 Alert::error(_("Can't load document class"), bformat(
 537                         _("Using the default document class, because the "
 538                                      "class %1$s could not be loaded."), from_utf8(theclass)));
 539                 params().setBaseClass(defaultTextclass());
 540         }
 541
 542         if (params().outputChanges) {
 543                 bool dvipost    = LaTeXFeatures::isAvailable("dvipost");
 544                 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
 545                                   LaTeXFeatures::isAvailable("xcolor");
 546
 547                 if (!dvipost && !xcolorsoul) {
 548                         Alert::warning(_("Changes not shown in LaTeX output"),
 549                                        _("Changes will not be highlighted in LaTeX output, "
 550                                          "because neither dvipost nor xcolor/soul are installed.\n"
 551                                          "Please install these packages or redefine "
 552                                          "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
 553                 } else if (!xcolorsoul) {
 554                         Alert::warning(_("Changes not shown in LaTeX output"),
 555                                        _("Changes will not be highlighted in LaTeX output "
 556                                          "when using pdflatex, because xcolor and soul are not installed.\n"
 557                                          "Please install both packages or redefine "
 558                                          "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
 559                 }
 560         }
 561
 562         bool const res = text().read(*this, lex, errorList);
 563         for_each(text().paragraphs().begin(),
 564                  text().paragraphs().end(),
 565                  bind(&Paragraph::setInsetOwner, _1, &inset()));
 566
 567         return res;
 568 }
 569
 570
 571 // needed to insert the selection
 572 void Buffer::insertStringAsLines(ParagraphList & pars,
 573         pit_type & pit, pos_type & pos,
 574         Font const & fn, docstring const & str, bool autobreakrows)
 575 {
 576         Font font = fn;
 577
 578         // insert the string, don't insert doublespace
 579         bool space_inserted = true;
 580         for (docstring::const_iterator cit = str.begin();
 581             cit != str.end(); ++cit) {
 582                 Paragraph & par = pars[pit];
 583                 if (*cit == '\n') {
 584                         if (autobreakrows && (!par.empty() || par.allowEmpty())) {
 585                                 breakParagraph(params(), pars, pit, pos,
 586                                                par.layout()->isEnvironment());
 587                                 ++pit;
 588                                 pos = 0;
 589                                 space_inserted = true;
 590                         } else {
 591                                 continue;
 592                         }
 593                         // do not insert consecutive spaces if !free_spacing
 594                 } else if ((*cit == ' ' || *cit == '\t') &&
 595                            space_inserted && !par.isFreeSpacing()) {
 596                         continue;
 597                 } else if (*cit == '\t') {
 598                         if (!par.isFreeSpacing()) {
 599                                 // tabs are like spaces here
 600                                 par.insertChar(pos, ' ', font, params().trackChanges);
 601                                 ++pos;
 602                                 space_inserted = true;
 603                         } else {
 604                                 const pos_type n = 8 - pos % 8;
 605                                 for (pos_type i = 0; i < n; ++i) {
 606                                         par.insertChar(pos, ' ', font, params().trackChanges);
 607                                         ++pos;
 608                                 }
 609                                 space_inserted = true;
 610                         }
 611                 } else if (!isPrintable(*cit)) {
 612                         // Ignore unprintables
 613                         continue;
 614                 } else {
 615                         // just insert the character
 616                         par.insertChar(pos, *cit, font, params().trackChanges);
 617                         ++pos;
 618                         space_inserted = (*cit == ' ');
 619                 }
 620
 621         }
 622 }
 623
 624
 625 bool Buffer::readString(std::string const & s)
 626 {
 627         params().compressed = false;
 628
 629         // remove dummy empty par
 630         paragraphs().clear();
 631         Lexer lex(0, 0);
 632         std::istringstream is(s);
 633         lex.setStream(is);
 634         FileName const name(tempName());
 635         switch (readFile(lex, name, true)) {
 636         case failure:
 637                 return false;
 638         case wrongversion: {
 639                 // We need to call lyx2lyx, so write the input to a file
 640                 std::ofstream os(name.toFilesystemEncoding().c_str());
 641                 os << s;
 642                 os.close();
 643                 return readFile(name);
 644         }
 645         case success:
 646                 break;
 647         }
 648
 649         return true;
 650 }
 651
 652
 653 bool Buffer::readFile(FileName const & filename)
 654 {
 655         FileName fname(filename);
 656         // Check if the file is compressed.
 657         string format = getFormatFromContents(filename);
 658         if (format == "zip") {
 659                 // decompress to a temp directory
 660                 LYXERR(Debug::FILES) << filename << " is in zip format. Unzip to " << temppath() << endl;
 661                 unzipToDir(filename.toFilesystemEncoding(), temppath());
 662                 //
 663                 FileName manifest(addName(temppath(), "manifest.txt"));
 664                 FileName lyxfile(addName(temppath(),
 665                         onlyFilename(filename.toFilesystemEncoding())));
 666                 // if both manifest.txt and file.lyx exist, this is am embedded file
 667                 if (fs::exists(manifest.toFilesystemEncoding()) &&
 668                         fs::exists(lyxfile.toFilesystemEncoding())) {
 669                         params().embedded = true;
 670                         fname = lyxfile;
 671                         // read manifest file
 672                         ifstream is(manifest.toFilesystemEncoding().c_str());
 673                         is >> pimpl_->embedded_files;
 674                         is.close();
 675                         LYXERR(Debug::FILES) << filename << " is a embedded file. Its manifest is:\n"
 676                                         << pimpl_->embedded_files;
 677                 }
 678         }
 679         // The embedded lyx file can also be compressed, for backward compatibility
 680         format = getFormatFromContents(fname);
 681         if (format == "gzip" || format == "zip" || format == "compress") {
 682                 params().compressed = true;
 683         }
 684
 685         // remove dummy empty par
 686         paragraphs().clear();
 687         Lexer lex(0, 0);
 688         lex.setFile(fname);
 689         if (readFile(lex, fname) != success)
 690                 return false;
 691
 692         return true;
 693 }
 694
 695
 696 bool Buffer::fully_loaded() const
 697 {
 698         return pimpl_->file_fully_loaded;
 699 }
 700
 701
 702 void Buffer::fully_loaded(bool const value)
 703 {
 704         pimpl_->file_fully_loaded = value;
 705 }
 706
 707
 708 Buffer::ReadStatus Buffer::readFile(Lexer & lex, FileName const & filename,
 709                 bool fromstring)
 710 {
 711         BOOST_ASSERT(!filename.empty());
 712
 713         if (!lex.isOK()) {
 714                 Alert::error(_("Document could not be read"),
 715                              bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
 716                 return failure;
 717         }
 718
 719         lex.next();
 720         string const token(lex.getString());
 721
 722         if (!lex) {
 723                 Alert::error(_("Document could not be read"),
 724                              bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
 725                 return failure;
 726         }
 727
 728         // the first token _must_ be...
 729         if (token != "\\lyxformat") {
 730                 lyxerr << "Token: " << token << endl;
 731
 732                 Alert::error(_("Document format failure"),
 733                              bformat(_("%1$s is not a LyX document."),
 734                                        from_utf8(filename.absFilename())));
 735                 return failure;
 736         }
 737
 738         lex.next();
 739         string tmp_format = lex.getString();
 740         //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
 741         // if present remove ".," from string.
 742         string::size_type dot = tmp_format.find_first_of(".,");
 743         //lyxerr << "           dot found at " << dot << endl;
 744         if (dot != string::npos)
 745                         tmp_format.erase(dot, 1);
 746         int const file_format = convert<int>(tmp_format);
 747         //lyxerr << "format: " << file_format << endl;
 748
 749         // save timestamp and checksum of the original disk file, making sure
 750         // to not overwrite them with those of the file created in the tempdir
 751         // when it has to be converted to the current format.
 752         if (!pimpl_->checksum_) {
 753                 pimpl_->timestamp_ = fs::last_write_time(filename.toFilesystemEncoding());
 754                 pimpl_->checksum_ = sum(filename);
 755         }
 756
 757         if (file_format != LYX_FORMAT) {
 758
 759                 if (fromstring)
 760                         // lyx2lyx would fail
 761                         return wrongversion;
 762
 763                 FileName const tmpfile(tempName());
 764                 if (tmpfile.empty()) {
 765                         Alert::error(_("Conversion failed"),
 766                                      bformat(_("%1$s is from a different"
 767                                               " version of LyX, but a temporary"
 768                                               " file for converting it could"
 769                                                             " not be created."),
 770                                               from_utf8(filename.absFilename())));
 771                         return failure;
 772                 }
 773                 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
 774                 if (lyx2lyx.empty()) {
 775                         Alert::error(_("Conversion script not found"),
 776                                      bformat(_("%1$s is from a different"
 777                                                " version of LyX, but the"
 778                                                " conversion script lyx2lyx"
 779                                                             " could not be found."),
 780                                                from_utf8(filename.absFilename())));
 781                         return failure;
 782                 }
 783                 ostringstream command;
 784                 command << os::python()
 785                         << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
 786                         << " -t " << convert<string>(LYX_FORMAT)
 787                         << " -o " << quoteName(tmpfile.toFilesystemEncoding())
 788                         << ' ' << quoteName(filename.toFilesystemEncoding());
 789                 string const command_str = command.str();
 790
 791                 LYXERR(Debug::INFO) << "Running '"
 792                                     << command_str << '\''
 793                                     << endl;
 794
 795                 cmd_ret const ret = runCommand(command_str);
 796                 if (ret.first != 0) {
 797                         Alert::error(_("Conversion script failed"),
 798                                      bformat(_("%1$s is from a different version"
 799                                               " of LyX, but the lyx2lyx script"
 800                                                             " failed to convert it."),
 801                                               from_utf8(filename.absFilename())));
 802                         return failure;
 803                 } else {
 804                         bool const ret = readFile(tmpfile);
 805                         // Do stuff with tmpfile name and buffer name here.
 806                         return ret ? success : failure;
 807                 }
 808
 809         }
 810
 811         if (readDocument(lex)) {
 812                 Alert::error(_("Document format failure"),
 813                              bformat(_("%1$s ended unexpectedly, which means"
 814                                                     " that it is probably corrupted."),
 815                                        from_utf8(filename.absFilename())));
 816         }
 817
 818         //lyxerr << "removing " << MacroTable::localMacros().size()
 819         //      << " temporary macro entries" << endl;
 820         //MacroTable::localMacros().clear();
 821
 822         pimpl_->file_fully_loaded = true;
 823         return success;
 824 }
 825
 826
 827 // Should probably be moved to somewhere else: BufferView? LyXView?
 828 bool Buffer::save() const
 829 {
 830         // We don't need autosaves in the immediate future. (Asger)
 831         resetAutosaveTimers();
 832
 833         string const encodedFilename = pimpl_->filename.toFilesystemEncoding();
 834
 835         FileName backupName;
 836         bool madeBackup = false;
 837
 838         // make a backup if the file already exists
 839         if (lyxrc.make_backup && fs::exists(encodedFilename)) {
 840                 backupName = FileName(fileName() + '~');
 841                 if (!lyxrc.backupdir_path.empty())
 842                         backupName = FileName(addName(lyxrc.backupdir_path,
 843                                               subst(os::internal_path(backupName.absFilename()), '/', '!')));
 844
 845                 try {
 846                         fs::copy_file(encodedFilename, backupName.toFilesystemEncoding(), false);
 847                         madeBackup = true;
 848                 } catch (fs::filesystem_error const & fe) {
 849                         Alert::error(_("Backup failure"),
 850                                      bformat(_("Cannot create backup file %1$s.\n"
 851                                                "Please check whether the directory exists and is writeable."),
 852                                              from_utf8(backupName.absFilename())));
 853                         LYXERR(Debug::DEBUG) << "Fs error: " << fe.what() << endl;
 854                 }
 855         }
 856
 857         // ask if the disk file has been externally modified (use checksum method)
 858         if (fs::exists(encodedFilename) && isExternallyModified(checksum_method)) {
 859                 docstring const file = makeDisplayPath(fileName(), 20);
 860                 docstring text = bformat(_("Document %1$s has been externally modified. Are you sure "
 861                                                              "you want to overwrite this file?"), file);
 862                 int const ret = Alert::prompt(_("Overwrite modified file?"),
 863                         text, 1, 1, _("&Overwrite"), _("&Cancel"));
 864                 if (ret == 1)
 865                         return false;
 866         }
 867
 868         if (writeFile(pimpl_->filename)) {
 869                 markClean();
 870                 removeAutosaveFile(fileName());
 871                 pimpl_->timestamp_ = fs::last_write_time(pimpl_->filename.toFilesystemEncoding());
 872                 pimpl_->checksum_ = sum(pimpl_->filename);
 873                 return true;
 874         } else {
 875                 // Saving failed, so backup is not backup
 876                 if (madeBackup)
 877                         rename(backupName, pimpl_->filename);
 878                 return false;
 879         }
 880 }
 881
 882
 883 bool Buffer::writeFile(FileName const & fname) const
 884 {
 885         if (pimpl_->read_only && fname == pimpl_->filename)
 886                 return false;
 887
 888         bool retval = false;
 889
 890         FileName content;
 891         if (params().embedded)
 892                 // first write the .lyx file to the temporary directory
 893                 content = FileName(addName(temppath(),
 894                         onlyFilename(fname.toFilesystemEncoding())));
 895         else
 896                 content = fname;
 897
 898         if (params().compressed) {
 899                 gz::ogzstream ofs(content.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
 900                 if (!ofs)
 901                         return false;
 902
 903                 retval = write(ofs);
 904         } else {
 905                 ofstream ofs(content.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
 906                 if (!ofs)
 907                         return false;
 908
 909                 retval = write(ofs);
 910         }
 911
 912         if (retval && params().embedded) {
 913                 // write file.lyx and all the embedded files to the zip file fname
 914                 // if embedding is enabled, and there is any embedded file
 915                 pimpl_->embedded_files.update();
 916                 return pimpl_->embedded_files.write(fname);
 917         }
 918         return retval;
 919 }
 920
 921
 922 bool Buffer::write(ostream & ofs) const
 923 {
 924 #ifdef HAVE_LOCALE
 925         // Use the standard "C" locale for file output.
 926         ofs.imbue(std::locale::classic());
 927 #endif
 928
 929         // The top of the file should not be written by params().
 930
 931         // write out a comment in the top of the file
 932         ofs << "#LyX " << lyx_version
 933             << " created this file. For more info see http://www.lyx.org/\n"
 934             << "\\lyxformat " << LYX_FORMAT << "\n"
 935             << "\\begin_document\n";
 936
 937
 938         /// For each author, set 'used' to true if there is a change
 939         /// by this author in the document; otherwise set it to 'false'.
 940         AuthorList::Authors::const_iterator a_it = params().authors().begin();
 941         AuthorList::Authors::const_iterator a_end = params().authors().end();
 942         for (; a_it != a_end; ++a_it)
 943                 a_it->second.used(false);
 944
 945         ParIterator const end = par_iterator_end();
 946         ParIterator it = par_iterator_begin();
 947         for ( ; it != end; ++it)
 948                 it->checkAuthors(params().authors());
 949
 950         // now write out the buffer parameters.
 951         ofs << "\\begin_header\n";
 952         params().writeFile(ofs);
 953         ofs << "\\end_header\n";
 954
 955         // write the text
 956         ofs << "\n\\begin_body\n";
 957         text().write(*this, ofs);
 958         ofs << "\n\\end_body\n";
 959
 960         // Write marker that shows file is complete
 961         ofs << "\\end_document" << endl;
 962
 963         // Shouldn't really be needed....
 964         //ofs.close();
 965
 966         // how to check if close went ok?
 967         // Following is an attempt... (BE 20001011)
 968
 969         // good() returns false if any error occured, including some
 970         //        formatting error.
 971         // bad()  returns true if something bad happened in the buffer,
 972         //        which should include file system full errors.
 973
 974         bool status = true;
 975         if (!ofs) {
 976                 status = false;
 977                 lyxerr << "File was not closed properly." << endl;
 978         }
 979
 980         return status;
 981 }
 982
 983
 984 bool Buffer::makeLaTeXFile(FileName const & fname,
 985                            string const & original_path,
 986                            OutputParams const & runparams,
 987                            bool output_preamble, bool output_body)
 988 {
 989         string const encoding = runparams.encoding->iconvName();
 990         LYXERR(Debug::LATEX) << "makeLaTeXFile encoding: "
 991                 << encoding << "..." << endl;
 992
 993         odocfstream ofs(encoding);
 994         if (!openFileWrite(ofs, fname))
 995                 return false;
 996
 997         //TexStream ts(ofs.rdbuf(), &texrow());
 998
 999         bool failed_export = false;
1000         try {
1001                 texrow().reset();
1002                 writeLaTeXSource(ofs, original_path,
1003                       runparams, output_preamble, output_body);
1004         }
1005         catch (iconv_codecvt_facet_exception & e) {
1006                 lyxerr << "Caught iconv exception: " << e.what() << endl;
1007                 failed_export = true;
1008         }
1009         catch (std::exception const & e) {
1010                 lyxerr << "Caught \"normal\" exception: " << e.what() << endl;
1011                 failed_export = true;
1012         }
1013         catch (...) {
1014                 lyxerr << "Caught some really weird exception..." << endl;
1015                 LyX::cref().emergencyCleanup();
1016                 abort();
1017         }
1018
1019         ofs.close();
1020         if (ofs.fail()) {
1021                 failed_export = true;
1022                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1023         }
1024
1025         if (failed_export) {
1026                 Alert::error(_("Encoding error"),
1027                         _("Some characters of your document are probably not "
1028                         "representable in the chosen encoding.\n"
1029                         "Changing the document encoding to utf8 could help."));
1030                 return false;
1031         }
1032         return true;
1033 }
1034
1035
1036 void Buffer::writeLaTeXSource(odocstream & os,
1037                            string const & original_path,
1038                            OutputParams const & runparams_in,
1039                            bool const output_preamble, bool const output_body)
1040 {
1041         OutputParams runparams = runparams_in;
1042
1043         // validate the buffer.
1044         LYXERR(Debug::LATEX) << "  Validating buffer..." << endl;
1045         LaTeXFeatures features(*this, params(), runparams);
1046         validate(features);
1047         LYXERR(Debug::LATEX) << "  Buffer validation done." << endl;
1048
1049         // The starting paragraph of the coming rows is the
1050         // first paragraph of the document. (Asger)
1051         if (output_preamble && runparams.nice) {
1052                 os << "%% LyX " << lyx_version << " created this file.  "
1053                         "For more info, see http://www.lyx.org/.\n"
1054                         "%% Do not edit unless you really know what "
1055                         "you are doing.\n";
1056                 texrow().newline();
1057                 texrow().newline();
1058         }
1059         LYXERR(Debug::INFO) << "lyx document header finished" << endl;
1060         // There are a few differences between nice LaTeX and usual files:
1061         // usual is \batchmode and has a
1062         // special input@path to allow the including of figures
1063         // with either \input or \includegraphics (what figinsets do).
1064         // input@path is set when the actual parameter
1065         // original_path is set. This is done for usual tex-file, but not
1066         // for nice-latex-file. (Matthias 250696)
1067         // Note that input@path is only needed for something the user does
1068         // in the preamble, included .tex files or ERT, files included by
1069         // LyX work without it.
1070         if (output_preamble) {
1071                 if (!runparams.nice) {
1072                         // code for usual, NOT nice-latex-file
1073                         os << "\\batchmode\n"; // changed
1074                         // from \nonstopmode
1075                         texrow().newline();
1076                 }
1077                 if (!original_path.empty()) {
1078                         // FIXME UNICODE
1079                         // We don't know the encoding of inputpath
1080                         docstring const inputpath = from_utf8(latex_path(original_path));
1081                         os << "\\makeatletter\n"
1082                            << "\\def\\input@path{{"
1083                            << inputpath << "/}}\n"
1084                            << "\\makeatother\n";
1085                         texrow().newline();
1086                         texrow().newline();
1087                         texrow().newline();
1088                 }
1089
1090                 // Write the preamble
1091                 runparams.use_babel = params().writeLaTeX(os, features, texrow());
1092
1093                 if (!output_body)
1094                         return;
1095
1096                 // make the body.
1097                 os << "\\begin{document}\n";
1098                 texrow().newline();
1099         } // output_preamble
1100
1101         texrow().start(paragraphs().begin()->id(), 0);
1102
1103         LYXERR(Debug::INFO) << "preamble finished, now the body." << endl;
1104
1105         if (!lyxrc.language_auto_begin &&
1106             !params().language->babel().empty()) {
1107                 // FIXME UNICODE
1108                 os << from_utf8(subst(lyxrc.language_command_begin,
1109                                            "$$lang",
1110                                            params().language->babel()))
1111                    << '\n';
1112                 texrow().newline();
1113         }
1114
1115         Encoding const & encoding = params().encoding();
1116         if (encoding.package() == Encoding::CJK) {
1117                 // Open a CJK environment, since in contrast to the encodings
1118                 // handled by inputenc the document encoding is not set in
1119                 // the preamble if it is handled by CJK.sty.
1120                 os << "\\begin{CJK}{" << from_ascii(encoding.latexName())
1121                    << "}{}\n";
1122                 texrow().newline();
1123         }
1124
1125         // if we are doing a real file with body, even if this is the
1126         // child of some other buffer, let's cut the link here.
1127         // This happens for example if only a child document is printed.
1128         string save_parentname;
1129         if (output_preamble) {
1130                 save_parentname = params().parentname;
1131                 params().parentname.erase();
1132         }
1133
1134         loadChildDocuments(*this);
1135
1136         // the real stuff
1137         latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
1138
1139         // Restore the parenthood if needed
1140         if (output_preamble)
1141                 params().parentname = save_parentname;
1142
1143         // add this just in case after all the paragraphs
1144         os << endl;
1145         texrow().newline();
1146
1147         if (encoding.package() == Encoding::CJK) {
1148                 // Close the open CJK environment.
1149                 // latexParagraphs will have opened one even if the last text
1150                 // was not CJK.
1151                 os << "\\end{CJK}\n";
1152                 texrow().newline();
1153         }
1154
1155         if (!lyxrc.language_auto_end &&
1156             !params().language->babel().empty()) {
1157                 os << from_utf8(subst(lyxrc.language_command_end,
1158                                            "$$lang",
1159                                            params().language->babel()))
1160                    << '\n';
1161                 texrow().newline();
1162         }
1163
1164         if (output_preamble) {
1165                 os << "\\end{document}\n";
1166                 texrow().newline();
1167
1168                 LYXERR(Debug::LATEX) << "makeLaTeXFile...done" << endl;
1169         } else {
1170                 LYXERR(Debug::LATEX) << "LaTeXFile for inclusion made."
1171                                      << endl;
1172         }
1173         runparams_in.encoding = runparams.encoding;
1174
1175         // Just to be sure. (Asger)
1176         texrow().newline();
1177
1178         LYXERR(Debug::INFO) << "Finished making LaTeX file." << endl;
1179         LYXERR(Debug::INFO) << "Row count was " << texrow().rows() - 1
1180                             << '.' << endl;
1181 }
1182
1183
1184 bool Buffer::isLatex() const
1185 {
1186         return params().getTextClass().outputType() == LATEX;
1187 }
1188
1189
1190 bool Buffer::isLiterate() const
1191 {
1192         return params().getTextClass().outputType() == LITERATE;
1193 }
1194
1195
1196 bool Buffer::isDocBook() const
1197 {
1198         return params().getTextClass().outputType() == DOCBOOK;
1199 }
1200
1201
1202 void Buffer::makeDocBookFile(FileName const & fname,
1203                               OutputParams const & runparams,
1204                               bool const body_only)
1205 {
1206         LYXERR(Debug::LATEX) << "makeDocBookFile..." << endl;
1207
1208         //ofstream ofs;
1209         odocfstream ofs;
1210         if (!openFileWrite(ofs, fname))
1211                 return;
1212
1213         writeDocBookSource(ofs, fname.absFilename(), runparams, body_only);
1214
1215         ofs.close();
1216         if (ofs.fail())
1217                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1218 }
1219
1220
1221 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1222                              OutputParams const & runparams,
1223                              bool const only_body)
1224 {
1225         LaTeXFeatures features(*this, params(), runparams);
1226         validate(features);
1227
1228         texrow().reset();
1229
1230         TextClass const & tclass = params().getTextClass();
1231         string const top_element = tclass.latexname();
1232
1233         if (!only_body) {
1234                 if (runparams.flavor == OutputParams::XML)
1235                         os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1236
1237                 // FIXME UNICODE
1238                 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1239
1240                 // FIXME UNICODE
1241                 if (! tclass.class_header().empty())
1242                         os << from_ascii(tclass.class_header());
1243                 else if (runparams.flavor == OutputParams::XML)
1244                         os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1245                             << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1246                 else
1247                         os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1248
1249                 docstring preamble = from_utf8(params().preamble);
1250                 if (runparams.flavor != OutputParams::XML ) {
1251                         preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1252                         preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1253                         preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1254                         preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1255                 }
1256
1257                 string const name = runparams.nice ? changeExtension(fileName(), ".sgml")
1258                          : fname;
1259                 preamble += features.getIncludedFiles(name);
1260                 preamble += features.getLyXSGMLEntities();
1261
1262                 if (!preamble.empty()) {
1263                         os << "\n [ " << preamble << " ]";
1264                 }
1265                 os << ">\n\n";
1266         }
1267
1268         string top = top_element;
1269         top += " lang=\"";
1270         if (runparams.flavor == OutputParams::XML)
1271                 top += params().language->code();
1272         else
1273                 top += params().language->code().substr(0,2);
1274         top += '"';
1275
1276         if (!params().options.empty()) {
1277                 top += ' ';
1278                 top += params().options;
1279         }
1280
1281         os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1282             << " file was created by LyX " << lyx_version
1283             << "\n  See http://www.lyx.org/ for more information -->\n";
1284
1285         params().getTextClass().counters().reset();
1286
1287         loadChildDocuments(*this);
1288
1289         sgml::openTag(os, top);
1290         os << '\n';
1291         docbookParagraphs(paragraphs(), *this, os, runparams);
1292         sgml::closeTag(os, top_element);
1293 }
1294
1295
1296 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1297 // Other flags: -wall -v0 -x
1298 int Buffer::runChktex()
1299 {
1300         busy(true);
1301
1302         // get LaTeX-Filename
1303         FileName const path(temppath());
1304         string const name = addName(path.absFilename(), getLatexName());
1305         string const org_path = filePath();
1306
1307         support::Path p(path); // path to LaTeX file
1308         message(_("Running chktex..."));
1309
1310         // Generate the LaTeX file if neccessary
1311         OutputParams runparams(&params().encoding());
1312         runparams.flavor = OutputParams::LATEX;
1313         runparams.nice = false;
1314         makeLaTeXFile(FileName(name), org_path, runparams);
1315
1316         TeXErrors terr;
1317         Chktex chktex(lyxrc.chktex_command, onlyFilename(name), filePath());
1318         int const res = chktex.run(terr); // run chktex
1319
1320         if (res == -1) {
1321                 Alert::error(_("chktex failure"),
1322                              _("Could not run chktex successfully."));
1323         } else if (res > 0) {
1324                 ErrorList & errorList = pimpl_->errorLists["ChkTeX"];
1325                 // Clear out old errors
1326                 errorList.clear();
1327                 // Fill-in the error list with the TeX errors
1328                 bufferErrors(*this, terr, errorList);
1329         }
1330
1331         busy(false);
1332
1333         errors("ChkTeX");
1334
1335         return res;
1336 }
1337
1338
1339 void Buffer::validate(LaTeXFeatures & features) const
1340 {
1341         TextClass const & tclass = params().getTextClass();
1342
1343         if (params().outputChanges) {
1344                 bool dvipost    = LaTeXFeatures::isAvailable("dvipost");
1345                 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
1346                                   LaTeXFeatures::isAvailable("xcolor");
1347
1348                 if (features.runparams().flavor == OutputParams::LATEX) {
1349                         if (dvipost) {
1350                                 features.require("ct-dvipost");
1351                                 features.require("dvipost");
1352                         } else if (xcolorsoul) {
1353                                 features.require("ct-xcolor-soul");
1354                                 features.require("soul");
1355                                 features.require("xcolor");
1356                         } else {
1357                                 features.require("ct-none");
1358                         }
1359                 } else if (features.runparams().flavor == OutputParams::PDFLATEX ) {
1360                         if (xcolorsoul) {
1361                                 features.require("ct-xcolor-soul");
1362                                 features.require("soul");
1363                                 features.require("xcolor");
1364                                 features.require("pdfcolmk"); // improves color handling in PDF output
1365                         } else {
1366                                 features.require("ct-none");
1367                         }
1368                 }
1369         }
1370
1371         // AMS Style is at document level
1372         if (params().use_amsmath == BufferParams::package_on
1373             || tclass.provides("amsmath"))
1374                 features.require("amsmath");
1375         if (params().use_esint == BufferParams::package_on)
1376                 features.require("esint");
1377
1378         loadChildDocuments(*this);
1379
1380         for_each(paragraphs().begin(), paragraphs().end(),
1381                  boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1382
1383         // the bullet shapes are buffer level not paragraph level
1384         // so they are tested here
1385         for (int i = 0; i < 4; ++i) {
1386                 if (params().user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1387                         int const font = params().user_defined_bullet(i).getFont();
1388                         if (font == 0) {
1389                                 int const c = params()
1390                                         .user_defined_bullet(i)
1391                                         .getCharacter();
1392                                 if (c == 16
1393                                    || c == 17
1394                                    || c == 25
1395                                    || c == 26
1396                                    || c == 31) {
1397                                         features.require("latexsym");
1398                                 }
1399                         } else if (font == 1) {
1400                                 features.require("amssymb");
1401                         } else if ((font >= 2 && font <= 5)) {
1402                                 features.require("pifont");
1403                         }
1404                 }
1405         }
1406
1407         if (lyxerr.debugging(Debug::LATEX)) {
1408                 features.showStruct();
1409         }
1410 }
1411
1412
1413 void Buffer::getLabelList(vector<docstring> & list) const
1414 {
1415         /// if this is a child document and the parent is already loaded
1416         /// Use the parent's list instead  [ale990407]
1417         Buffer const * tmp = getMasterBuffer();
1418         if (!tmp) {
1419                 lyxerr << "getMasterBuffer() failed!" << endl;
1420                 BOOST_ASSERT(tmp);
1421         }
1422         if (tmp != this) {
1423                 tmp->getLabelList(list);
1424                 return;
1425         }
1426
1427         loadChildDocuments(*this);
1428
1429         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1430                 it.nextInset()->getLabelList(*this, list);
1431 }
1432
1433
1434 void Buffer::updateBibfilesCache()
1435 {
1436         // if this is a child document and the parent is already loaded
1437         // update the parent's cache instead
1438         Buffer * tmp = getMasterBuffer();
1439         BOOST_ASSERT(tmp);
1440         if (tmp != this) {
1441                 tmp->updateBibfilesCache();
1442                 return;
1443         }
1444
1445         bibfilesCache_.clear();
1446         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1447                 if (it->lyxCode() == Inset::BIBTEX_CODE) {
1448                         InsetBibtex const & inset =
1449                                 static_cast<InsetBibtex const &>(*it);
1450                         vector<FileName> const bibfiles = inset.getFiles(*this);
1451                         bibfilesCache_.insert(bibfilesCache_.end(),
1452                                 bibfiles.begin(),
1453                                 bibfiles.end());
1454                 } else if (it->lyxCode() == Inset::INCLUDE_CODE) {
1455                         InsetInclude & inset =
1456                                 static_cast<InsetInclude &>(*it);
1457                         inset.updateBibfilesCache(*this);
1458                         vector<FileName> const & bibfiles =
1459                                         inset.getBibfilesCache(*this);
1460                         bibfilesCache_.insert(bibfilesCache_.end(),
1461                                 bibfiles.begin(),
1462                                 bibfiles.end());
1463                 }
1464         }
1465 }
1466
1467
1468 vector<FileName> const & Buffer::getBibfilesCache() const
1469 {
1470         // if this is a child document and the parent is already loaded
1471         // use the parent's cache instead
1472         Buffer const * tmp = getMasterBuffer();
1473         BOOST_ASSERT(tmp);
1474         if (tmp != this)
1475                 return tmp->getBibfilesCache();
1476
1477         // We update the cache when first used instead of at loading time.
1478         if (bibfilesCache_.empty())
1479                 const_cast<Buffer *>(this)->updateBibfilesCache();
1480
1481         return bibfilesCache_;
1482 }
1483
1484
1485 bool Buffer::isDepClean(string const & name) const
1486 {
1487         DepClean::const_iterator const it = pimpl_->dep_clean.find(name);
1488         if (it == pimpl_->dep_clean.end())
1489                 return true;
1490         return it->second;
1491 }
1492
1493
1494 void Buffer::markDepClean(string const & name)
1495 {
1496         pimpl_->dep_clean[name] = true;
1497 }
1498
1499
1500 bool Buffer::dispatch(string const & command, bool * result)
1501 {
1502         return dispatch(lyxaction.lookupFunc(command), result);
1503 }
1504
1505
1506 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1507 {
1508         bool dispatched = true;
1509
1510         switch (func.action) {
1511                 case LFUN_BUFFER_EXPORT: {
1512                         bool const tmp = Exporter::Export(this, to_utf8(func.argument()), false);
1513                         if (result)
1514                                 *result = tmp;
1515                         break;
1516                 }
1517
1518                 default:
1519                         dispatched = false;
1520         }
1521         return dispatched;
1522 }
1523
1524
1525 void Buffer::changeLanguage(Language const * from, Language const * to)
1526 {
1527         BOOST_ASSERT(from);
1528         BOOST_ASSERT(to);
1529
1530         for_each(par_iterator_begin(),
1531                  par_iterator_end(),
1532                  bind(&Paragraph::changeLanguage, _1, params(), from, to));
1533 }
1534
1535
1536 bool Buffer::isMultiLingual() const
1537 {
1538         ParConstIterator end = par_iterator_end();
1539         for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1540                 if (it->isMultiLingual(params()))
1541                         return true;
1542
1543         return false;
1544 }
1545
1546
1547 ParIterator Buffer::getParFromID(int const id) const
1548 {
1549         ParConstIterator it = par_iterator_begin();
1550         ParConstIterator const end = par_iterator_end();
1551
1552         if (id < 0) {
1553                 // John says this is called with id == -1 from undo
1554                 lyxerr << "getParFromID(), id: " << id << endl;
1555                 return end;
1556         }
1557
1558         for (; it != end; ++it)
1559                 if (it->id() == id)
1560                         return it;
1561
1562         return end;
1563 }
1564
1565
1566 bool Buffer::hasParWithID(int const id) const
1567 {
1568         ParConstIterator const it = getParFromID(id);
1569         return it != par_iterator_end();
1570 }
1571
1572
1573 ParIterator Buffer::par_iterator_begin()
1574 {
1575         return lyx::par_iterator_begin(inset());
1576 }
1577
1578
1579 ParIterator Buffer::par_iterator_end()
1580 {
1581         return lyx::par_iterator_end(inset());
1582 }
1583
1584
1585 ParConstIterator Buffer::par_iterator_begin() const
1586 {
1587         return lyx::par_const_iterator_begin(inset());
1588 }
1589
1590
1591 ParConstIterator Buffer::par_iterator_end() const
1592 {
1593         return lyx::par_const_iterator_end(inset());
1594 }
1595
1596
1597 Language const * Buffer::getLanguage() const
1598 {
1599         return params().language;
1600 }
1601
1602
1603 docstring const Buffer::B_(string const & l10n) const
1604 {
1605         return params().B_(l10n);
1606 }
1607
1608
1609 bool Buffer::isClean() const
1610 {
1611         return pimpl_->lyx_clean;
1612 }
1613
1614
1615 bool Buffer::isBakClean() const
1616 {
1617         return pimpl_->bak_clean;
1618 }
1619
1620
1621 bool Buffer::isExternallyModified(CheckMethod method) const
1622 {
1623         BOOST_ASSERT(fs::exists(pimpl_->filename.toFilesystemEncoding()));
1624         // if method == timestamp, check timestamp before checksum
1625         return (method == checksum_method
1626                 || pimpl_->timestamp_ != fs::last_write_time(pimpl_->filename.toFilesystemEncoding()))
1627                 && pimpl_->checksum_ != sum(pimpl_->filename);
1628 }
1629
1630
1631 void Buffer::markClean() const
1632 {
1633         if (!pimpl_->lyx_clean) {
1634                 pimpl_->lyx_clean = true;
1635                 updateTitles();
1636         }
1637         // if the .lyx file has been saved, we don't need an
1638         // autosave
1639         pimpl_->bak_clean = true;
1640 }
1641
1642
1643 void Buffer::markBakClean()
1644 {
1645         pimpl_->bak_clean = true;
1646 }
1647
1648
1649 void Buffer::setUnnamed(bool flag)
1650 {
1651         pimpl_->unnamed = flag;
1652 }
1653
1654
1655 bool Buffer::isUnnamed() const
1656 {
1657         return pimpl_->unnamed;
1658 }
1659
1660
1661 // FIXME: this function should be moved to buffer_pimpl.C
1662 void Buffer::markDirty()
1663 {
1664         if (pimpl_->lyx_clean) {
1665                 pimpl_->lyx_clean = false;
1666                 updateTitles();
1667         }
1668         pimpl_->bak_clean = false;
1669
1670         DepClean::iterator it = pimpl_->dep_clean.begin();
1671         DepClean::const_iterator const end = pimpl_->dep_clean.end();
1672
1673         for (; it != end; ++it)
1674                 it->second = false;
1675 }
1676
1677
1678 string const Buffer::fileName() const
1679 {
1680         return pimpl_->filename.absFilename();
1681 }
1682
1683
1684 string const & Buffer::filePath() const
1685 {
1686         return params().filepath;
1687 }
1688
1689
1690 bool Buffer::isReadonly() const
1691 {
1692         return pimpl_->read_only;
1693 }
1694
1695
1696 void Buffer::setParentName(string const & name)
1697 {
1698         if (name == pimpl_->filename.absFilename())
1699                 // Avoids recursive include.
1700                 params().parentname.clear();
1701         else
1702                 params().parentname = name;
1703 }
1704
1705
1706 Buffer const * Buffer::getMasterBuffer() const
1707 {
1708         if (!params().parentname.empty()
1709             && theBufferList().exists(params().parentname)) {
1710                 Buffer const * buf = theBufferList().getBuffer(params().parentname);
1711                 //We need to check if the parent is us...
1712                 //FIXME RECURSIVE INCLUDE
1713                 //This is not sufficient, since recursive includes could be downstream.
1714                 if (buf && buf != this)
1715                         return buf->getMasterBuffer();
1716         }
1717
1718         return this;
1719 }
1720
1721
1722 Buffer * Buffer::getMasterBuffer()
1723 {
1724         if (!params().parentname.empty()
1725             && theBufferList().exists(params().parentname)) {
1726                 Buffer * buf = theBufferList().getBuffer(params().parentname);
1727                 if (buf)
1728                         return buf->getMasterBuffer();
1729         }
1730
1731         return this;
1732 }
1733
1734
1735 MacroData const & Buffer::getMacro(docstring const & name) const
1736 {
1737         return pimpl_->macros.get(name);
1738 }
1739
1740
1741 bool Buffer::hasMacro(docstring const & name) const
1742 {
1743         return pimpl_->macros.has(name);
1744 }
1745
1746
1747 void Buffer::insertMacro(docstring const & name, MacroData const & data)
1748 {
1749         MacroTable::globalMacros().insert(name, data);
1750         pimpl_->macros.insert(name, data);
1751 }
1752
1753
1754 void Buffer::buildMacros()
1755 {
1756         // Start with global table.
1757         pimpl_->macros = MacroTable::globalMacros();
1758
1759         // Now add our own.
1760         ParagraphList const & pars = text().paragraphs();
1761         for (size_t i = 0, n = pars.size(); i != n; ++i) {
1762                 //lyxerr << "searching main par " << i
1763                 //      << " for macro definitions" << std::endl;
1764                 InsetList const & insets = pars[i].insetlist;
1765                 InsetList::const_iterator it = insets.begin();
1766                 InsetList::const_iterator end = insets.end();
1767                 for ( ; it != end; ++it) {
1768                         //lyxerr << "found inset code " << it->inset->lyxCode() << std::endl;
1769                         if (it->inset->lyxCode() == Inset::MATHMACRO_CODE) {
1770                                 MathMacroTemplate const & mac
1771                                         = static_cast<MathMacroTemplate const &>(*it->inset);
1772                                 insertMacro(mac.name(), mac.asMacroData());
1773                         }
1774                 }
1775         }
1776 }
1777
1778
1779 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
1780         Inset::Code code)
1781 {
1782         //FIXME: This does not work for child documents yet.
1783         BOOST_ASSERT(code == Inset::CITE_CODE || code == Inset::REF_CODE);
1784         // Check if the label 'from' appears more than once
1785         vector<docstring> labels;
1786
1787         if (code == Inset::CITE_CODE) {
1788                 BiblioInfo keys;
1789                 keys.fillWithBibKeys(this);
1790                 BiblioInfo::const_iterator bit  = keys.begin();
1791                 BiblioInfo::const_iterator bend = keys.end();
1792
1793                 for (; bit != bend; ++bit)
1794                         // FIXME UNICODE
1795                         labels.push_back(bit->first);
1796         } else
1797                 getLabelList(labels);
1798
1799         if (std::count(labels.begin(), labels.end(), from) > 1)
1800                 return;
1801
1802         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1803                 if (it->lyxCode() == code) {
1804                         InsetCommand & inset = static_cast<InsetCommand &>(*it);
1805                         inset.replaceContents(to_utf8(from), to_utf8(to));
1806                 }
1807         }
1808 }
1809
1810
1811 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
1812         pit_type par_end, bool full_source)
1813 {
1814         OutputParams runparams(&params().encoding());
1815         runparams.nice = true;
1816         runparams.flavor = OutputParams::LATEX;
1817         runparams.linelen = lyxrc.plaintext_linelen;
1818         // No side effect of file copying and image conversion
1819         runparams.dryrun = true;
1820
1821         texrow().reset();
1822         if (full_source) {
1823                 os << "% " << _("Preview source code") << "\n\n";
1824                 texrow().newline();
1825                 texrow().newline();
1826                 if (isLatex())
1827                         writeLaTeXSource(os, filePath(), runparams, true, true);
1828                 else {
1829                         writeDocBookSource(os, fileName(), runparams, false);
1830                 }
1831         } else {
1832                 runparams.par_begin = par_begin;
1833                 runparams.par_end = par_end;
1834                 if (par_begin + 1 == par_end)
1835                         os << "% "
1836                            << bformat(_("Preview source code for paragraph %1$d"), par_begin)
1837                            << "\n\n";
1838                 else
1839                         os << "% "
1840                            << bformat(_("Preview source code from paragraph %1$s to %2$s"),
1841                                         convert<docstring>(par_begin),
1842                                         convert<docstring>(par_end - 1))
1843                            << "\n\n";
1844                 texrow().newline();
1845                 texrow().newline();
1846                 // output paragraphs
1847                 if (isLatex()) {
1848                         latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
1849                 } else {
1850                         // DocBook
1851                         docbookParagraphs(paragraphs(), *this, os, runparams);
1852                 }
1853         }
1854 }
1855
1856
1857 ErrorList const & Buffer::errorList(string const & type) const
1858 {
1859         static ErrorList const emptyErrorList;
1860         std::map<string, ErrorList>::const_iterator I = pimpl_->errorLists.find(type);
1861         if (I == pimpl_->errorLists.end())
1862                 return emptyErrorList;
1863
1864         return I->second;
1865 }
1866
1867
1868 ErrorList & Buffer::errorList(string const & type)
1869 {
1870         return pimpl_->errorLists[type];
1871 }
1872
1873
1874 } // namespace lyx