src/Buffer.cpp

   1 /**
   2  * \file Buffer.cpp
   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  * \author Stefan Schimanski
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "Buffer.h"
  15
  16 #include "Author.h"
  17 #include "LayoutFile.h"
  18 #include "BiblioInfo.h"
  19 #include "BranchList.h"
  20 #include "buffer_funcs.h"
  21 #include "BufferList.h"
  22 #include "BufferParams.h"
  23 #include "Bullet.h"
  24 #include "Chktex.h"
  25 #include "Converter.h"
  26 #include "Counters.h"
  27 #include "DocIterator.h"
  28 #include "Encoding.h"
  29 #include "ErrorList.h"
  30 #include "Exporter.h"
  31 #include "Format.h"
  32 #include "FuncRequest.h"
  33 #include "InsetIterator.h"
  34 #include "InsetList.h"
  35 #include "Language.h"
  36 #include "LaTeXFeatures.h"
  37 #include "LaTeX.h"
  38 #include "Layout.h"
  39 #include "Lexer.h"
  40 #include "LyXAction.h"
  41 #include "LyX.h"
  42 #include "LyXRC.h"
  43 #include "LyXVC.h"
  44 #include "output_docbook.h"
  45 #include "output.h"
  46 #include "output_latex.h"
  47 #include "output_plaintext.h"
  48 #include "paragraph_funcs.h"
  49 #include "Paragraph.h"
  50 #include "ParagraphParameters.h"
  51 #include "ParIterator.h"
  52 #include "PDFOptions.h"
  53 #include "sgml.h"
  54 #include "TexRow.h"
  55 #include "TexStream.h"
  56 #include "Text.h"
  57 #include "TextClass.h"
  58 #include "TocBackend.h"
  59 #include "Undo.h"
  60 #include "VCBackend.h"
  61 #include "version.h"
  62 #include "WordList.h"
  63
  64 #include "insets/InsetBibitem.h"
  65 #include "insets/InsetBibtex.h"
  66 #include "insets/InsetInclude.h"
  67 #include "insets/InsetText.h"
  68
  69 #include "mathed/MacroTable.h"
  70 #include "mathed/MathMacroTemplate.h"
  71 #include "mathed/MathSupport.h"
  72
  73 #include "frontends/alert.h"
  74 #include "frontends/Delegates.h"
  75 #include "frontends/WorkAreaManager.h"
  76
  77 #include "graphics/Previews.h"
  78
  79 #include "support/lassert.h"
  80 #include "support/convert.h"
  81 #include "support/debug.h"
  82 #include "support/ExceptionMessage.h"
  83 #include "support/FileName.h"
  84 #include "support/FileNameList.h"
  85 #include "support/filetools.h"
  86 #include "support/ForkedCalls.h"
  87 #include "support/gettext.h"
  88 #include "support/gzstream.h"
  89 #include "support/lstrings.h"
  90 #include "support/lyxalgo.h"
  91 #include "support/os.h"
  92 #include "support/Package.h"
  93 #include "support/Path.h"
  94 #include "support/textutils.h"
  95 #include "support/types.h"
  96
  97 #include <boost/bind.hpp>
  98 #include <boost/shared_ptr.hpp>
  99
 100 #include <algorithm>
 101 #include <fstream>
 102 #include <iomanip>
 103 #include <map>
 104 #include <set>
 105 #include <sstream>
 106 #include <stack>
 107 #include <vector>
 108
 109 using namespace std;
 110 using namespace lyx::support;
 111
 112 namespace lyx {
 113
 114 namespace Alert = frontend::Alert;
 115 namespace os = support::os;
 116
 117 namespace {
 118
 119 // Do not remove the comment below, so we get merge conflict in
 120 // independent branches. Instead add your own.
 121 int const LYX_FORMAT = 346;  // jspitzm: Swiss German
 122
 123 typedef map<string, bool> DepClean;
 124 typedef map<docstring, pair<InsetLabel const *, Buffer::References> > RefCache;
 125
 126 } // namespace anon
 127
 128 class BufferSet : public std::set<Buffer const *> {};
 129
 130 class Buffer::Impl
 131 {
 132 public:
 133         Impl(Buffer & parent, FileName const & file, bool readonly);
 134
 135         ~Impl()
 136         {
 137                 if (wa_) {
 138                         wa_->closeAll();
 139                         delete wa_;
 140                 }
 141                 delete inset;
 142         }
 143
 144         BufferParams params;
 145         LyXVC lyxvc;
 146         FileName temppath;
 147         mutable TexRow texrow;
 148         Buffer const * parent_buffer;
 149
 150         /// need to regenerate .tex?
 151         DepClean dep_clean;
 152
 153         /// is save needed?
 154         mutable bool lyx_clean;
 155
 156         /// is autosave needed?
 157         mutable bool bak_clean;
 158
 159         /// is this a unnamed file (New...)?
 160         bool unnamed;
 161
 162         /// buffer is r/o
 163         bool read_only;
 164
 165         /// name of the file the buffer is associated with.
 166         FileName filename;
 167
 168         /** Set to true only when the file is fully loaded.
 169          *  Used to prevent the premature generation of previews
 170          *  and by the citation inset.
 171          */
 172         bool file_fully_loaded;
 173
 174         ///
 175         mutable TocBackend toc_backend;
 176
 177         /// macro tables
 178         typedef pair<DocIterator, MacroData> ScopeMacro;
 179         typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
 180         typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
 181         /// map from the macro name to the position map,
 182         /// which maps the macro definition position to the scope and the MacroData.
 183         NamePositionScopeMacroMap macros;
 184         bool macro_lock;
 185
 186         /// positions of child buffers in the buffer
 187         typedef map<Buffer const * const, DocIterator> BufferPositionMap;
 188         typedef pair<DocIterator, Buffer const *> ScopeBuffer;
 189         typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
 190         /// position of children buffers in this buffer
 191         BufferPositionMap children_positions;
 192         /// map from children inclusion positions to their scope and their buffer
 193         PositionScopeBufferMap position_to_children;
 194
 195         /// Container for all sort of Buffer dependant errors.
 196         map<string, ErrorList> errorLists;
 197
 198         /// timestamp and checksum used to test if the file has been externally
 199         /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
 200         time_t timestamp_;
 201         unsigned long checksum_;
 202
 203         ///
 204         frontend::WorkAreaManager * wa_;
 205
 206         ///
 207         Undo undo_;
 208
 209         /// A cache for the bibfiles (including bibfiles of loaded child
 210         /// documents), needed for appropriate update of natbib labels.
 211         mutable support::FileNameList bibfilesCache_;
 212
 213         // FIXME The caching mechanism could be improved. At present, we have a
 214         // cache for each Buffer, that caches all the bibliography info for that
 215         // Buffer. A more efficient solution would be to have a global cache per
 216         // file, and then to construct the Buffer's bibinfo from that.
 217         /// A cache for bibliography info
 218         mutable BiblioInfo bibinfo_;
 219         /// whether the bibinfo cache is valid
 220         bool bibinfoCacheValid_;
 221         /// Cache of timestamps of .bib files
 222         map<FileName, time_t> bibfileStatus_;
 223
 224         mutable RefCache ref_cache_;
 225
 226         /// our Text that should be wrapped in an InsetText
 227         InsetText * inset;
 228 };
 229
 230
 231 /// Creates the per buffer temporary directory
 232 static FileName createBufferTmpDir()
 233 {
 234         static int count;
 235         // We are in our own directory.  Why bother to mangle name?
 236         // In fact I wrote this code to circumvent a problematic behaviour
 237         // (bug?) of EMX mkstemp().
 238         FileName tmpfl(package().temp_dir().absFilename() + "/lyx_tmpbuf" +
 239                 convert<string>(count++));
 240
 241         if (!tmpfl.createDirectory(0777)) {
 242                 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
 243                         _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
 244                         from_utf8(tmpfl.absFilename())));
 245         }
 246         return tmpfl;
 247 }
 248
 249
 250 Buffer::Impl::Impl(Buffer & parent, FileName const & file, bool readonly_)
 251         : parent_buffer(0), lyx_clean(true), bak_clean(true), unnamed(false),
 252           read_only(readonly_), filename(file), file_fully_loaded(false),
 253           toc_backend(&parent), macro_lock(false), timestamp_(0),
 254           checksum_(0), wa_(0), undo_(parent), bibinfoCacheValid_(false)
 255 {
 256         temppath = createBufferTmpDir();
 257         lyxvc.setBuffer(&parent);
 258         if (use_gui)
 259                 wa_ = new frontend::WorkAreaManager;
 260 }
 261
 262
 263 Buffer::Buffer(string const & file, bool readonly)
 264         : d(new Impl(*this, FileName(file), readonly)), gui_(0)
 265 {
 266         LYXERR(Debug::INFO, "Buffer::Buffer()");
 267
 268         d->inset = new InsetText(*this);
 269         d->inset->setAutoBreakRows(true);
 270         d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
 271 }
 272
 273
 274 Buffer::~Buffer()
 275 {
 276         LYXERR(Debug::INFO, "Buffer::~Buffer()");
 277         // here the buffer should take care that it is
 278         // saved properly, before it goes into the void.
 279
 280         // GuiView already destroyed
 281         gui_ = 0;
 282
 283         if (d->unnamed && d->filename.extension() == "internal") {
 284                 // No need to do additional cleanups for internal buffer.
 285                 delete d;
 286                 return;
 287         }
 288
 289         // loop over children
 290         Impl::BufferPositionMap::iterator it = d->children_positions.begin();
 291         Impl::BufferPositionMap::iterator end = d->children_positions.end();
 292         for (; it != end; ++it)
 293                 theBufferList().releaseChild(this, const_cast<Buffer *>(it->first));
 294
 295         // clear references to children in macro tables
 296         d->children_positions.clear();
 297         d->position_to_children.clear();
 298
 299         if (!d->temppath.destroyDirectory()) {
 300                 Alert::warning(_("Could not remove temporary directory"),
 301                         bformat(_("Could not remove the temporary directory %1$s"),
 302                         from_utf8(d->temppath.absFilename())));
 303         }
 304
 305         // Remove any previewed LaTeX snippets associated with this buffer.
 306         thePreviews().removeLoader(*this);
 307
 308         delete d;
 309 }
 310
 311
 312 void Buffer::changed() const
 313 {
 314         if (d->wa_)
 315                 d->wa_->redrawAll();
 316 }
 317
 318
 319 frontend::WorkAreaManager & Buffer::workAreaManager() const
 320 {
 321         LASSERT(d->wa_, /**/);
 322         return *d->wa_;
 323 }
 324
 325
 326 Text & Buffer::text() const
 327 {
 328         return d->inset->text();
 329 }
 330
 331
 332 Inset & Buffer::inset() const
 333 {
 334         return *d->inset;
 335 }
 336
 337
 338 BufferParams & Buffer::params()
 339 {
 340         return d->params;
 341 }
 342
 343
 344 BufferParams const & Buffer::params() const
 345 {
 346         return d->params;
 347 }
 348
 349
 350 ParagraphList & Buffer::paragraphs()
 351 {
 352         return text().paragraphs();
 353 }
 354
 355
 356 ParagraphList const & Buffer::paragraphs() const
 357 {
 358         return text().paragraphs();
 359 }
 360
 361
 362 LyXVC & Buffer::lyxvc()
 363 {
 364         return d->lyxvc;
 365 }
 366
 367
 368 LyXVC const & Buffer::lyxvc() const
 369 {
 370         return d->lyxvc;
 371 }
 372
 373
 374 string const Buffer::temppath() const
 375 {
 376         return d->temppath.absFilename();
 377 }
 378
 379
 380 TexRow & Buffer::texrow()
 381 {
 382         return d->texrow;
 383 }
 384
 385
 386 TexRow const & Buffer::texrow() const
 387 {
 388         return d->texrow;
 389 }
 390
 391
 392 TocBackend & Buffer::tocBackend() const
 393 {
 394         return d->toc_backend;
 395 }
 396
 397
 398 Undo & Buffer::undo()
 399 {
 400         return d->undo_;
 401 }
 402
 403
 404 string Buffer::latexName(bool const no_path) const
 405 {
 406         FileName latex_name = makeLatexName(d->filename);
 407         return no_path ? latex_name.onlyFileName()
 408                 : latex_name.absFilename();
 409 }
 410
 411
 412 string Buffer::logName(LogType * type) const
 413 {
 414         string const filename = latexName(false);
 415
 416         if (filename.empty()) {
 417                 if (type)
 418                         *type = latexlog;
 419                 return string();
 420         }
 421
 422         string const path = temppath();
 423
 424         FileName const fname(addName(temppath(),
 425                                      onlyFilename(changeExtension(filename,
 426                                                                   ".log"))));
 427         FileName const bname(
 428                 addName(path, onlyFilename(
 429                         changeExtension(filename,
 430                                         formats.extension("literate") + ".out"))));
 431
 432         // If no Latex log or Build log is newer, show Build log
 433
 434         if (bname.exists() &&
 435             (!fname.exists() || fname.lastModified() < bname.lastModified())) {
 436                 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
 437                 if (type)
 438                         *type = buildlog;
 439                 return bname.absFilename();
 440         }
 441         LYXERR(Debug::FILES, "Log name calculated as: " << fname);
 442         if (type)
 443                         *type = latexlog;
 444         return fname.absFilename();
 445 }
 446
 447
 448 void Buffer::setReadonly(bool const flag)
 449 {
 450         if (d->read_only != flag) {
 451                 d->read_only = flag;
 452                 setReadOnly(flag);
 453         }
 454 }
 455
 456
 457 void Buffer::setFileName(string const & newfile)
 458 {
 459         d->filename = makeAbsPath(newfile);
 460         setReadonly(d->filename.isReadOnly());
 461         updateTitles();
 462 }
 463
 464
 465 int Buffer::readHeader(Lexer & lex)
 466 {
 467         int unknown_tokens = 0;
 468         int line = -1;
 469         int begin_header_line = -1;
 470
 471         // Initialize parameters that may be/go lacking in header:
 472         params().branchlist().clear();
 473         params().preamble.erase();
 474         params().options.erase();
 475         params().master.erase();
 476         params().float_placement.erase();
 477         params().paperwidth.erase();
 478         params().paperheight.erase();
 479         params().leftmargin.erase();
 480         params().rightmargin.erase();
 481         params().topmargin.erase();
 482         params().bottommargin.erase();
 483         params().headheight.erase();
 484         params().headsep.erase();
 485         params().footskip.erase();
 486         params().columnsep.erase();
 487         params().fontsCJK.erase();
 488         params().listings_params.clear();
 489         params().clearLayoutModules();
 490         params().clearRemovedModules();
 491         params().pdfoptions().clear();
 492
 493         for (int i = 0; i < 4; ++i) {
 494                 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
 495                 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
 496         }
 497
 498         ErrorList & errorList = d->errorLists["Parse"];
 499
 500         while (lex.isOK()) {
 501                 string token;
 502                 lex >> token;
 503
 504                 if (token.empty())
 505                         continue;
 506
 507                 if (token == "\\end_header")
 508                         break;
 509
 510                 ++line;
 511                 if (token == "\\begin_header") {
 512                         begin_header_line = line;
 513                         continue;
 514                 }
 515
 516                 LYXERR(Debug::PARSER, "Handling document header token: `"
 517                                       << token << '\'');
 518
 519                 string unknown = params().readToken(lex, token, d->filename.onlyPath());
 520                 if (!unknown.empty()) {
 521                         if (unknown[0] != '\\' && token == "\\textclass") {
 522                                 Alert::warning(_("Unknown document class"),
 523                        bformat(_("Using the default document class, because the "
 524                                               "class %1$s is unknown."), from_utf8(unknown)));
 525                         } else {
 526                                 ++unknown_tokens;
 527                                 docstring const s = bformat(_("Unknown token: "
 528                                                                         "%1$s %2$s\n"),
 529                                                          from_utf8(token),
 530                                                          lex.getDocString());
 531                                 errorList.push_back(ErrorItem(_("Document header error"),
 532                                         s, -1, 0, 0));
 533                         }
 534                 }
 535         }
 536         if (begin_header_line) {
 537                 docstring const s = _("\\begin_header is missing");
 538                 errorList.push_back(ErrorItem(_("Document header error"),
 539                         s, -1, 0, 0));
 540         }
 541
 542         params().makeDocumentClass();
 543
 544         return unknown_tokens;
 545 }
 546
 547
 548 // Uwe C. Schroeder
 549 // changed to be public and have one parameter
 550 // Returns false if "\end_document" is not read (Asger)
 551 bool Buffer::readDocument(Lexer & lex)
 552 {
 553         ErrorList & errorList = d->errorLists["Parse"];
 554         errorList.clear();
 555
 556         if (!lex.checkFor("\\begin_document")) {
 557                 docstring const s = _("\\begin_document is missing");
 558                 errorList.push_back(ErrorItem(_("Document header error"),
 559                         s, -1, 0, 0));
 560         }
 561
 562         // we are reading in a brand new document
 563         LASSERT(paragraphs().empty(), /**/);
 564
 565         readHeader(lex);
 566
 567         if (params().outputChanges) {
 568                 bool dvipost    = LaTeXFeatures::isAvailable("dvipost");
 569                 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
 570                                   LaTeXFeatures::isAvailable("xcolor");
 571
 572                 if (!dvipost && !xcolorsoul) {
 573                         Alert::warning(_("Changes not shown in LaTeX output"),
 574                                        _("Changes will not be highlighted in LaTeX output, "
 575                                          "because neither dvipost nor xcolor/soul are installed.\n"
 576                                          "Please install these packages or redefine "
 577                                          "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
 578                 } else if (!xcolorsoul) {
 579                         Alert::warning(_("Changes not shown in LaTeX output"),
 580                                        _("Changes will not be highlighted in LaTeX output "
 581                                          "when using pdflatex, because xcolor and soul are not installed.\n"
 582                                          "Please install both packages or redefine "
 583                                          "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
 584                 }
 585         }
 586
 587         if (!params().master.empty()) {
 588                 FileName const master_file = makeAbsPath(params().master,
 589                            onlyPath(absFileName()));
 590                 if (isLyXFilename(master_file.absFilename())) {
 591                         Buffer * master = checkAndLoadLyXFile(master_file, true);
 592                         d->parent_buffer = master;
 593                 }
 594         }
 595
 596         // read main text
 597         bool const res = text().read(*this, lex, errorList, d->inset);
 598
 599         updateMacros();
 600         updateMacroInstances();
 601         return res;
 602 }
 603
 604
 605 // needed to insert the selection
 606 void Buffer::insertStringAsLines(ParagraphList & pars,
 607         pit_type & pit, pos_type & pos,
 608         Font const & fn, docstring const & str, bool autobreakrows)
 609 {
 610         Font font = fn;
 611
 612         // insert the string, don't insert doublespace
 613         bool space_inserted = true;
 614         for (docstring::const_iterator cit = str.begin();
 615             cit != str.end(); ++cit) {
 616                 Paragraph & par = pars[pit];
 617                 if (*cit == '\n') {
 618                         if (autobreakrows && (!par.empty() || par.allowEmpty())) {
 619                                 breakParagraph(params(), pars, pit, pos,
 620                                                par.layout().isEnvironment());
 621                                 ++pit;
 622                                 pos = 0;
 623                                 space_inserted = true;
 624                         } else {
 625                                 continue;
 626                         }
 627                         // do not insert consecutive spaces if !free_spacing
 628                 } else if ((*cit == ' ' || *cit == '\t') &&
 629                            space_inserted && !par.isFreeSpacing()) {
 630                         continue;
 631                 } else if (*cit == '\t') {
 632                         if (!par.isFreeSpacing()) {
 633                                 // tabs are like spaces here
 634                                 par.insertChar(pos, ' ', font, params().trackChanges);
 635                                 ++pos;
 636                                 space_inserted = true;
 637                         } else {
 638                                 par.insertChar(pos, *cit, font, params().trackChanges);
 639                                 ++pos;
 640                                 space_inserted = true;
 641                         }
 642                 } else if (!isPrintable(*cit)) {
 643                         // Ignore unprintables
 644                         continue;
 645                 } else {
 646                         // just insert the character
 647                         par.insertChar(pos, *cit, font, params().trackChanges);
 648                         ++pos;
 649                         space_inserted = (*cit == ' ');
 650                 }
 651
 652         }
 653 }
 654
 655
 656 bool Buffer::readString(string const & s)
 657 {
 658         params().compressed = false;
 659
 660         // remove dummy empty par
 661         paragraphs().clear();
 662         Lexer lex;
 663         istringstream is(s);
 664         lex.setStream(is);
 665         FileName const name = FileName::tempName("Buffer_readString");
 666         switch (readFile(lex, name, true)) {
 667         case failure:
 668                 return false;
 669         case wrongversion: {
 670                 // We need to call lyx2lyx, so write the input to a file
 671                 ofstream os(name.toFilesystemEncoding().c_str());
 672                 os << s;
 673                 os.close();
 674                 return readFile(name);
 675         }
 676         case success:
 677                 break;
 678         }
 679
 680         return true;
 681 }
 682
 683
 684 bool Buffer::readFile(FileName const & filename)
 685 {
 686         FileName fname(filename);
 687
 688         params().compressed = fname.isZippedFile();
 689
 690         // remove dummy empty par
 691         paragraphs().clear();
 692         Lexer lex;
 693         lex.setFile(fname);
 694         if (readFile(lex, fname) != success)
 695                 return false;
 696
 697         return true;
 698 }
 699
 700
 701 bool Buffer::isFullyLoaded() const
 702 {
 703         return d->file_fully_loaded;
 704 }
 705
 706
 707 void Buffer::setFullyLoaded(bool value)
 708 {
 709         d->file_fully_loaded = value;
 710 }
 711
 712
 713 Buffer::ReadStatus Buffer::readFile(Lexer & lex, FileName const & filename,
 714                 bool fromstring)
 715 {
 716         LASSERT(!filename.empty(), /**/);
 717
 718         // the first (non-comment) token _must_ be...
 719         if (!lex.checkFor("\\lyxformat")) {
 720                 Alert::error(_("Document format failure"),
 721                              bformat(_("%1$s is not a readable LyX document."),
 722                                        from_utf8(filename.absFilename())));
 723                 return failure;
 724         }
 725
 726         string tmp_format;
 727         lex >> tmp_format;
 728         //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
 729         // if present remove ".," from string.
 730         size_t dot = tmp_format.find_first_of(".,");
 731         //lyxerr << "           dot found at " << dot << endl;
 732         if (dot != string::npos)
 733                         tmp_format.erase(dot, 1);
 734         int const file_format = convert<int>(tmp_format);
 735         //lyxerr << "format: " << file_format << endl;
 736
 737         // save timestamp and checksum of the original disk file, making sure
 738         // to not overwrite them with those of the file created in the tempdir
 739         // when it has to be converted to the current format.
 740         if (!d->checksum_) {
 741                 // Save the timestamp and checksum of disk file. If filename is an
 742                 // emergency file, save the timestamp and checksum of the original lyx file
 743                 // because isExternallyModified will check for this file. (BUG4193)
 744                 string diskfile = filename.absFilename();
 745                 if (suffixIs(diskfile, ".emergency"))
 746                         diskfile = diskfile.substr(0, diskfile.size() - 10);
 747                 saveCheckSum(FileName(diskfile));
 748         }
 749
 750         if (file_format != LYX_FORMAT) {
 751
 752                 if (fromstring)
 753                         // lyx2lyx would fail
 754                         return wrongversion;
 755
 756                 FileName const tmpfile = FileName::tempName("Buffer_readFile");
 757                 if (tmpfile.empty()) {
 758                         Alert::error(_("Conversion failed"),
 759                                      bformat(_("%1$s is from a different"
 760                                               " version of LyX, but a temporary"
 761                                               " file for converting it could"
 762                                                             " not be created."),
 763                                               from_utf8(filename.absFilename())));
 764                         return failure;
 765                 }
 766                 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
 767                 if (lyx2lyx.empty()) {
 768                         Alert::error(_("Conversion script not found"),
 769                                      bformat(_("%1$s is from a different"
 770                                                " version of LyX, but the"
 771                                                " conversion script lyx2lyx"
 772                                                             " could not be found."),
 773                                                from_utf8(filename.absFilename())));
 774                         return failure;
 775                 }
 776                 ostringstream command;
 777                 command << os::python()
 778                         << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
 779                         << " -t " << convert<string>(LYX_FORMAT)
 780                         << " -o " << quoteName(tmpfile.toFilesystemEncoding())
 781                         << ' ' << quoteName(filename.toFilesystemEncoding());
 782                 string const command_str = command.str();
 783
 784                 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
 785
 786                 cmd_ret const ret = runCommand(command_str);
 787                 if (ret.first != 0) {
 788                         Alert::error(_("Conversion script failed"),
 789                                      bformat(_("%1$s is from a different version"
 790                                               " of LyX, but the lyx2lyx script"
 791                                                             " failed to convert it."),
 792                                               from_utf8(filename.absFilename())));
 793                         return failure;
 794                 } else {
 795                         bool const ret = readFile(tmpfile);
 796                         // Do stuff with tmpfile name and buffer name here.
 797                         return ret ? success : failure;
 798                 }
 799
 800         }
 801
 802         if (readDocument(lex)) {
 803                 Alert::error(_("Document format failure"),
 804                              bformat(_("%1$s ended unexpectedly, which means"
 805                                                     " that it is probably corrupted."),
 806                                        from_utf8(filename.absFilename())));
 807         }
 808
 809         d->file_fully_loaded = true;
 810         return success;
 811 }
 812
 813
 814 // Should probably be moved to somewhere else: BufferView? LyXView?
 815 bool Buffer::save() const
 816 {
 817         // We don't need autosaves in the immediate future. (Asger)
 818         resetAutosaveTimers();
 819
 820         string const encodedFilename = d->filename.toFilesystemEncoding();
 821
 822         FileName backupName;
 823         bool madeBackup = false;
 824
 825         // make a backup if the file already exists
 826         if (lyxrc.make_backup && fileName().exists()) {
 827                 backupName = FileName(absFileName() + '~');
 828                 if (!lyxrc.backupdir_path.empty()) {
 829                         string const mangledName =
 830                                 subst(subst(backupName.absFilename(), '/', '!'), ':', '!');
 831                         backupName = FileName(addName(lyxrc.backupdir_path,
 832                                                       mangledName));
 833                 }
 834                 if (fileName().copyTo(backupName)) {
 835                         madeBackup = true;
 836                 } else {
 837                         Alert::error(_("Backup failure"),
 838                                      bformat(_("Cannot create backup file %1$s.\n"
 839                                                "Please check whether the directory exists and is writeable."),
 840                                              from_utf8(backupName.absFilename())));
 841                         //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
 842                 }
 843         }
 844
 845         // ask if the disk file has been externally modified (use checksum method)
 846         if (fileName().exists() && isExternallyModified(checksum_method)) {
 847                 docstring const file = makeDisplayPath(absFileName(), 20);
 848                 docstring text = bformat(_("Document %1$s has been externally modified. Are you sure "
 849                                                              "you want to overwrite this file?"), file);
 850                 int const ret = Alert::prompt(_("Overwrite modified file?"),
 851                         text, 1, 1, _("&Overwrite"), _("&Cancel"));
 852                 if (ret == 1)
 853                         return false;
 854         }
 855
 856         if (writeFile(d->filename)) {
 857                 markClean();
 858                 return true;
 859         } else {
 860                 // Saving failed, so backup is not backup
 861                 if (madeBackup)
 862                         backupName.moveTo(d->filename);
 863                 return false;
 864         }
 865 }
 866
 867
 868 bool Buffer::writeFile(FileName const & fname) const
 869 {
 870         if (d->read_only && fname == d->filename)
 871                 return false;
 872
 873         bool retval = false;
 874
 875         docstring const str = bformat(_("Saving document %1$s..."),
 876                 makeDisplayPath(fname.absFilename()));
 877         message(str);
 878
 879         if (params().compressed) {
 880                 gz::ogzstream ofs(fname.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
 881                 retval = ofs && write(ofs);
 882         } else {
 883                 ofstream ofs(fname.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
 884                 retval = ofs && write(ofs);
 885         }
 886
 887         if (!retval) {
 888                 message(str + _(" could not write file!"));
 889                 return false;
 890         }
 891
 892         removeAutosaveFile(d->filename.absFilename());
 893
 894         saveCheckSum(d->filename);
 895         message(str + _(" done."));
 896
 897         return true;
 898 }
 899
 900
 901 bool Buffer::write(ostream & ofs) const
 902 {
 903 #ifdef HAVE_LOCALE
 904         // Use the standard "C" locale for file output.
 905         ofs.imbue(locale::classic());
 906 #endif
 907
 908         // The top of the file should not be written by params().
 909
 910         // write out a comment in the top of the file
 911         ofs << "#LyX " << lyx_version
 912             << " created this file. For more info see http://www.lyx.org/\n"
 913             << "\\lyxformat " << LYX_FORMAT << "\n"
 914             << "\\begin_document\n";
 915
 916         /// For each author, set 'used' to true if there is a change
 917         /// by this author in the document; otherwise set it to 'false'.
 918         AuthorList::Authors::const_iterator a_it = params().authors().begin();
 919         AuthorList::Authors::const_iterator a_end = params().authors().end();
 920         for (; a_it != a_end; ++a_it)
 921                 a_it->second.setUsed(false);
 922
 923         ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
 924         ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
 925         for ( ; it != end; ++it)
 926                 it->checkAuthors(params().authors());
 927
 928         // now write out the buffer parameters.
 929         ofs << "\\begin_header\n";
 930         params().writeFile(ofs);
 931         ofs << "\\end_header\n";
 932
 933         // write the text
 934         ofs << "\n\\begin_body\n";
 935         text().write(*this, ofs);
 936         ofs << "\n\\end_body\n";
 937
 938         // Write marker that shows file is complete
 939         ofs << "\\end_document" << endl;
 940
 941         // Shouldn't really be needed....
 942         //ofs.close();
 943
 944         // how to check if close went ok?
 945         // Following is an attempt... (BE 20001011)
 946
 947         // good() returns false if any error occured, including some
 948         //        formatting error.
 949         // bad()  returns true if something bad happened in the buffer,
 950         //        which should include file system full errors.
 951
 952         bool status = true;
 953         if (!ofs) {
 954                 status = false;
 955                 lyxerr << "File was not closed properly." << endl;
 956         }
 957
 958         return status;
 959 }
 960
 961
 962 bool Buffer::makeLaTeXFile(FileName const & fname,
 963                            string const & original_path,
 964                            OutputParams const & runparams,
 965                            bool output_preamble, bool output_body) const
 966 {
 967         string const encoding = runparams.encoding->iconvName();
 968         LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << "...");
 969
 970         ofdocstream ofs;
 971         try { ofs.reset(encoding); }
 972         catch (iconv_codecvt_facet_exception & e) {
 973                 lyxerr << "Caught iconv exception: " << e.what() << endl;
 974                 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
 975                         "verify that the support software for your encoding (%1$s) is "
 976                         "properly installed"), from_ascii(encoding)));
 977                 return false;
 978         }
 979         if (!openFileWrite(ofs, fname))
 980                 return false;
 981
 982         //TexStream ts(ofs.rdbuf(), &texrow());
 983         ErrorList & errorList = d->errorLists["Export"];
 984         errorList.clear();
 985         bool failed_export = false;
 986         try {
 987                 d->texrow.reset();
 988                 writeLaTeXSource(ofs, original_path,
 989                       runparams, output_preamble, output_body);
 990         }
 991         catch (EncodingException & e) {
 992                 odocstringstream ods;
 993                 ods.put(e.failed_char);
 994                 ostringstream oss;
 995                 oss << "0x" << hex << e.failed_char << dec;
 996                 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
 997                                           " (code point %2$s)"),
 998                                           ods.str(), from_utf8(oss.str()));
 999                 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1000                                 "representable in the chosen encoding.\n"
1001                                 "Changing the document encoding to utf8 could help."),
1002                                 e.par_id, e.pos, e.pos + 1));
1003                 failed_export = true;
1004         }
1005         catch (iconv_codecvt_facet_exception & e) {
1006                 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1007                         _(e.what()), -1, 0, 0));
1008                 failed_export = true;
1009         }
1010         catch (exception const & e) {
1011                 errorList.push_back(ErrorItem(_("conversion failed"),
1012                         _(e.what()), -1, 0, 0));
1013                 failed_export = true;
1014         }
1015         catch (...) {
1016                 lyxerr << "Caught some really weird exception..." << endl;
1017                 lyx_exit(1);
1018         }
1019
1020         ofs.close();
1021         if (ofs.fail()) {
1022                 failed_export = true;
1023                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1024         }
1025
1026         errors("Export");
1027         return !failed_export;
1028 }
1029
1030
1031 void Buffer::writeLaTeXSource(odocstream & os,
1032                            string const & original_path,
1033                            OutputParams const & runparams_in,
1034                            bool const output_preamble, bool const output_body) const
1035 {
1036         // The child documents, if any, shall be already loaded at this point.
1037
1038         OutputParams runparams = runparams_in;
1039
1040         // Classify the unicode characters appearing in math insets
1041         Encodings::initUnicodeMath(*this);
1042
1043         // validate the buffer.
1044         LYXERR(Debug::LATEX, "  Validating buffer...");
1045         LaTeXFeatures features(*this, params(), runparams);
1046         validate(features);
1047         LYXERR(Debug::LATEX, "  Buffer validation done.");
1048
1049         // The starting paragraph of the coming rows is the
1050         // first paragraph of the document. (Asger)
1051         if (output_preamble && runparams.nice) {
1052                 os << "%% LyX " << lyx_version << " created this file.  "
1053                         "For more info, see http://www.lyx.org/.\n"
1054                         "%% Do not edit unless you really know what "
1055                         "you are doing.\n";
1056                 d->texrow.newline();
1057                 d->texrow.newline();
1058         }
1059         LYXERR(Debug::INFO, "lyx document header finished");
1060
1061         // Don't move this behind the parent_buffer=0 code below,
1062         // because then the macros will not get the right "redefinition"
1063         // flag as they don't see the parent macros which are output before.
1064         updateMacros();
1065
1066         // fold macros if possible, still with parent buffer as the
1067         // macros will be put in the prefix anyway.
1068         updateMacroInstances();
1069
1070         // There are a few differences between nice LaTeX and usual files:
1071         // usual is \batchmode and has a
1072         // special input@path to allow the including of figures
1073         // with either \input or \includegraphics (what figinsets do).
1074         // input@path is set when the actual parameter
1075         // original_path is set. This is done for usual tex-file, but not
1076         // for nice-latex-file. (Matthias 250696)
1077         // Note that input@path is only needed for something the user does
1078         // in the preamble, included .tex files or ERT, files included by
1079         // LyX work without it.
1080         if (output_preamble) {
1081                 if (!runparams.nice) {
1082                         // code for usual, NOT nice-latex-file
1083                         os << "\\batchmode\n"; // changed
1084                         // from \nonstopmode
1085                         d->texrow.newline();
1086                 }
1087                 if (!original_path.empty()) {
1088                         // FIXME UNICODE
1089                         // We don't know the encoding of inputpath
1090                         docstring const inputpath = from_utf8(latex_path(original_path));
1091                         os << "\\makeatletter\n"
1092                            << "\\def\\input@path{{"
1093                            << inputpath << "/}}\n"
1094                            << "\\makeatother\n";
1095                         d->texrow.newline();
1096                         d->texrow.newline();
1097                         d->texrow.newline();
1098                 }
1099
1100                 // get parent macros (if this buffer has a parent) which will be
1101                 // written at the document begin further down.
1102                 MacroSet parentMacros;
1103                 listParentMacros(parentMacros, features);
1104
1105                 // Write the preamble
1106                 runparams.use_babel = params().writeLaTeX(os, features, d->texrow);
1107
1108                 runparams.use_japanese = features.isRequired("japanese");
1109
1110                 if (!output_body)
1111                         return;
1112
1113                 // make the body.
1114                 os << "\\begin{document}\n";
1115                 d->texrow.newline();
1116
1117                 // output the parent macros
1118                 MacroSet::iterator it = parentMacros.begin();
1119                 MacroSet::iterator end = parentMacros.end();
1120                 for (; it != end; ++it)
1121                         (*it)->write(os, true);
1122         } // output_preamble
1123
1124         d->texrow.start(paragraphs().begin()->id(), 0);
1125
1126         LYXERR(Debug::INFO, "preamble finished, now the body.");
1127
1128         // if we are doing a real file with body, even if this is the
1129         // child of some other buffer, let's cut the link here.
1130         // This happens for example if only a child document is printed.
1131         Buffer const * save_parent = 0;
1132         if (output_preamble) {
1133                 save_parent = d->parent_buffer;
1134                 d->parent_buffer = 0;
1135         }
1136
1137         // the real stuff
1138         latexParagraphs(*this, text(), os, d->texrow, runparams);
1139
1140         // Restore the parenthood if needed
1141         if (output_preamble)
1142                 d->parent_buffer = save_parent;
1143
1144         // add this just in case after all the paragraphs
1145         os << endl;
1146         d->texrow.newline();
1147
1148         if (output_preamble) {
1149                 os << "\\end{document}\n";
1150                 d->texrow.newline();
1151                 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1152         } else {
1153                 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1154         }
1155         runparams_in.encoding = runparams.encoding;
1156
1157         // Just to be sure. (Asger)
1158         d->texrow.newline();
1159
1160         LYXERR(Debug::INFO, "Finished making LaTeX file.");
1161         LYXERR(Debug::INFO, "Row count was " << d->texrow.rows() - 1 << '.');
1162 }
1163
1164
1165 bool Buffer::isLatex() const
1166 {
1167         return params().documentClass().outputType() == LATEX;
1168 }
1169
1170
1171 bool Buffer::isLiterate() const
1172 {
1173         return params().documentClass().outputType() == LITERATE;
1174 }
1175
1176
1177 bool Buffer::isDocBook() const
1178 {
1179         return params().documentClass().outputType() == DOCBOOK;
1180 }
1181
1182
1183 void Buffer::makeDocBookFile(FileName const & fname,
1184                               OutputParams const & runparams,
1185                               bool const body_only) const
1186 {
1187         LYXERR(Debug::LATEX, "makeDocBookFile...");
1188
1189         ofdocstream ofs;
1190         if (!openFileWrite(ofs, fname))
1191                 return;
1192
1193         writeDocBookSource(ofs, fname.absFilename(), runparams, body_only);
1194
1195         ofs.close();
1196         if (ofs.fail())
1197                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1198 }
1199
1200
1201 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1202                              OutputParams const & runparams,
1203                              bool const only_body) const
1204 {
1205         LaTeXFeatures features(*this, params(), runparams);
1206         validate(features);
1207
1208         d->texrow.reset();
1209
1210         DocumentClass const & tclass = params().documentClass();
1211         string const top_element = tclass.latexname();
1212
1213         if (!only_body) {
1214                 if (runparams.flavor == OutputParams::XML)
1215                         os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1216
1217                 // FIXME UNICODE
1218                 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1219
1220                 // FIXME UNICODE
1221                 if (! tclass.class_header().empty())
1222                         os << from_ascii(tclass.class_header());
1223                 else if (runparams.flavor == OutputParams::XML)
1224                         os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1225                             << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1226                 else
1227                         os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1228
1229                 docstring preamble = from_utf8(params().preamble);
1230                 if (runparams.flavor != OutputParams::XML ) {
1231                         preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1232                         preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1233                         preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1234                         preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1235                 }
1236
1237                 string const name = runparams.nice
1238                         ? changeExtension(absFileName(), ".sgml") : fname;
1239                 preamble += features.getIncludedFiles(name);
1240                 preamble += features.getLyXSGMLEntities();
1241
1242                 if (!preamble.empty()) {
1243                         os << "\n [ " << preamble << " ]";
1244                 }
1245                 os << ">\n\n";
1246         }
1247
1248         string top = top_element;
1249         top += " lang=\"";
1250         if (runparams.flavor == OutputParams::XML)
1251                 top += params().language->code();
1252         else
1253                 top += params().language->code().substr(0, 2);
1254         top += '"';
1255
1256         if (!params().options.empty()) {
1257                 top += ' ';
1258                 top += params().options;
1259         }
1260
1261         os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1262             << " file was created by LyX " << lyx_version
1263             << "\n  See http://www.lyx.org/ for more information -->\n";
1264
1265         params().documentClass().counters().reset();
1266
1267         updateMacros();
1268
1269         sgml::openTag(os, top);
1270         os << '\n';
1271         docbookParagraphs(paragraphs(), *this, os, runparams);
1272         sgml::closeTag(os, top_element);
1273 }
1274
1275
1276 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1277 // Other flags: -wall -v0 -x
1278 int Buffer::runChktex()
1279 {
1280         setBusy(true);
1281
1282         // get LaTeX-Filename
1283         FileName const path(temppath());
1284         string const name = addName(path.absFilename(), latexName());
1285         string const org_path = filePath();
1286
1287         PathChanger p(path); // path to LaTeX file
1288         message(_("Running chktex..."));
1289
1290         // Generate the LaTeX file if neccessary
1291         OutputParams runparams(&params().encoding());
1292         runparams.flavor = OutputParams::LATEX;
1293         runparams.nice = false;
1294         makeLaTeXFile(FileName(name), org_path, runparams);
1295
1296         TeXErrors terr;
1297         Chktex chktex(lyxrc.chktex_command, onlyFilename(name), filePath());
1298         int const res = chktex.run(terr); // run chktex
1299
1300         if (res == -1) {
1301                 Alert::error(_("chktex failure"),
1302                              _("Could not run chktex successfully."));
1303         } else if (res > 0) {
1304                 ErrorList & errlist = d->errorLists["ChkTeX"];
1305                 errlist.clear();
1306                 bufferErrors(terr, errlist);
1307         }
1308
1309         setBusy(false);
1310
1311         errors("ChkTeX");
1312
1313         return res;
1314 }
1315
1316
1317 void Buffer::validate(LaTeXFeatures & features) const
1318 {
1319         params().validate(features);
1320
1321         updateMacros();
1322
1323         for_each(paragraphs().begin(), paragraphs().end(),
1324                  boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1325
1326         if (lyxerr.debugging(Debug::LATEX)) {
1327                 features.showStruct();
1328         }
1329 }
1330
1331
1332 void Buffer::getLabelList(vector<docstring> & list) const
1333 {
1334         // If this is a child document, use the parent's list instead.
1335         if (d->parent_buffer) {
1336                 d->parent_buffer->getLabelList(list);
1337                 return;
1338         }
1339
1340         list.clear();
1341         Toc & toc = d->toc_backend.toc("label");
1342         TocIterator toc_it = toc.begin();
1343         TocIterator end = toc.end();
1344         for (; toc_it != end; ++toc_it) {
1345                 if (toc_it->depth() == 0)
1346                         list.push_back(toc_it->str());
1347         }
1348 }
1349
1350
1351 void Buffer::updateBibfilesCache() const
1352 {
1353         // If this is a child document, use the parent's cache instead.
1354         if (d->parent_buffer) {
1355                 d->parent_buffer->updateBibfilesCache();
1356                 return;
1357         }
1358
1359         d->bibfilesCache_.clear();
1360         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1361                 if (it->lyxCode() == BIBTEX_CODE) {
1362                         InsetBibtex const & inset =
1363                                 static_cast<InsetBibtex const &>(*it);
1364                         support::FileNameList const bibfiles = inset.getBibFiles();
1365                         d->bibfilesCache_.insert(d->bibfilesCache_.end(),
1366                                 bibfiles.begin(),
1367                                 bibfiles.end());
1368                 } else if (it->lyxCode() == INCLUDE_CODE) {
1369                         InsetInclude & inset =
1370                                 static_cast<InsetInclude &>(*it);
1371                         inset.updateBibfilesCache();
1372                         support::FileNameList const & bibfiles =
1373                                         inset.getBibfilesCache(*this);
1374                         d->bibfilesCache_.insert(d->bibfilesCache_.end(),
1375                                 bibfiles.begin(),
1376                                 bibfiles.end());
1377                 }
1378         }
1379         // the bibinfo cache is now invalid
1380         d->bibinfoCacheValid_ = false;
1381 }
1382
1383
1384 void Buffer::invalidateBibinfoCache()
1385 {
1386         d->bibinfoCacheValid_ = false;
1387 }
1388
1389
1390 support::FileNameList const & Buffer::getBibfilesCache() const
1391 {
1392         // If this is a child document, use the parent's cache instead.
1393         if (d->parent_buffer)
1394                 return d->parent_buffer->getBibfilesCache();
1395
1396         // We update the cache when first used instead of at loading time.
1397         if (d->bibfilesCache_.empty())
1398                 const_cast<Buffer *>(this)->updateBibfilesCache();
1399
1400         return d->bibfilesCache_;
1401 }
1402
1403
1404 BiblioInfo const & Buffer::masterBibInfo() const
1405 {
1406         // if this is a child document and the parent is already loaded
1407         // use the parent's list instead  [ale990412]
1408         Buffer const * const tmp = masterBuffer();
1409         LASSERT(tmp, /**/);
1410         if (tmp != this)
1411                 return tmp->masterBibInfo();
1412         return localBibInfo();
1413 }
1414
1415
1416 BiblioInfo const & Buffer::localBibInfo() const
1417 {
1418         if (d->bibinfoCacheValid_) {
1419                 support::FileNameList const & bibfilesCache = getBibfilesCache();
1420                 // compare the cached timestamps with the actual ones.
1421                 support::FileNameList::const_iterator ei = bibfilesCache.begin();
1422                 support::FileNameList::const_iterator en = bibfilesCache.end();
1423                 for (; ei != en; ++ ei) {
1424                         time_t lastw = ei->lastModified();
1425                         if (lastw != d->bibfileStatus_[*ei]) {
1426                                 d->bibinfoCacheValid_ = false;
1427                                 d->bibfileStatus_[*ei] = lastw;
1428                                 break;
1429                         }
1430                 }
1431         }
1432
1433         if (!d->bibinfoCacheValid_) {
1434                 d->bibinfo_.clear();
1435                 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1436                         it->fillWithBibKeys(d->bibinfo_, it);
1437                 d->bibinfoCacheValid_ = true;
1438         }
1439         return d->bibinfo_;
1440 }
1441
1442
1443 bool Buffer::isDepClean(string const & name) const
1444 {
1445         DepClean::const_iterator const it = d->dep_clean.find(name);
1446         if (it == d->dep_clean.end())
1447                 return true;
1448         return it->second;
1449 }
1450
1451
1452 void Buffer::markDepClean(string const & name)
1453 {
1454         d->dep_clean[name] = true;
1455 }
1456
1457
1458 bool Buffer::dispatch(string const & command, bool * result)
1459 {
1460         return dispatch(lyxaction.lookupFunc(command), result);
1461 }
1462
1463
1464 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1465 {
1466         bool dispatched = true;
1467
1468         switch (func.action) {
1469                 case LFUN_BUFFER_EXPORT: {
1470                         bool const tmp = doExport(to_utf8(func.argument()), false);
1471                         if (result)
1472                                 *result = tmp;
1473                         break;
1474                 }
1475
1476                 case LFUN_BRANCH_ACTIVATE:
1477                 case LFUN_BRANCH_DEACTIVATE: {
1478                         BranchList & branchList = params().branchlist();
1479                         docstring const branchName = func.argument();
1480                         Branch * branch = branchList.find(branchName);
1481                         if (!branch)
1482                                 LYXERR0("Branch " << branchName << " does not exist.");
1483                         else
1484                                 branch->setSelected(func.action == LFUN_BRANCH_ACTIVATE);
1485                         if (result)
1486                                 *result = true;
1487                 }
1488
1489                 default:
1490                         dispatched = false;
1491         }
1492         return dispatched;
1493 }
1494
1495
1496 void Buffer::changeLanguage(Language const * from, Language const * to)
1497 {
1498         LASSERT(from, /**/);
1499         LASSERT(to, /**/);
1500
1501         for_each(par_iterator_begin(),
1502                  par_iterator_end(),
1503                  bind(&Paragraph::changeLanguage, _1, params(), from, to));
1504 }
1505
1506
1507 bool Buffer::isMultiLingual() const
1508 {
1509         ParConstIterator end = par_iterator_end();
1510         for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1511                 if (it->isMultiLingual(params()))
1512                         return true;
1513
1514         return false;
1515 }
1516
1517
1518 DocIterator Buffer::getParFromID(int const id) const
1519 {
1520         Buffer * buf = const_cast<Buffer *>(this);
1521         if (id < 0) {
1522                 // John says this is called with id == -1 from undo
1523                 lyxerr << "getParFromID(), id: " << id << endl;
1524                 return doc_iterator_end(buf);
1525         }
1526
1527         for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
1528                 if (it.paragraph().id() == id)
1529                         return it;
1530
1531         return doc_iterator_end(buf);
1532 }
1533
1534
1535 bool Buffer::hasParWithID(int const id) const
1536 {
1537         return !getParFromID(id).atEnd();
1538 }
1539
1540
1541 ParIterator Buffer::par_iterator_begin()
1542 {
1543         return ParIterator(doc_iterator_begin(this));
1544 }
1545
1546
1547 ParIterator Buffer::par_iterator_end()
1548 {
1549         return ParIterator(doc_iterator_end(this));
1550 }
1551
1552
1553 ParConstIterator Buffer::par_iterator_begin() const
1554 {
1555         return ParConstIterator(doc_iterator_begin(this));
1556 }
1557
1558
1559 ParConstIterator Buffer::par_iterator_end() const
1560 {
1561         return ParConstIterator(doc_iterator_end(this));
1562 }
1563
1564
1565 Language const * Buffer::language() const
1566 {
1567         return params().language;
1568 }
1569
1570
1571 docstring const Buffer::B_(string const & l10n) const
1572 {
1573         return params().B_(l10n);
1574 }
1575
1576
1577 bool Buffer::isClean() const
1578 {
1579         return d->lyx_clean;
1580 }
1581
1582
1583 bool Buffer::isBakClean() const
1584 {
1585         return d->bak_clean;
1586 }
1587
1588
1589 bool Buffer::isExternallyModified(CheckMethod method) const
1590 {
1591         LASSERT(d->filename.exists(), /**/);
1592         // if method == timestamp, check timestamp before checksum
1593         return (method == checksum_method
1594                 || d->timestamp_ != d->filename.lastModified())
1595                 && d->checksum_ != d->filename.checksum();
1596 }
1597
1598
1599 void Buffer::saveCheckSum(FileName const & file) const
1600 {
1601         if (file.exists()) {
1602                 d->timestamp_ = file.lastModified();
1603                 d->checksum_ = file.checksum();
1604         } else {
1605                 // in the case of save to a new file.
1606                 d->timestamp_ = 0;
1607                 d->checksum_ = 0;
1608         }
1609 }
1610
1611
1612 void Buffer::markClean() const
1613 {
1614         if (!d->lyx_clean) {
1615                 d->lyx_clean = true;
1616                 updateTitles();
1617         }
1618         // if the .lyx file has been saved, we don't need an
1619         // autosave
1620         d->bak_clean = true;
1621 }
1622
1623
1624 void Buffer::markBakClean() const
1625 {
1626         d->bak_clean = true;
1627 }
1628
1629
1630 void Buffer::setUnnamed(bool flag)
1631 {
1632         d->unnamed = flag;
1633 }
1634
1635
1636 bool Buffer::isUnnamed() const
1637 {
1638         return d->unnamed;
1639 }
1640
1641
1642 // FIXME: this function should be moved to buffer_pimpl.C
1643 void Buffer::markDirty()
1644 {
1645         if (d->lyx_clean) {
1646                 d->lyx_clean = false;
1647                 updateTitles();
1648         }
1649         d->bak_clean = false;
1650
1651         DepClean::iterator it = d->dep_clean.begin();
1652         DepClean::const_iterator const end = d->dep_clean.end();
1653
1654         for (; it != end; ++it)
1655                 it->second = false;
1656 }
1657
1658
1659 FileName Buffer::fileName() const
1660 {
1661         return d->filename;
1662 }
1663
1664
1665 string Buffer::absFileName() const
1666 {
1667         return d->filename.absFilename();
1668 }
1669
1670
1671 string Buffer::filePath() const
1672 {
1673         return d->filename.onlyPath().absFilename() + "/";
1674 }
1675
1676
1677 bool Buffer::isReadonly() const
1678 {
1679         return d->read_only;
1680 }
1681
1682
1683 void Buffer::setParent(Buffer const * buffer)
1684 {
1685         // Avoids recursive include.
1686         d->parent_buffer = buffer == this ? 0 : buffer;
1687         updateMacros();
1688 }
1689
1690
1691 Buffer const * Buffer::parent() const
1692 {
1693         return d->parent_buffer;
1694 }
1695
1696
1697 void Buffer::collectRelatives(BufferSet & bufs) const
1698 {
1699         bufs.insert(this);
1700         if (parent())
1701                 parent()->collectRelatives(bufs);
1702
1703         // loop over children
1704         Impl::BufferPositionMap::iterator it = d->children_positions.begin();
1705         Impl::BufferPositionMap::iterator end = d->children_positions.end();
1706         for (; it != end; ++it)
1707                 bufs.insert(const_cast<Buffer *>(it->first));
1708 }
1709
1710
1711 std::vector<Buffer const *> Buffer::allRelatives() const
1712 {
1713         BufferSet bufs;
1714         collectRelatives(bufs);
1715         BufferSet::iterator it = bufs.begin();
1716         std::vector<Buffer const *> ret;
1717         for (; it != bufs.end(); ++it)
1718                 ret.push_back(*it);
1719         return ret;
1720 }
1721
1722
1723 Buffer const * Buffer::masterBuffer() const
1724 {
1725         if (!d->parent_buffer)
1726                 return this;
1727
1728         return d->parent_buffer->masterBuffer();
1729 }
1730
1731
1732 bool Buffer::isChild(Buffer * child) const
1733 {
1734         return d->children_positions.find(child) != d->children_positions.end();
1735 }
1736
1737
1738 DocIterator Buffer::firstChildPosition(Buffer const * child)
1739 {
1740         Impl::BufferPositionMap::iterator it;
1741         it = d->children_positions.find(child);
1742         if (it == d->children_positions.end())
1743                 return DocIterator(this);
1744         return it->second;
1745 }
1746
1747
1748 template<typename M>
1749 typename M::iterator greatest_below(M & m, typename M::key_type const & x)
1750 {
1751         if (m.empty())
1752                 return m.end();
1753
1754         typename M::iterator it = m.lower_bound(x);
1755         if (it == m.begin())
1756                 return m.end();
1757
1758         it--;
1759         return it;
1760 }
1761
1762
1763 MacroData const * Buffer::getBufferMacro(docstring const & name,
1764                                          DocIterator const & pos) const
1765 {
1766         LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
1767
1768         // if paragraphs have no macro context set, pos will be empty
1769         if (pos.empty())
1770                 return 0;
1771
1772         // we haven't found anything yet
1773         DocIterator bestPos = par_iterator_begin();
1774         MacroData const * bestData = 0;
1775
1776         // find macro definitions for name
1777         Impl::NamePositionScopeMacroMap::iterator nameIt
1778                 = d->macros.find(name);
1779         if (nameIt != d->macros.end()) {
1780                 // find last definition in front of pos or at pos itself
1781                 Impl::PositionScopeMacroMap::const_iterator it
1782                         = greatest_below(nameIt->second, pos);
1783                 if (it != nameIt->second.end()) {
1784                         while (true) {
1785                                 // scope ends behind pos?
1786                                 if (pos < it->second.first) {
1787                                         // Looks good, remember this. If there
1788                                         // is no external macro behind this,
1789                                         // we found the right one already.
1790                                         bestPos = it->first;
1791                                         bestData = &it->second.second;
1792                                         break;
1793                                 }
1794
1795                                 // try previous macro if there is one
1796                                 if (it == nameIt->second.begin())
1797                                         break;
1798                                 it--;
1799                         }
1800                 }
1801         }
1802
1803         // find macros in included files
1804         Impl::PositionScopeBufferMap::const_iterator it
1805                 = greatest_below(d->position_to_children, pos);
1806         if (it == d->position_to_children.end())
1807                 // no children before
1808                 return bestData;
1809
1810         while (true) {
1811                 // do we know something better (i.e. later) already?
1812                 if (it->first < bestPos )
1813                         break;
1814
1815                 // scope ends behind pos?
1816                 if (pos < it->second.first) {
1817                         // look for macro in external file
1818                         d->macro_lock = true;
1819                         MacroData const * data
1820                         = it->second.second->getMacro(name, false);
1821                         d->macro_lock = false;
1822                         if (data) {
1823                                 bestPos = it->first;
1824                                 bestData = data;
1825                                 break;
1826                         }
1827                 }
1828
1829                 // try previous file if there is one
1830                 if (it == d->position_to_children.begin())
1831                         break;
1832                 --it;
1833         }
1834
1835         // return the best macro we have found
1836         return bestData;
1837 }
1838
1839
1840 MacroData const * Buffer::getMacro(docstring const & name,
1841         DocIterator const & pos, bool global) const
1842 {
1843         if (d->macro_lock)
1844                 return 0;
1845
1846         // query buffer macros
1847         MacroData const * data = getBufferMacro(name, pos);
1848         if (data != 0)
1849                 return data;
1850
1851         // If there is a master buffer, query that
1852         if (d->parent_buffer) {
1853                 d->macro_lock = true;
1854                 MacroData const * macro = d->parent_buffer->getMacro(
1855                         name, *this, false);
1856                 d->macro_lock = false;
1857                 if (macro)
1858                         return macro;
1859         }
1860
1861         if (global) {
1862                 data = MacroTable::globalMacros().get(name);
1863                 if (data != 0)
1864                         return data;
1865         }
1866
1867         return 0;
1868 }
1869
1870
1871 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
1872 {
1873         // set scope end behind the last paragraph
1874         DocIterator scope = par_iterator_begin();
1875         scope.pit() = scope.lastpit() + 1;
1876
1877         return getMacro(name, scope, global);
1878 }
1879
1880
1881 MacroData const * Buffer::getMacro(docstring const & name,
1882         Buffer const & child, bool global) const
1883 {
1884         // look where the child buffer is included first
1885         Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
1886         if (it == d->children_positions.end())
1887                 return 0;
1888
1889         // check for macros at the inclusion position
1890         return getMacro(name, it->second, global);
1891 }
1892
1893
1894 void Buffer::updateMacros(DocIterator & it, DocIterator & scope) const
1895 {
1896         pit_type lastpit = it.lastpit();
1897
1898         // look for macros in each paragraph
1899         while (it.pit() <= lastpit) {
1900                 Paragraph & par = it.paragraph();
1901
1902                 // iterate over the insets of the current paragraph
1903                 InsetList const & insets = par.insetList();
1904                 InsetList::const_iterator iit = insets.begin();
1905                 InsetList::const_iterator end = insets.end();
1906                 for (; iit != end; ++iit) {
1907                         it.pos() = iit->pos;
1908
1909                         // is it a nested text inset?
1910                         if (iit->inset->asInsetText()) {
1911                                 // Inset needs its own scope?
1912                                 InsetText const * itext
1913                                 = iit->inset->asInsetText();
1914                                 bool newScope = itext->isMacroScope();
1915
1916                                 // scope which ends just behind the inset
1917                                 DocIterator insetScope = it;
1918                                 ++insetScope.pos();
1919
1920                                 // collect macros in inset
1921                                 it.push_back(CursorSlice(*iit->inset));
1922                                 updateMacros(it, newScope ? insetScope : scope);
1923                                 it.pop_back();
1924                                 continue;
1925                         }
1926
1927                         // is it an external file?
1928                         if (iit->inset->lyxCode() == INCLUDE_CODE) {
1929                                 // get buffer of external file
1930                                 InsetInclude const & inset
1931                                         = static_cast<InsetInclude const &>(*iit->inset);
1932                                 d->macro_lock = true;
1933                                 Buffer * child = inset.loadIfNeeded(*this);
1934                                 d->macro_lock = false;
1935                                 if (!child)
1936                                         continue;
1937
1938                                 // register its position, but only when it is
1939                                 // included first in the buffer
1940                                 if (d->children_positions.find(child)
1941                                         == d->children_positions.end())
1942                                         d->children_positions[child] = it;
1943
1944                                 // register child with its scope
1945                                 d->position_to_children[it] = Impl::ScopeBuffer(scope, child);
1946                                 continue;
1947                         }
1948
1949                         if (iit->inset->lyxCode() != MATHMACRO_CODE)
1950                                 continue;
1951
1952                         // get macro data
1953                         MathMacroTemplate & macroTemplate
1954                         = static_cast<MathMacroTemplate &>(*iit->inset);
1955                         MacroContext mc(*this, it);
1956                         macroTemplate.updateToContext(mc);
1957
1958                         // valid?
1959                         bool valid = macroTemplate.validMacro();
1960                         // FIXME: Should be fixNameAndCheckIfValid() in fact,
1961                         // then the BufferView's cursor will be invalid in
1962                         // some cases which leads to crashes.
1963                         if (!valid)
1964                                 continue;
1965
1966                         // register macro
1967                         d->macros[macroTemplate.name()][it] =
1968                                 Impl::ScopeMacro(scope, MacroData(*this, it));
1969                 }
1970
1971                 // next paragraph
1972                 it.pit()++;
1973                 it.pos() = 0;
1974         }
1975 }
1976
1977
1978 void Buffer::updateMacros() const
1979 {
1980         if (d->macro_lock)
1981                 return;
1982
1983         LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
1984
1985         // start with empty table
1986         d->macros.clear();
1987         d->children_positions.clear();
1988         d->position_to_children.clear();
1989
1990         // Iterate over buffer, starting with first paragraph
1991         // The scope must be bigger than any lookup DocIterator
1992         // later. For the global lookup, lastpit+1 is used, hence
1993         // we use lastpit+2 here.
1994         DocIterator it = par_iterator_begin();
1995         DocIterator outerScope = it;
1996         outerScope.pit() = outerScope.lastpit() + 2;
1997         updateMacros(it, outerScope);
1998 }
1999
2000
2001 void Buffer::updateMacroInstances() const
2002 {
2003         LYXERR(Debug::MACROS, "updateMacroInstances for "
2004                 << d->filename.onlyFileName());
2005         DocIterator it = doc_iterator_begin(this);
2006         DocIterator end = doc_iterator_end(this);
2007         for (; it != end; it.forwardPos()) {
2008                 // look for MathData cells in InsetMathNest insets
2009                 Inset * inset = it.nextInset();
2010                 if (!inset)
2011                         continue;
2012
2013                 InsetMath * minset = inset->asInsetMath();
2014                 if (!minset)
2015                         continue;
2016
2017                 // update macro in all cells of the InsetMathNest
2018                 DocIterator::idx_type n = minset->nargs();
2019                 MacroContext mc = MacroContext(*this, it);
2020                 for (DocIterator::idx_type i = 0; i < n; ++i) {
2021                         MathData & data = minset->cell(i);
2022                         data.updateMacros(0, mc);
2023                 }
2024         }
2025 }
2026
2027
2028 void Buffer::listMacroNames(MacroNameSet & macros) const
2029 {
2030         if (d->macro_lock)
2031                 return;
2032
2033         d->macro_lock = true;
2034
2035         // loop over macro names
2036         Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
2037         Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
2038         for (; nameIt != nameEnd; ++nameIt)
2039                 macros.insert(nameIt->first);
2040
2041         // loop over children
2042         Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2043         Impl::BufferPositionMap::iterator end = d->children_positions.end();
2044         for (; it != end; ++it)
2045                 it->first->listMacroNames(macros);
2046
2047         // call parent
2048         if (d->parent_buffer)
2049                 d->parent_buffer->listMacroNames(macros);
2050
2051         d->macro_lock = false;
2052 }
2053
2054
2055 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
2056 {
2057         if (!d->parent_buffer)
2058                 return;
2059
2060         MacroNameSet names;
2061         d->parent_buffer->listMacroNames(names);
2062
2063         // resolve macros
2064         MacroNameSet::iterator it = names.begin();
2065         MacroNameSet::iterator end = names.end();
2066         for (; it != end; ++it) {
2067                 // defined?
2068                 MacroData const * data =
2069                 d->parent_buffer->getMacro(*it, *this, false);
2070                 if (data) {
2071                         macros.insert(data);
2072
2073                         // we cannot access the original MathMacroTemplate anymore
2074                         // here to calls validate method. So we do its work here manually.
2075                         // FIXME: somehow make the template accessible here.
2076                         if (data->optionals() > 0)
2077                                 features.require("xargs");
2078                 }
2079         }
2080 }
2081
2082
2083 Buffer::References & Buffer::references(docstring const & label)
2084 {
2085         if (d->parent_buffer)
2086                 return const_cast<Buffer *>(masterBuffer())->references(label);
2087
2088         RefCache::iterator it = d->ref_cache_.find(label);
2089         if (it != d->ref_cache_.end())
2090                 return it->second.second;
2091
2092         static InsetLabel const * dummy_il = 0;
2093         static References const dummy_refs;
2094         it = d->ref_cache_.insert(
2095                 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
2096         return it->second.second;
2097 }
2098
2099
2100 Buffer::References const & Buffer::references(docstring const & label) const
2101 {
2102         return const_cast<Buffer *>(this)->references(label);
2103 }
2104
2105
2106 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
2107 {
2108         masterBuffer()->d->ref_cache_[label].first = il;
2109 }
2110
2111
2112 InsetLabel const * Buffer::insetLabel(docstring const & label) const
2113 {
2114         return masterBuffer()->d->ref_cache_[label].first;
2115 }
2116
2117
2118 void Buffer::clearReferenceCache() const
2119 {
2120         if (!d->parent_buffer)
2121                 d->ref_cache_.clear();
2122 }
2123
2124
2125 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
2126         InsetCode code)
2127 {
2128         //FIXME: This does not work for child documents yet.
2129         LASSERT(code == CITE_CODE, /**/);
2130         // Check if the label 'from' appears more than once
2131         vector<docstring> labels;
2132         string paramName;
2133         BiblioInfo const & keys = masterBibInfo();
2134         BiblioInfo::const_iterator bit  = keys.begin();
2135         BiblioInfo::const_iterator bend = keys.end();
2136
2137         for (; bit != bend; ++bit)
2138                 // FIXME UNICODE
2139                 labels.push_back(bit->first);
2140         paramName = "key";
2141
2142         if (count(labels.begin(), labels.end(), from) > 1)
2143                 return;
2144
2145         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2146                 if (it->lyxCode() == code) {
2147                         InsetCommand & inset = static_cast<InsetCommand &>(*it);
2148                         docstring const oldValue = inset.getParam(paramName);
2149                         if (oldValue == from)
2150                                 inset.setParam(paramName, to);
2151                 }
2152         }
2153 }
2154
2155
2156 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
2157         pit_type par_end, bool full_source) const
2158 {
2159         OutputParams runparams(&params().encoding());
2160         runparams.nice = true;
2161         runparams.flavor = OutputParams::LATEX;
2162         runparams.linelen = lyxrc.plaintext_linelen;
2163         // No side effect of file copying and image conversion
2164         runparams.dryrun = true;
2165
2166         d->texrow.reset();
2167         if (full_source) {
2168                 os << "% " << _("Preview source code") << "\n\n";
2169                 d->texrow.newline();
2170                 d->texrow.newline();
2171                 if (isDocBook())
2172                         writeDocBookSource(os, absFileName(), runparams, false);
2173                 else
2174                         // latex or literate
2175                         writeLaTeXSource(os, string(), runparams, true, true);
2176         } else {
2177                 runparams.par_begin = par_begin;
2178                 runparams.par_end = par_end;
2179                 if (par_begin + 1 == par_end) {
2180                         os << "% "
2181                            << bformat(_("Preview source code for paragraph %1$d"), par_begin)
2182                            << "\n\n";
2183                 } else {
2184                         os << "% "
2185                            << bformat(_("Preview source code from paragraph %1$s to %2$s"),
2186                                         convert<docstring>(par_begin),
2187                                         convert<docstring>(par_end - 1))
2188                            << "\n\n";
2189                 }
2190                 d->texrow.newline();
2191                 d->texrow.newline();
2192                 // output paragraphs
2193                 if (isDocBook())
2194                         docbookParagraphs(paragraphs(), *this, os, runparams);
2195                 else
2196                         // latex or literate
2197                         latexParagraphs(*this, text(), os, d->texrow, runparams);
2198         }
2199 }
2200
2201
2202 ErrorList & Buffer::errorList(string const & type) const
2203 {
2204         static ErrorList emptyErrorList;
2205         map<string, ErrorList>::iterator I = d->errorLists.find(type);
2206         if (I == d->errorLists.end())
2207                 return emptyErrorList;
2208
2209         return I->second;
2210 }
2211
2212
2213 void Buffer::updateTocItem(std::string const & type,
2214         DocIterator const & dit) const
2215 {
2216         if (gui_)
2217                 gui_->updateTocItem(type, dit);
2218 }
2219
2220
2221 void Buffer::structureChanged() const
2222 {
2223         if (gui_)
2224                 gui_->structureChanged();
2225 }
2226
2227
2228 void Buffer::errors(string const & err) const
2229 {
2230         if (gui_)
2231                 gui_->errors(err);
2232 }
2233
2234
2235 void Buffer::message(docstring const & msg) const
2236 {
2237         if (gui_)
2238                 gui_->message(msg);
2239 }
2240
2241
2242 void Buffer::setBusy(bool on) const
2243 {
2244         if (gui_)
2245                 gui_->setBusy(on);
2246 }
2247
2248
2249 void Buffer::setReadOnly(bool on) const
2250 {
2251         if (d->wa_)
2252                 d->wa_->setReadOnly(on);
2253 }
2254
2255
2256 void Buffer::updateTitles() const
2257 {
2258         if (d->wa_)
2259                 d->wa_->updateTitles();
2260 }
2261
2262
2263 void Buffer::resetAutosaveTimers() const
2264 {
2265         if (gui_)
2266                 gui_->resetAutosaveTimers();
2267 }
2268
2269
2270 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
2271 {
2272         gui_ = gui;
2273 }
2274
2275
2276
2277 namespace {
2278
2279 class AutoSaveBuffer : public ForkedProcess {
2280 public:
2281         ///
2282         AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
2283                 : buffer_(buffer), fname_(fname) {}
2284         ///
2285         virtual boost::shared_ptr<ForkedProcess> clone() const
2286         {
2287                 return boost::shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
2288         }
2289         ///
2290         int start()
2291         {
2292                 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
2293                                                  from_utf8(fname_.absFilename())));
2294                 return run(DontWait);
2295         }
2296 private:
2297         ///
2298         virtual int generateChild();
2299         ///
2300         Buffer const & buffer_;
2301         FileName fname_;
2302 };
2303
2304
2305 int AutoSaveBuffer::generateChild()
2306 {
2307         // tmp_ret will be located (usually) in /tmp
2308         // will that be a problem?
2309         // Note that this calls ForkedCalls::fork(), so it's
2310         // ok cross-platform.
2311         pid_t const pid = fork();
2312         // If you want to debug the autosave
2313         // you should set pid to -1, and comment out the fork.
2314         if (pid != 0 && pid != -1)
2315                 return pid;
2316
2317         // pid = -1 signifies that lyx was unable
2318         // to fork. But we will do the save
2319         // anyway.
2320         bool failed = false;
2321         FileName const tmp_ret = FileName::tempName("lyxauto");
2322         if (!tmp_ret.empty()) {
2323                 buffer_.writeFile(tmp_ret);
2324                 // assume successful write of tmp_ret
2325                 if (!tmp_ret.moveTo(fname_))
2326                         failed = true;
2327         } else
2328                 failed = true;
2329
2330         if (failed) {
2331                 // failed to write/rename tmp_ret so try writing direct
2332                 if (!buffer_.writeFile(fname_)) {
2333                         // It is dangerous to do this in the child,
2334                         // but safe in the parent, so...
2335                         if (pid == -1) // emit message signal.
2336                                 buffer_.message(_("Autosave failed!"));
2337                 }
2338         }
2339
2340         if (pid == 0) // we are the child so...
2341                 _exit(0);
2342
2343         return pid;
2344 }
2345
2346 } // namespace anon
2347
2348
2349 // Perfect target for a thread...
2350 void Buffer::autoSave() const
2351 {
2352         if (isBakClean() || isReadonly()) {
2353                 // We don't save now, but we'll try again later
2354                 resetAutosaveTimers();
2355                 return;
2356         }
2357
2358         // emit message signal.
2359         message(_("Autosaving current document..."));
2360
2361         // create autosave filename
2362         string fname = filePath();
2363         fname += '#';
2364         fname += d->filename.onlyFileName();
2365         fname += '#';
2366
2367         AutoSaveBuffer autosave(*this, FileName(fname));
2368         autosave.start();
2369
2370         markBakClean();
2371         resetAutosaveTimers();
2372 }
2373
2374
2375 string Buffer::bufferFormat() const
2376 {
2377         if (isDocBook())
2378                 return "docbook";
2379         if (isLiterate())
2380                 return "literate";
2381         if (params().encoding().package() == Encoding::japanese)
2382                 return "platex";
2383         return "latex";
2384 }
2385
2386
2387 bool Buffer::doExport(string const & format, bool put_in_tempdir,
2388         string & result_file) const
2389 {
2390         string backend_format;
2391         OutputParams runparams(&params().encoding());
2392         runparams.flavor = OutputParams::LATEX;
2393         runparams.linelen = lyxrc.plaintext_linelen;
2394         vector<string> backs = backends();
2395         if (find(backs.begin(), backs.end(), format) == backs.end()) {
2396                 // Get shortest path to format
2397                 Graph::EdgePath path;
2398                 for (vector<string>::const_iterator it = backs.begin();
2399                      it != backs.end(); ++it) {
2400                         Graph::EdgePath p = theConverters().getPath(*it, format);
2401                         if (!p.empty() && (path.empty() || p.size() < path.size())) {
2402                                 backend_format = *it;
2403                                 path = p;
2404                         }
2405                 }
2406                 if (!path.empty())
2407                         runparams.flavor = theConverters().getFlavor(path);
2408                 else {
2409                         Alert::error(_("Couldn't export file"),
2410                                 bformat(_("No information for exporting the format %1$s."),
2411                                    formats.prettyName(format)));
2412                         return false;
2413                 }
2414         } else {
2415                 backend_format = format;
2416                 // FIXME: Don't hardcode format names here, but use a flag
2417                 if (backend_format == "pdflatex")
2418                         runparams.flavor = OutputParams::PDFLATEX;
2419         }
2420
2421         string filename = latexName(false);
2422         filename = addName(temppath(), filename);
2423         filename = changeExtension(filename,
2424                                    formats.extension(backend_format));
2425
2426         // fix macros
2427         updateMacroInstances();
2428
2429         // Plain text backend
2430         if (backend_format == "text")
2431                 writePlaintextFile(*this, FileName(filename), runparams);
2432         // no backend
2433         else if (backend_format == "lyx")
2434                 writeFile(FileName(filename));
2435         // Docbook backend
2436         else if (isDocBook()) {
2437                 runparams.nice = !put_in_tempdir;
2438                 makeDocBookFile(FileName(filename), runparams);
2439         }
2440         // LaTeX backend
2441         else if (backend_format == format) {
2442                 runparams.nice = true;
2443                 if (!makeLaTeXFile(FileName(filename), string(), runparams))
2444                         return false;
2445         } else if (!lyxrc.tex_allows_spaces
2446                    && contains(filePath(), ' ')) {
2447                 Alert::error(_("File name error"),
2448                            _("The directory path to the document cannot contain spaces."));
2449                 return false;
2450         } else {
2451                 runparams.nice = false;
2452                 if (!makeLaTeXFile(FileName(filename), filePath(), runparams))
2453                         return false;
2454         }
2455
2456         string const error_type = (format == "program")
2457                 ? "Build" : bufferFormat();
2458         ErrorList & error_list = d->errorLists[error_type];
2459         string const ext = formats.extension(format);
2460         FileName const tmp_result_file(changeExtension(filename, ext));
2461         bool const success = theConverters().convert(this, FileName(filename),
2462                 tmp_result_file, FileName(absFileName()), backend_format, format,
2463                 error_list);
2464         // Emit the signal to show the error list.
2465         if (format != backend_format)
2466                 errors(error_type);
2467         if (!success)
2468                 return false;
2469
2470         if (put_in_tempdir) {
2471                 result_file = tmp_result_file.absFilename();
2472                 return true;
2473         }
2474
2475         result_file = changeExtension(absFileName(), ext);
2476         // We need to copy referenced files (e. g. included graphics
2477         // if format == "dvi") to the result dir.
2478         vector<ExportedFile> const files =
2479                 runparams.exportdata->externalFiles(format);
2480         string const dest = onlyPath(result_file);
2481         CopyStatus status = SUCCESS;
2482         for (vector<ExportedFile>::const_iterator it = files.begin();
2483                 it != files.end() && status != CANCEL; ++it) {
2484                 string const fmt = formats.getFormatFromFile(it->sourceName);
2485                 status = copyFile(fmt, it->sourceName,
2486                         makeAbsPath(it->exportName, dest),
2487                         it->exportName, status == FORCE);
2488         }
2489         if (status == CANCEL) {
2490                 message(_("Document export cancelled."));
2491         } else if (tmp_result_file.exists()) {
2492                 // Finally copy the main file
2493                 status = copyFile(format, tmp_result_file,
2494                         FileName(result_file), result_file,
2495                         status == FORCE);
2496                 message(bformat(_("Document exported as %1$s "
2497                         "to file `%2$s'"),
2498                         formats.prettyName(format),
2499                         makeDisplayPath(result_file)));
2500         } else {
2501                 // This must be a dummy converter like fax (bug 1888)
2502                 message(bformat(_("Document exported as %1$s"),
2503                         formats.prettyName(format)));
2504         }
2505
2506         return true;
2507 }
2508
2509
2510 bool Buffer::doExport(string const & format, bool put_in_tempdir) const
2511 {
2512         string result_file;
2513         return doExport(format, put_in_tempdir, result_file);
2514 }
2515
2516
2517 bool Buffer::preview(string const & format) const
2518 {
2519         string result_file;
2520         if (!doExport(format, true, result_file))
2521                 return false;
2522         return formats.view(*this, FileName(result_file), format);
2523 }
2524
2525
2526 bool Buffer::isExportable(string const & format) const
2527 {
2528         vector<string> backs = backends();
2529         for (vector<string>::const_iterator it = backs.begin();
2530              it != backs.end(); ++it)
2531                 if (theConverters().isReachable(*it, format))
2532                         return true;
2533         return false;
2534 }
2535
2536
2537 vector<Format const *> Buffer::exportableFormats(bool only_viewable) const
2538 {
2539         vector<string> backs = backends();
2540         vector<Format const *> result =
2541                 theConverters().getReachable(backs[0], only_viewable, true);
2542         for (vector<string>::const_iterator it = backs.begin() + 1;
2543              it != backs.end(); ++it) {
2544                 vector<Format const *>  r =
2545                         theConverters().getReachable(*it, only_viewable, false);
2546                 result.insert(result.end(), r.begin(), r.end());
2547         }
2548         return result;
2549 }
2550
2551
2552 vector<string> Buffer::backends() const
2553 {
2554         vector<string> v;
2555         if (params().baseClass()->isTeXClassAvailable()) {
2556                 v.push_back(bufferFormat());
2557                 // FIXME: Don't hardcode format names here, but use a flag
2558                 if (v.back() == "latex")
2559                         v.push_back("pdflatex");
2560         }
2561         v.push_back("text");
2562         v.push_back("lyx");
2563         return v;
2564 }
2565
2566
2567 bool Buffer::readFileHelper(FileName const & s)
2568 {
2569         // File information about normal file
2570         if (!s.exists()) {
2571                 docstring const file = makeDisplayPath(s.absFilename(), 50);
2572                 docstring text = bformat(_("The specified document\n%1$s"
2573                                                      "\ncould not be read."), file);
2574                 Alert::error(_("Could not read document"), text);
2575                 return false;
2576         }
2577
2578         // Check if emergency save file exists and is newer.
2579         FileName const e(s.absFilename() + ".emergency");
2580
2581         if (e.exists() && s.exists() && e.lastModified() > s.lastModified()) {
2582                 docstring const file = makeDisplayPath(s.absFilename(), 20);
2583                 docstring const text =
2584                         bformat(_("An emergency save of the document "
2585                                   "%1$s exists.\n\n"
2586                                                "Recover emergency save?"), file);
2587                 switch (Alert::prompt(_("Load emergency save?"), text, 0, 2,
2588                                       _("&Recover"),  _("&Load Original"),
2589                                       _("&Cancel")))
2590                 {
2591                 case 0:
2592                         // the file is not saved if we load the emergency file.
2593                         markDirty();
2594                         return readFile(e);
2595                 case 1:
2596                         break;
2597                 default:
2598                         return false;
2599                 }
2600         }
2601
2602         // Now check if autosave file is newer.
2603         FileName const a(onlyPath(s.absFilename()) + '#' + onlyFilename(s.absFilename()) + '#');
2604
2605         if (a.exists() && s.exists() && a.lastModified() > s.lastModified()) {
2606                 docstring const file = makeDisplayPath(s.absFilename(), 20);
2607                 docstring const text =
2608                         bformat(_("The backup of the document "
2609                                   "%1$s is newer.\n\nLoad the "
2610                                                "backup instead?"), file);
2611                 switch (Alert::prompt(_("Load backup?"), text, 0, 2,
2612                                       _("&Load backup"), _("Load &original"),
2613                                       _("&Cancel") ))
2614                 {
2615                 case 0:
2616                         // the file is not saved if we load the autosave file.
2617                         markDirty();
2618                         return readFile(a);
2619                 case 1:
2620                         // Here we delete the autosave
2621                         a.removeFile();
2622                         break;
2623                 default:
2624                         return false;
2625                 }
2626         }
2627         return readFile(s);
2628 }
2629
2630
2631 bool Buffer::loadLyXFile(FileName const & s)
2632 {
2633         if (s.isReadableFile()) {
2634                 if (readFileHelper(s)) {
2635                         lyxvc().file_found_hook(s);
2636                         if (!s.isWritable())
2637                                 setReadonly(true);
2638                         return true;
2639                 }
2640         } else {
2641                 docstring const file = makeDisplayPath(s.absFilename(), 20);
2642                 // Here we probably should run
2643                 if (LyXVC::file_not_found_hook(s)) {
2644                         docstring const text =
2645                                 bformat(_("Do you want to retrieve the document"
2646                                                        " %1$s from version control?"), file);
2647                         int const ret = Alert::prompt(_("Retrieve from version control?"),
2648                                 text, 0, 1, _("&Retrieve"), _("&Cancel"));
2649
2650                         if (ret == 0) {
2651                                 // How can we know _how_ to do the checkout?
2652                                 // With the current VC support it has to be,
2653                                 // a RCS file since CVS do not have special ,v files.
2654                                 RCS::retrieve(s);
2655                                 return loadLyXFile(s);
2656                         }
2657                 }
2658         }
2659         return false;
2660 }
2661
2662
2663 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
2664 {
2665         TeXErrors::Errors::const_iterator cit = terr.begin();
2666         TeXErrors::Errors::const_iterator end = terr.end();
2667
2668         for (; cit != end; ++cit) {
2669                 int id_start = -1;
2670                 int pos_start = -1;
2671                 int errorRow = cit->error_in_line;
2672                 bool found = d->texrow.getIdFromRow(errorRow, id_start,
2673                                                        pos_start);
2674                 int id_end = -1;
2675                 int pos_end = -1;
2676                 do {
2677                         ++errorRow;
2678                         found = d->texrow.getIdFromRow(errorRow, id_end, pos_end);
2679                 } while (found && id_start == id_end && pos_start == pos_end);
2680
2681                 errorList.push_back(ErrorItem(cit->error_desc,
2682                         cit->error_text, id_start, pos_start, pos_end));
2683         }
2684 }
2685
2686
2687 void Buffer::updateLabels(bool childonly) const
2688 {
2689         // Use the master text class also for child documents
2690         Buffer const * const master = masterBuffer();
2691         DocumentClass const & textclass = master->params().documentClass();
2692
2693         // keep the buffers to be children in this set. If the call from the
2694         // master comes back we can see which of them were actually seen (i.e.
2695         // via an InsetInclude). The remaining ones in the set need still be updated.
2696         static std::set<Buffer const *> bufToUpdate;
2697         if (!childonly) {
2698                 // If this is a child document start with the master
2699                 if (master != this) {
2700                         bufToUpdate.insert(this);
2701                         master->updateLabels(false);
2702
2703                         // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
2704                         if (bufToUpdate.find(this) == bufToUpdate.end())
2705                                 return;
2706                 }
2707
2708                 // start over the counters in the master
2709                 textclass.counters().reset();
2710         }
2711
2712         // update will be done below for this buffer
2713         bufToUpdate.erase(this);
2714
2715         // update all caches
2716         clearReferenceCache();
2717         inset().setBuffer(const_cast<Buffer &>(*this));
2718         updateMacros();
2719
2720         Buffer & cbuf = const_cast<Buffer &>(*this);
2721
2722         LASSERT(!text().paragraphs().empty(), /**/);
2723
2724         // do the real work
2725         ParIterator parit = cbuf.par_iterator_begin();
2726         updateLabels(parit);
2727
2728         if (master != this)
2729                 // TocBackend update will be done later.
2730                 return;
2731
2732         cbuf.tocBackend().update();
2733         if (!childonly)
2734                 cbuf.structureChanged();
2735 }
2736
2737
2738 static depth_type getDepth(DocIterator const & it)
2739 {
2740         depth_type depth = 0;
2741         for (size_t i = 0 ; i < it.depth() ; ++i)
2742                 if (!it[i].inset().inMathed())
2743                         depth += it[i].paragraph().getDepth() + 1;
2744         // remove 1 since the outer inset does not count
2745         return depth - 1;
2746 }
2747
2748 static depth_type getItemDepth(ParIterator const & it)
2749 {
2750         Paragraph const & par = *it;
2751         LabelType const labeltype = par.layout().labeltype;
2752
2753         if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
2754                 return 0;
2755
2756         // this will hold the lowest depth encountered up to now.
2757         depth_type min_depth = getDepth(it);
2758         ParIterator prev_it = it;
2759         while (true) {
2760                 if (prev_it.pit())
2761                         --prev_it.top().pit();
2762                 else {
2763                         // start of nested inset: go to outer par
2764                         prev_it.pop_back();
2765                         if (prev_it.empty()) {
2766                                 // start of document: nothing to do
2767                                 return 0;
2768                         }
2769                 }
2770
2771                 // We search for the first paragraph with same label
2772                 // that is not more deeply nested.
2773                 Paragraph & prev_par = *prev_it;
2774                 depth_type const prev_depth = getDepth(prev_it);
2775                 if (labeltype == prev_par.layout().labeltype) {
2776                         if (prev_depth < min_depth)
2777                                 return prev_par.itemdepth + 1;
2778                         if (prev_depth == min_depth)
2779                                 return prev_par.itemdepth;
2780                 }
2781                 min_depth = min(min_depth, prev_depth);
2782                 // small optimization: if we are at depth 0, we won't
2783                 // find anything else
2784                 if (prev_depth == 0)
2785                         return 0;
2786         }
2787 }
2788
2789
2790 static bool needEnumCounterReset(ParIterator const & it)
2791 {
2792         Paragraph const & par = *it;
2793         LASSERT(par.layout().labeltype == LABEL_ENUMERATE, /**/);
2794         depth_type const cur_depth = par.getDepth();
2795         ParIterator prev_it = it;
2796         while (prev_it.pit()) {
2797                 --prev_it.top().pit();
2798                 Paragraph const & prev_par = *prev_it;
2799                 if (prev_par.getDepth() <= cur_depth)
2800                         return  prev_par.layout().labeltype != LABEL_ENUMERATE;
2801         }
2802         // start of nested inset: reset
2803         return true;
2804 }
2805
2806
2807 // set the label of a paragraph. This includes the counters.
2808 static void setLabel(Buffer const & buf, ParIterator & it)
2809 {
2810         BufferParams const & bp = buf.masterBuffer()->params();
2811         DocumentClass const & textclass = bp.documentClass();
2812         Paragraph & par = it.paragraph();
2813         Layout const & layout = par.layout();
2814         Counters & counters = textclass.counters();
2815
2816         if (par.params().startOfAppendix()) {
2817                 // FIXME: only the counter corresponding to toplevel
2818                 // sectionning should be reset
2819                 counters.reset();
2820                 counters.appendix(true);
2821         }
2822         par.params().appendix(counters.appendix());
2823
2824         // Compute the item depth of the paragraph
2825         par.itemdepth = getItemDepth(it);
2826
2827         if (layout.margintype == MARGIN_MANUAL) {
2828                 if (par.params().labelWidthString().empty())
2829                         par.params().labelWidthString(par.translateIfPossible(layout.labelstring(), bp));
2830         } else {
2831                 par.params().labelWidthString(docstring());
2832         }
2833
2834         switch(layout.labeltype) {
2835         case LABEL_COUNTER:
2836                 if (layout.toclevel <= bp.secnumdepth
2837                     && (layout.latextype != LATEX_ENVIRONMENT
2838                         || isFirstInSequence(it.pit(), it.plist()))) {
2839                         counters.step(layout.counter);
2840                         par.params().labelString(
2841                                 par.expandLabel(layout, bp));
2842                 } else
2843                         par.params().labelString(docstring());
2844                 break;
2845
2846         case LABEL_ITEMIZE: {
2847                 // At some point of time we should do something more
2848                 // clever here, like:
2849                 //   par.params().labelString(
2850                 //    bp.user_defined_bullet(par.itemdepth).getText());
2851                 // for now, use a simple hardcoded label
2852                 docstring itemlabel;
2853                 switch (par.itemdepth) {
2854                 case 0:
2855                         itemlabel = char_type(0x2022);
2856                         break;
2857                 case 1:
2858                         itemlabel = char_type(0x2013);
2859                         break;
2860                 case 2:
2861                         itemlabel = char_type(0x2217);
2862                         break;
2863                 case 3:
2864                         itemlabel = char_type(0x2219); // or 0x00b7
2865                         break;
2866                 }
2867                 par.params().labelString(itemlabel);
2868                 break;
2869         }
2870
2871         case LABEL_ENUMERATE: {
2872                 // FIXME: Yes I know this is a really, really! bad solution
2873                 // (Lgb)
2874                 docstring enumcounter = from_ascii("enum");
2875
2876                 switch (par.itemdepth) {
2877                 case 2:
2878                         enumcounter += 'i';
2879                 case 1:
2880                         enumcounter += 'i';
2881                 case 0:
2882                         enumcounter += 'i';
2883                         break;
2884                 case 3:
2885                         enumcounter += "iv";
2886                         break;
2887                 default:
2888                         // not a valid enumdepth...
2889                         break;
2890                 }
2891
2892                 // Maybe we have to reset the enumeration counter.
2893                 if (needEnumCounterReset(it))
2894                         counters.reset(enumcounter);
2895
2896                 counters.step(enumcounter);
2897
2898                 string format;
2899
2900                 switch (par.itemdepth) {
2901                 case 0:
2902                         format = N_("\\arabic{enumi}.");
2903                         break;
2904                 case 1:
2905                         format = N_("(\\alph{enumii})");
2906                         break;
2907                 case 2:
2908                         format = N_("\\roman{enumiii}.");
2909                         break;
2910                 case 3:
2911                         format = N_("\\Alph{enumiv}.");
2912                         break;
2913                 default:
2914                         // not a valid enumdepth...
2915                         break;
2916                 }
2917
2918                 par.params().labelString(counters.counterLabel(
2919                         par.translateIfPossible(from_ascii(format), bp)));
2920
2921                 break;
2922         }
2923
2924         case LABEL_SENSITIVE: {
2925                 string const & type = counters.current_float();
2926                 docstring full_label;
2927                 if (type.empty())
2928                         full_label = buf.B_("Senseless!!! ");
2929                 else {
2930                         docstring name = buf.B_(textclass.floats().getType(type).name());
2931                         if (counters.hasCounter(from_utf8(type))) {
2932                                 counters.step(from_utf8(type));
2933                                 full_label = bformat(from_ascii("%1$s %2$s:"),
2934                                                      name,
2935                                                      counters.theCounter(from_utf8(type)));
2936                         } else
2937                                 full_label = bformat(from_ascii("%1$s #:"), name);
2938                 }
2939                 par.params().labelString(full_label);
2940                 break;
2941         }
2942
2943         case LABEL_NO_LABEL:
2944                 par.params().labelString(docstring());
2945                 break;
2946
2947         case LABEL_MANUAL:
2948         case LABEL_TOP_ENVIRONMENT:
2949         case LABEL_CENTERED_TOP_ENVIRONMENT:
2950         case LABEL_STATIC:
2951         case LABEL_BIBLIO:
2952                 par.params().labelString(
2953                         par.translateIfPossible(layout.labelstring(), bp));
2954                 break;
2955         }
2956 }
2957
2958
2959 void Buffer::updateLabels(ParIterator & parit) const
2960 {
2961         LASSERT(parit.pit() == 0, /**/);
2962
2963         // set the position of the text in the buffer to be able
2964         // to resolve macros in it. This has nothing to do with
2965         // labels, but by putting it here we avoid implementing
2966         // a whole bunch of traversal routines just for this call.
2967         parit.text()->setMacrocontextPosition(parit);
2968
2969         depth_type maxdepth = 0;
2970         pit_type const lastpit = parit.lastpit();
2971         for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
2972                 // reduce depth if necessary
2973                 parit->params().depth(min(parit->params().depth(), maxdepth));
2974                 maxdepth = parit->getMaxDepthAfter();
2975
2976                 // set the counter for this paragraph
2977                 setLabel(*this, parit);
2978
2979                 // Now the insets
2980                 InsetList::const_iterator iit = parit->insetList().begin();
2981                 InsetList::const_iterator end = parit->insetList().end();
2982                 for (; iit != end; ++iit) {
2983                         parit.pos() = iit->pos;
2984                         iit->inset->updateLabels(parit);
2985                 }
2986         }
2987 }
2988
2989 } // namespace lyx