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