src/buffer.C

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