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