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