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