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