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