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 "DispatchResult.h"
  28 #include "DocIterator.h"
  29 #include "Encoding.h"
  30 #include "ErrorList.h"
  31 #include "Exporter.h"
  32 #include "Format.h"
  33 #include "FuncRequest.h"
  34 #include "FuncStatus.h"
  35 #include "IndicesList.h"
  36 #include "InsetIterator.h"
  37 #include "InsetList.h"
  38 #include "Language.h"
  39 #include "LaTeXFeatures.h"
  40 #include "LaTeX.h"
  41 #include "Layout.h"
  42 #include "Lexer.h"
  43 #include "LyXAction.h"
  44 #include "LyX.h"
  45 #include "LyXFunc.h"
  46 #include "LyXRC.h"
  47 #include "LyXVC.h"
  48 #include "output_docbook.h"
  49 #include "output.h"
  50 #include "output_latex.h"
  51 #include "output_xhtml.h"
  52 #include "output_plaintext.h"
  53 #include "Paragraph.h"
  54 #include "ParagraphParameters.h"
  55 #include "ParIterator.h"
  56 #include "PDFOptions.h"
  57 #include "SpellChecker.h"
  58 #include "sgml.h"
  59 #include "TexRow.h"
  60 #include "TexStream.h"
  61 #include "Text.h"
  62 #include "TextClass.h"
  63 #include "TocBackend.h"
  64 #include "Undo.h"
  65 #include "VCBackend.h"
  66 #include "version.h"
  67 #include "WordLangTuple.h"
  68 #include "WordList.h"
  69
  70 #include "insets/InsetBibitem.h"
  71 #include "insets/InsetBibtex.h"
  72 #include "insets/InsetBranch.h"
  73 #include "insets/InsetInclude.h"
  74 #include "insets/InsetText.h"
  75
  76 #include "mathed/MacroTable.h"
  77 #include "mathed/MathMacroTemplate.h"
  78 #include "mathed/MathSupport.h"
  79
  80 #include "frontends/alert.h"
  81 #include "frontends/Delegates.h"
  82 #include "frontends/WorkAreaManager.h"
  83
  84 #include "graphics/Previews.h"
  85
  86 #include "support/lassert.h"
  87 #include "support/convert.h"
  88 #include "support/debug.h"
  89 #include "support/docstring_list.h"
  90 #include "support/ExceptionMessage.h"
  91 #include "support/FileName.h"
  92 #include "support/FileNameList.h"
  93 #include "support/filetools.h"
  94 #include "support/ForkedCalls.h"
  95 #include "support/gettext.h"
  96 #include "support/gzstream.h"
  97 #include "support/lstrings.h"
  98 #include "support/lyxalgo.h"
  99 #include "support/os.h"
 100 #include "support/Package.h"
 101 #include "support/Path.h"
 102 #include "support/Systemcall.h"
 103 #include "support/textutils.h"
 104 #include "support/types.h"
 105
 106 #include <boost/bind.hpp>
 107 #include <boost/shared_ptr.hpp>
 108
 109 #include <algorithm>
 110 #include <fstream>
 111 #include <iomanip>
 112 #include <map>
 113 #include <set>
 114 #include <sstream>
 115 #include <stack>
 116 #include <vector>
 117
 118 using namespace std;
 119 using namespace lyx::support;
 120
 121 namespace lyx {
 122
 123 namespace Alert = frontend::Alert;
 124 namespace os = support::os;
 125
 126 namespace {
 127
 128 // Do not remove the comment below, so we get merge conflict in
 129 // independent branches. Instead add your own.
 130 int const LYX_FORMAT = 371; // uwestoehr: option to turn off mhchem
 131
 132 typedef map<string, bool> DepClean;
 133 typedef map<docstring, pair<InsetLabel const *, Buffer::References> > RefCache;
 134
 135 void showPrintError(string const & name)
 136 {
 137         docstring str = bformat(_("Could not print the document %1$s.\n"
 138                                             "Check that your printer is set up correctly."),
 139                              makeDisplayPath(name, 50));
 140         Alert::error(_("Print document failed"), str);
 141 }
 142
 143 } // namespace anon
 144
 145 class BufferSet : public std::set<Buffer const *> {};
 146
 147 class Buffer::Impl
 148 {
 149 public:
 150         Impl(Buffer & parent, FileName const & file, bool readonly);
 151
 152         ~Impl()
 153         {
 154                 if (wa_) {
 155                         wa_->closeAll();
 156                         delete wa_;
 157                 }
 158                 delete inset;
 159         }
 160
 161         BufferParams params;
 162         LyXVC lyxvc;
 163         FileName temppath;
 164         mutable TexRow texrow;
 165
 166         /// need to regenerate .tex?
 167         DepClean dep_clean;
 168
 169         /// is save needed?
 170         mutable bool lyx_clean;
 171
 172         /// is autosave needed?
 173         mutable bool bak_clean;
 174
 175         /// is this a unnamed file (New...)?
 176         bool unnamed;
 177
 178         /// buffer is r/o
 179         bool read_only;
 180
 181         /// name of the file the buffer is associated with.
 182         FileName filename;
 183
 184         /** Set to true only when the file is fully loaded.
 185          *  Used to prevent the premature generation of previews
 186          *  and by the citation inset.
 187          */
 188         bool file_fully_loaded;
 189
 190         ///
 191         mutable TocBackend toc_backend;
 192
 193         /// macro tables
 194         typedef pair<DocIterator, MacroData> ScopeMacro;
 195         typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
 196         typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
 197         /// map from the macro name to the position map,
 198         /// which maps the macro definition position to the scope and the MacroData.
 199         NamePositionScopeMacroMap macros;
 200         bool macro_lock;
 201
 202         /// positions of child buffers in the buffer
 203         typedef map<Buffer const * const, DocIterator> BufferPositionMap;
 204         typedef pair<DocIterator, Buffer const *> ScopeBuffer;
 205         typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
 206         /// position of children buffers in this buffer
 207         BufferPositionMap children_positions;
 208         /// map from children inclusion positions to their scope and their buffer
 209         PositionScopeBufferMap position_to_children;
 210
 211         /// Container for all sort of Buffer dependant errors.
 212         map<string, ErrorList> errorLists;
 213
 214         /// timestamp and checksum used to test if the file has been externally
 215         /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
 216         time_t timestamp_;
 217         unsigned long checksum_;
 218
 219         ///
 220         frontend::WorkAreaManager * wa_;
 221
 222         ///
 223         Undo undo_;
 224
 225         /// A cache for the bibfiles (including bibfiles of loaded child
 226         /// documents), needed for appropriate update of natbib labels.
 227         mutable support::FileNameList bibfilesCache_;
 228
 229         // FIXME The caching mechanism could be improved. At present, we have a
 230         // cache for each Buffer, that caches all the bibliography info for that
 231         // Buffer. A more efficient solution would be to have a global cache per
 232         // file, and then to construct the Buffer's bibinfo from that.
 233         /// A cache for bibliography info
 234         mutable BiblioInfo bibinfo_;
 235         /// whether the bibinfo cache is valid
 236         bool bibinfoCacheValid_;
 237         /// Cache of timestamps of .bib files
 238         map<FileName, time_t> bibfileStatus_;
 239
 240         mutable RefCache ref_cache_;
 241
 242         /// our Text that should be wrapped in an InsetText
 243         InsetText * inset;
 244
 245         /// This is here to force the test to be done whenever parent_buffer
 246         /// is accessed.
 247         Buffer const * parent() const {
 248                 // if parent_buffer is not loaded, then it has been unloaded,
 249                 // which means that parent_buffer is an invalid pointer. So we
 250                 // set it to null in that case.
 251                 if (!theBufferList().isLoaded(parent_buffer))
 252                         parent_buffer = 0;
 253                 return parent_buffer;
 254         }
 255         ///
 256         void setParent(Buffer const * pb) {
 257                 if (parent_buffer && pb && parent_buffer != pb)
 258                         LYXERR0("Warning: a buffer should not have two parents!");
 259                 parent_buffer = pb;
 260         }
 261 private:
 262         /// So we can force access via the accessors.
 263         mutable Buffer const * parent_buffer;
 264 };
 265
 266
 267 /// Creates the per buffer temporary directory
 268 static FileName createBufferTmpDir()
 269 {
 270         static int count;
 271         // We are in our own directory.  Why bother to mangle name?
 272         // In fact I wrote this code to circumvent a problematic behaviour
 273         // (bug?) of EMX mkstemp().
 274         FileName tmpfl(package().temp_dir().absFilename() + "/lyx_tmpbuf" +
 275                 convert<string>(count++));
 276
 277         if (!tmpfl.createDirectory(0777)) {
 278                 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
 279                         _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
 280                         from_utf8(tmpfl.absFilename())));
 281         }
 282         return tmpfl;
 283 }
 284
 285
 286 Buffer::Impl::Impl(Buffer & parent, FileName const & file, bool readonly_)
 287         : lyx_clean(true), bak_clean(true), unnamed(false),
 288           read_only(readonly_), filename(file), file_fully_loaded(false),
 289           toc_backend(&parent), macro_lock(false), timestamp_(0),
 290           checksum_(0), wa_(0), undo_(parent), bibinfoCacheValid_(false),
 291           parent_buffer(0)
 292 {
 293         temppath = createBufferTmpDir();
 294         lyxvc.setBuffer(&parent);
 295         if (use_gui)
 296                 wa_ = new frontend::WorkAreaManager;
 297 }
 298
 299
 300 Buffer::Buffer(string const & file, bool readonly)
 301         : d(new Impl(*this, FileName(file), readonly)), gui_(0)
 302 {
 303         LYXERR(Debug::INFO, "Buffer::Buffer()");
 304
 305         d->inset = new InsetText(this);
 306         d->inset->setAutoBreakRows(true);
 307         d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
 308 }
 309
 310
 311 Buffer::~Buffer()
 312 {
 313         LYXERR(Debug::INFO, "Buffer::~Buffer()");
 314         // here the buffer should take care that it is
 315         // saved properly, before it goes into the void.
 316
 317         // GuiView already destroyed
 318         gui_ = 0;
 319
 320         if (isInternal()) {
 321                 // No need to do additional cleanups for internal buffer.
 322                 delete d;
 323                 return;
 324         }
 325
 326         // loop over children
 327         Impl::BufferPositionMap::iterator it = d->children_positions.begin();
 328         Impl::BufferPositionMap::iterator end = d->children_positions.end();
 329         for (; it != end; ++it) {
 330                 Buffer * child = const_cast<Buffer *>(it->first);
 331                 // The child buffer might have been closed already.
 332                 if (theBufferList().isLoaded(child))
 333                         theBufferList().releaseChild(this, child);
 334         }
 335
 336         if (!isClean()) {
 337                 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
 338                 msg += emergencyWrite();
 339                 frontend::Alert::warning(_("Attempting to close changed document!"), msg);
 340         }
 341
 342         // clear references to children in macro tables
 343         d->children_positions.clear();
 344         d->position_to_children.clear();
 345
 346         if (!d->temppath.destroyDirectory()) {
 347                 Alert::warning(_("Could not remove temporary directory"),
 348                         bformat(_("Could not remove the temporary directory %1$s"),
 349                         from_utf8(d->temppath.absFilename())));
 350         }
 351
 352         // Remove any previewed LaTeX snippets associated with this buffer.
 353         thePreviews().removeLoader(*this);
 354
 355         delete d;
 356 }
 357
 358
 359 void Buffer::changed() const
 360 {
 361         if (d->wa_)
 362                 d->wa_->redrawAll();
 363 }
 364
 365
 366 frontend::WorkAreaManager & Buffer::workAreaManager() const
 367 {
 368         LASSERT(d->wa_, /**/);
 369         return *d->wa_;
 370 }
 371
 372
 373 Text & Buffer::text() const
 374 {
 375         return d->inset->text();
 376 }
 377
 378
 379 Inset & Buffer::inset() const
 380 {
 381         return *d->inset;
 382 }
 383
 384
 385 BufferParams & Buffer::params()
 386 {
 387         return d->params;
 388 }
 389
 390
 391 BufferParams const & Buffer::params() const
 392 {
 393         return d->params;
 394 }
 395
 396
 397 ParagraphList & Buffer::paragraphs()
 398 {
 399         return text().paragraphs();
 400 }
 401
 402
 403 ParagraphList const & Buffer::paragraphs() const
 404 {
 405         return text().paragraphs();
 406 }
 407
 408
 409 LyXVC & Buffer::lyxvc()
 410 {
 411         return d->lyxvc;
 412 }
 413
 414
 415 LyXVC const & Buffer::lyxvc() const
 416 {
 417         return d->lyxvc;
 418 }
 419
 420
 421 string const Buffer::temppath() const
 422 {
 423         return d->temppath.absFilename();
 424 }
 425
 426
 427 TexRow & Buffer::texrow()
 428 {
 429         return d->texrow;
 430 }
 431
 432
 433 TexRow const & Buffer::texrow() const
 434 {
 435         return d->texrow;
 436 }
 437
 438
 439 TocBackend & Buffer::tocBackend() const
 440 {
 441         return d->toc_backend;
 442 }
 443
 444
 445 Undo & Buffer::undo()
 446 {
 447         return d->undo_;
 448 }
 449
 450
 451 string Buffer::latexName(bool const no_path) const
 452 {
 453         FileName latex_name =
 454                 makeLatexName(exportFileName());
 455         return no_path ? latex_name.onlyFileName()
 456                 : latex_name.absFilename();
 457 }
 458
 459
 460 FileName Buffer::exportFileName() const
 461 {
 462         docstring const branch_suffix =
 463                 params().branchlist().getFilenameSuffix();
 464         if (branch_suffix.empty())
 465                 return fileName();
 466
 467         string const name = fileName().onlyFileNameWithoutExt()
 468                 + to_utf8(branch_suffix);
 469         FileName res(fileName().onlyPath().absFilename() + "/" + name);
 470         res.changeExtension(fileName().extension());
 471
 472         return res;
 473 }
 474
 475
 476 string Buffer::logName(LogType * type) const
 477 {
 478         string const filename = latexName(false);
 479
 480         if (filename.empty()) {
 481                 if (type)
 482                         *type = latexlog;
 483                 return string();
 484         }
 485
 486         string const path = temppath();
 487
 488         FileName const fname(addName(temppath(),
 489                                      onlyFilename(changeExtension(filename,
 490                                                                   ".log"))));
 491
 492         // FIXME: how do we know this is the name of the build log?
 493         FileName const bname(
 494                 addName(path, onlyFilename(
 495                         changeExtension(filename,
 496                                         formats.extension(bufferFormat()) + ".out"))));
 497
 498         // Also consider the master buffer log file
 499         FileName masterfname = fname;
 500         LogType mtype;
 501         if (masterBuffer() != this) {
 502                 string const mlogfile = masterBuffer()->logName(&mtype);
 503                 masterfname = FileName(mlogfile);
 504         }
 505
 506         // If no Latex log or Build log is newer, show Build log
 507         if (bname.exists() &&
 508             ((!fname.exists() && !masterfname.exists())
 509              || (fname.lastModified() < bname.lastModified()
 510                  && masterfname.lastModified() < bname.lastModified()))) {
 511                 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
 512                 if (type)
 513                         *type = buildlog;
 514                 return bname.absFilename();
 515         // If we have a newer master file log or only a master log, show this
 516         } else if (fname != masterfname
 517                    && (!fname.exists() && (masterfname.exists()
 518                    || fname.lastModified() < masterfname.lastModified()))) {
 519                 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
 520                 if (type)
 521                         *type = mtype;
 522                 return masterfname.absFilename();
 523         }
 524         LYXERR(Debug::FILES, "Log name calculated as: " << fname);
 525         if (type)
 526                         *type = latexlog;
 527         return fname.absFilename();
 528 }
 529
 530
 531 void Buffer::setReadonly(bool const flag)
 532 {
 533         if (d->read_only != flag) {
 534                 d->read_only = flag;
 535                 setReadOnly(flag);
 536         }
 537 }
 538
 539
 540 void Buffer::setFileName(string const & newfile)
 541 {
 542         d->filename = makeAbsPath(newfile);
 543         setReadonly(d->filename.isReadOnly());
 544         updateTitles();
 545 }
 546
 547
 548 int Buffer::readHeader(Lexer & lex)
 549 {
 550         int unknown_tokens = 0;
 551         int line = -1;
 552         int begin_header_line = -1;
 553
 554         // Initialize parameters that may be/go lacking in header:
 555         params().branchlist().clear();
 556         params().preamble.erase();
 557         params().options.erase();
 558         params().master.erase();
 559         params().float_placement.erase();
 560         params().paperwidth.erase();
 561         params().paperheight.erase();
 562         params().leftmargin.erase();
 563         params().rightmargin.erase();
 564         params().topmargin.erase();
 565         params().bottommargin.erase();
 566         params().headheight.erase();
 567         params().headsep.erase();
 568         params().footskip.erase();
 569         params().columnsep.erase();
 570         params().fontsCJK.erase();
 571         params().listings_params.clear();
 572         params().clearLayoutModules();
 573         params().clearRemovedModules();
 574         params().pdfoptions().clear();
 575         params().indiceslist().clear();
 576         params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
 577
 578         for (int i = 0; i < 4; ++i) {
 579                 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
 580                 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
 581         }
 582
 583         ErrorList & errorList = d->errorLists["Parse"];
 584
 585         while (lex.isOK()) {
 586                 string token;
 587                 lex >> token;
 588
 589                 if (token.empty())
 590                         continue;
 591
 592                 if (token == "\\end_header")
 593                         break;
 594
 595                 ++line;
 596                 if (token == "\\begin_header") {
 597                         begin_header_line = line;
 598                         continue;
 599                 }
 600
 601                 LYXERR(Debug::PARSER, "Handling document header token: `"
 602                                       << token << '\'');
 603
 604                 string unknown = params().readToken(lex, token, d->filename.onlyPath());
 605                 if (!unknown.empty()) {
 606                         if (unknown[0] != '\\' && token == "\\textclass") {
 607                                 Alert::warning(_("Unknown document class"),
 608                        bformat(_("Using the default document class, because the "
 609                                               "class %1$s is unknown."), from_utf8(unknown)));
 610                         } else {
 611                                 ++unknown_tokens;
 612                                 docstring const s = bformat(_("Unknown token: "
 613                                                                         "%1$s %2$s\n"),
 614                                                          from_utf8(token),
 615                                                          lex.getDocString());
 616                                 errorList.push_back(ErrorItem(_("Document header error"),
 617                                         s, -1, 0, 0));
 618                         }
 619                 }
 620         }
 621         if (begin_header_line) {
 622                 docstring const s = _("\\begin_header is missing");
 623                 errorList.push_back(ErrorItem(_("Document header error"),
 624                         s, -1, 0, 0));
 625         }
 626
 627         params().makeDocumentClass();
 628
 629         return unknown_tokens;
 630 }
 631
 632
 633 // Uwe C. Schroeder
 634 // changed to be public and have one parameter
 635 // Returns true if "\end_document" is not read (Asger)
 636 bool Buffer::readDocument(Lexer & lex)
 637 {
 638         ErrorList & errorList = d->errorLists["Parse"];
 639         errorList.clear();
 640
 641         if (!lex.checkFor("\\begin_document")) {
 642                 docstring const s = _("\\begin_document is missing");
 643                 errorList.push_back(ErrorItem(_("Document header error"),
 644                         s, -1, 0, 0));
 645         }
 646
 647         // we are reading in a brand new document
 648         LASSERT(paragraphs().empty(), /**/);
 649
 650         readHeader(lex);
 651
 652         if (params().outputChanges) {
 653                 bool dvipost    = LaTeXFeatures::isAvailable("dvipost");
 654                 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
 655                                   LaTeXFeatures::isAvailable("xcolor");
 656
 657                 if (!dvipost && !xcolorulem) {
 658                         Alert::warning(_("Changes not shown in LaTeX output"),
 659                                        _("Changes will not be highlighted in LaTeX output, "
 660                                          "because neither dvipost nor xcolor/ulem are installed.\n"
 661                                          "Please install these packages or redefine "
 662                                          "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
 663                 } else if (!xcolorulem) {
 664                         Alert::warning(_("Changes not shown in LaTeX output"),
 665                                        _("Changes will not be highlighted in LaTeX output "
 666                                          "when using pdflatex, because xcolor and ulem are not installed.\n"
 667                                          "Please install both packages or redefine "
 668                                          "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
 669                 }
 670         }
 671
 672         if (!params().master.empty()) {
 673                 FileName const master_file = makeAbsPath(params().master,
 674                            onlyPath(absFileName()));
 675                 if (isLyXFilename(master_file.absFilename())) {
 676                         Buffer * master =
 677                                 checkAndLoadLyXFile(master_file, true);
 678                         if (master) {
 679                                 // necessary e.g. after a reload
 680                                 // to re-register the child (bug 5873)
 681                                 // FIXME: clean up updateMacros (here, only
 682                                 // child registering is needed).
 683                                 master->updateMacros();
 684                                 // set master as master buffer, but only
 685                                 // if we are a real child
 686                                 if (master->isChild(this))
 687                                         setParent(master);
 688                                 // if the master is not fully loaded
 689                                 // it is probably just loading this
 690                                 // child. No warning needed then.
 691                                 else if (master->isFullyLoaded())
 692                                         LYXERR0("The master '"
 693                                                 << params().master
 694                                                 << "' assigned to this document ("
 695                                                 << absFileName()
 696                                                 << ") does not include "
 697                                                 "this document. Ignoring the master assignment.");
 698                         }
 699                 }
 700         }
 701
 702         // assure we have a default index
 703         params().indiceslist().addDefault(B_("Index"));
 704
 705         // read main text
 706         bool const res = text().read(lex, errorList, d->inset);
 707
 708         usermacros.clear();
 709         updateMacros();
 710         updateMacroInstances();
 711         return res;
 712 }
 713
 714
 715 bool Buffer::readString(string const & s)
 716 {
 717         params().compressed = false;
 718
 719         // remove dummy empty par
 720         paragraphs().clear();
 721         Lexer lex;
 722         istringstream is(s);
 723         lex.setStream(is);
 724         FileName const name = FileName::tempName("Buffer_readString");
 725         switch (readFile(lex, name, true)) {
 726         case failure:
 727                 return false;
 728         case wrongversion: {
 729                 // We need to call lyx2lyx, so write the input to a file
 730                 ofstream os(name.toFilesystemEncoding().c_str());
 731                 os << s;
 732                 os.close();
 733                 return readFile(name);
 734         }
 735         case success:
 736                 break;
 737         }
 738
 739         return true;
 740 }
 741
 742
 743 bool Buffer::readFile(FileName const & filename)
 744 {
 745         FileName fname(filename);
 746
 747         params().compressed = fname.isZippedFile();
 748
 749         // remove dummy empty par
 750         paragraphs().clear();
 751         Lexer lex;
 752         lex.setFile(fname);
 753         if (readFile(lex, fname) != success)
 754                 return false;
 755
 756         return true;
 757 }
 758
 759
 760 bool Buffer::isFullyLoaded() const
 761 {
 762         return d->file_fully_loaded;
 763 }
 764
 765
 766 void Buffer::setFullyLoaded(bool value)
 767 {
 768         d->file_fully_loaded = value;
 769 }
 770
 771
 772 Buffer::ReadStatus Buffer::readFile(Lexer & lex, FileName const & filename,
 773                 bool fromstring)
 774 {
 775         LASSERT(!filename.empty(), /**/);
 776
 777         // the first (non-comment) token _must_ be...
 778         if (!lex.checkFor("\\lyxformat")) {
 779                 Alert::error(_("Document format failure"),
 780                              bformat(_("%1$s is not a readable LyX document."),
 781                                        from_utf8(filename.absFilename())));
 782                 return failure;
 783         }
 784
 785         string tmp_format;
 786         lex >> tmp_format;
 787         //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
 788         // if present remove ".," from string.
 789         size_t dot = tmp_format.find_first_of(".,");
 790         //lyxerr << "           dot found at " << dot << endl;
 791         if (dot != string::npos)
 792                         tmp_format.erase(dot, 1);
 793         int const file_format = convert<int>(tmp_format);
 794         //lyxerr << "format: " << file_format << endl;
 795
 796         // save timestamp and checksum of the original disk file, making sure
 797         // to not overwrite them with those of the file created in the tempdir
 798         // when it has to be converted to the current format.
 799         if (!d->checksum_) {
 800                 // Save the timestamp and checksum of disk file. If filename is an
 801                 // emergency file, save the timestamp and checksum of the original lyx file
 802                 // because isExternallyModified will check for this file. (BUG4193)
 803                 string diskfile = filename.absFilename();
 804                 if (suffixIs(diskfile, ".emergency"))
 805                         diskfile = diskfile.substr(0, diskfile.size() - 10);
 806                 saveCheckSum(FileName(diskfile));
 807         }
 808
 809         if (file_format != LYX_FORMAT) {
 810
 811                 if (fromstring)
 812                         // lyx2lyx would fail
 813                         return wrongversion;
 814
 815                 FileName const tmpfile = FileName::tempName("Buffer_readFile");
 816                 if (tmpfile.empty()) {
 817                         Alert::error(_("Conversion failed"),
 818                                      bformat(_("%1$s is from a different"
 819                                               " version of LyX, but a temporary"
 820                                               " file for converting it could"
 821                                               " not be created."),
 822                                               from_utf8(filename.absFilename())));
 823                         return failure;
 824                 }
 825                 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
 826                 if (lyx2lyx.empty()) {
 827                         Alert::error(_("Conversion script not found"),
 828                                      bformat(_("%1$s is from a different"
 829                                                " version of LyX, but the"
 830                                                " conversion script lyx2lyx"
 831                                                " could not be found."),
 832                                                from_utf8(filename.absFilename())));
 833                         return failure;
 834                 }
 835                 ostringstream command;
 836                 command << os::python()
 837                         << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
 838                         << " -t " << convert<string>(LYX_FORMAT)
 839                         << " -o " << quoteName(tmpfile.toFilesystemEncoding())
 840                         << ' ' << quoteName(filename.toFilesystemEncoding());
 841                 string const command_str = command.str();
 842
 843                 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
 844
 845                 cmd_ret const ret = runCommand(command_str);
 846                 if (ret.first != 0) {
 847                         Alert::error(_("Conversion script failed"),
 848                                      bformat(_("%1$s is from a different version"
 849                                               " of LyX, but the lyx2lyx script"
 850                                               " failed to convert it."),
 851                                               from_utf8(filename.absFilename())));
 852                         return failure;
 853                 } else {
 854                         bool const ret = readFile(tmpfile);
 855                         // Do stuff with tmpfile name and buffer name here.
 856                         return ret ? success : failure;
 857                 }
 858
 859         }
 860
 861         if (readDocument(lex)) {
 862                 Alert::error(_("Document format failure"),
 863                              bformat(_("%1$s ended unexpectedly, which means"
 864                                                     " that it is probably corrupted."),
 865                                        from_utf8(filename.absFilename())));
 866         }
 867
 868         d->file_fully_loaded = true;
 869         return success;
 870 }
 871
 872
 873 // Should probably be moved to somewhere else: BufferView? LyXView?
 874 bool Buffer::save() const
 875 {
 876         // We don't need autosaves in the immediate future. (Asger)
 877         resetAutosaveTimers();
 878
 879         string const encodedFilename = d->filename.toFilesystemEncoding();
 880
 881         FileName backupName;
 882         bool madeBackup = false;
 883
 884         // make a backup if the file already exists
 885         if (lyxrc.make_backup && fileName().exists()) {
 886                 backupName = FileName(absFileName() + '~');
 887                 if (!lyxrc.backupdir_path.empty()) {
 888                         string const mangledName =
 889                                 subst(subst(backupName.absFilename(), '/', '!'), ':', '!');
 890                         backupName = FileName(addName(lyxrc.backupdir_path,
 891                                                       mangledName));
 892                 }
 893                 if (fileName().copyTo(backupName)) {
 894                         madeBackup = true;
 895                 } else {
 896                         Alert::error(_("Backup failure"),
 897                                      bformat(_("Cannot create backup file %1$s.\n"
 898                                                "Please check whether the directory exists and is writeable."),
 899                                              from_utf8(backupName.absFilename())));
 900                         //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
 901                 }
 902         }
 903
 904         // ask if the disk file has been externally modified (use checksum method)
 905         if (fileName().exists() && isExternallyModified(checksum_method)) {
 906                 docstring const file = makeDisplayPath(absFileName(), 20);
 907                 docstring text = bformat(_("Document %1$s has been externally modified. Are you sure "
 908                                                              "you want to overwrite this file?"), file);
 909                 int const ret = Alert::prompt(_("Overwrite modified file?"),
 910                         text, 1, 1, _("&Overwrite"), _("&Cancel"));
 911                 if (ret == 1)
 912                         return false;
 913         }
 914
 915         if (writeFile(d->filename)) {
 916                 markClean();
 917                 return true;
 918         } else {
 919                 // Saving failed, so backup is not backup
 920                 if (madeBackup)
 921                         backupName.moveTo(d->filename);
 922                 return false;
 923         }
 924 }
 925
 926
 927 bool Buffer::writeFile(FileName const & fname) const
 928 {
 929         if (d->read_only && fname == d->filename)
 930                 return false;
 931
 932         bool retval = false;
 933
 934         docstring const str = bformat(_("Saving document %1$s..."),
 935                 makeDisplayPath(fname.absFilename()));
 936         message(str);
 937
 938         if (params().compressed) {
 939                 gz::ogzstream ofs(fname.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
 940                 retval = ofs && write(ofs);
 941         } else {
 942                 ofstream ofs(fname.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
 943                 retval = ofs && write(ofs);
 944         }
 945
 946         if (!retval) {
 947                 message(str + _(" could not write file!"));
 948                 return false;
 949         }
 950
 951         removeAutosaveFile();
 952
 953         saveCheckSum(d->filename);
 954         message(str + _(" done."));
 955
 956         return true;
 957 }
 958
 959
 960 docstring Buffer::emergencyWrite()
 961 {
 962         // No need to save if the buffer has not changed.
 963         if (isClean())
 964                 return docstring();
 965
 966         string const doc = isUnnamed() ? onlyFilename(absFileName()) : absFileName();
 967
 968         docstring user_message = bformat(
 969                 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
 970
 971         // We try to save three places:
 972         // 1) Same place as document. Unless it is an unnamed doc.
 973         if (!isUnnamed()) {
 974                 string s = absFileName();
 975                 s += ".emergency";
 976                 LYXERR0("  " << s);
 977                 if (writeFile(FileName(s))) {
 978                         markClean();
 979                         user_message += bformat(_("  Saved to %1$s. Phew.\n"), from_utf8(s));
 980                         return user_message;
 981                 } else {
 982                         user_message += _("  Save failed! Trying again...\n");
 983                 }
 984         }
 985
 986         // 2) In HOME directory.
 987         string s = addName(package().home_dir().absFilename(), absFileName());
 988         s += ".emergency";
 989         lyxerr << ' ' << s << endl;
 990         if (writeFile(FileName(s))) {
 991                 markClean();
 992                 user_message += bformat(_("  Saved to %1$s. Phew.\n"), from_utf8(s));
 993                 return user_message;
 994         }
 995
 996         user_message += _("  Save failed! Trying yet again...\n");
 997
 998         // 3) In "/tmp" directory.
 999         // MakeAbsPath to prepend the current
1000         // drive letter on OS/2
1001         s = addName(package().temp_dir().absFilename(), absFileName());
1002         s += ".emergency";
1003         lyxerr << ' ' << s << endl;
1004         if (writeFile(FileName(s))) {
1005                 markClean();
1006                 user_message += bformat(_("  Saved to %1$s. Phew.\n"), from_utf8(s));
1007                 return user_message;
1008         }
1009
1010         user_message += _("  Save failed! Bummer. Document is lost.");
1011         // Don't try again.
1012         markClean();
1013         return user_message;
1014 }
1015
1016
1017 bool Buffer::write(ostream & ofs) const
1018 {
1019 #ifdef HAVE_LOCALE
1020         // Use the standard "C" locale for file output.
1021         ofs.imbue(locale::classic());
1022 #endif
1023
1024         // The top of the file should not be written by params().
1025
1026         // write out a comment in the top of the file
1027         ofs << "#LyX " << lyx_version
1028             << " created this file. For more info see http://www.lyx.org/\n"
1029             << "\\lyxformat " << LYX_FORMAT << "\n"
1030             << "\\begin_document\n";
1031
1032         /// For each author, set 'used' to true if there is a change
1033         /// by this author in the document; otherwise set it to 'false'.
1034         AuthorList::Authors::const_iterator a_it = params().authors().begin();
1035         AuthorList::Authors::const_iterator a_end = params().authors().end();
1036         for (; a_it != a_end; ++a_it)
1037                 a_it->setUsed(false);
1038
1039         ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1040         ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1041         for ( ; it != end; ++it)
1042                 it->checkAuthors(params().authors());
1043
1044         // now write out the buffer parameters.
1045         ofs << "\\begin_header\n";
1046         params().writeFile(ofs);
1047         ofs << "\\end_header\n";
1048
1049         // write the text
1050         ofs << "\n\\begin_body\n";
1051         text().write(ofs);
1052         ofs << "\n\\end_body\n";
1053
1054         // Write marker that shows file is complete
1055         ofs << "\\end_document" << endl;
1056
1057         // Shouldn't really be needed....
1058         //ofs.close();
1059
1060         // how to check if close went ok?
1061         // Following is an attempt... (BE 20001011)
1062
1063         // good() returns false if any error occured, including some
1064         //        formatting error.
1065         // bad()  returns true if something bad happened in the buffer,
1066         //        which should include file system full errors.
1067
1068         bool status = true;
1069         if (!ofs) {
1070                 status = false;
1071                 lyxerr << "File was not closed properly." << endl;
1072         }
1073
1074         return status;
1075 }
1076
1077
1078 bool Buffer::makeLaTeXFile(FileName const & fname,
1079                            string const & original_path,
1080                            OutputParams const & runparams_in,
1081                            bool output_preamble, bool output_body) const
1082 {
1083         OutputParams runparams = runparams_in;
1084         if (params().useXetex)
1085                 runparams.flavor = OutputParams::XETEX;
1086
1087         string const encoding = runparams.encoding->iconvName();
1088         LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << "...");
1089
1090         ofdocstream ofs;
1091         try { ofs.reset(encoding); }
1092         catch (iconv_codecvt_facet_exception & e) {
1093                 lyxerr << "Caught iconv exception: " << e.what() << endl;
1094                 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1095                         "verify that the support software for your encoding (%1$s) is "
1096                         "properly installed"), from_ascii(encoding)));
1097                 return false;
1098         }
1099         if (!openFileWrite(ofs, fname))
1100                 return false;
1101
1102         //TexStream ts(ofs.rdbuf(), &texrow());
1103         ErrorList & errorList = d->errorLists["Export"];
1104         errorList.clear();
1105         bool failed_export = false;
1106         try {
1107                 d->texrow.reset();
1108                 writeLaTeXSource(ofs, original_path,
1109                       runparams, output_preamble, output_body);
1110         }
1111         catch (EncodingException & e) {
1112                 odocstringstream ods;
1113                 ods.put(e.failed_char);
1114                 ostringstream oss;
1115                 oss << "0x" << hex << e.failed_char << dec;
1116                 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1117                                           " (code point %2$s)"),
1118                                           ods.str(), from_utf8(oss.str()));
1119                 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1120                                 "representable in the chosen encoding.\n"
1121                                 "Changing the document encoding to utf8 could help."),
1122                                 e.par_id, e.pos, e.pos + 1));
1123                 failed_export = true;
1124         }
1125         catch (iconv_codecvt_facet_exception & e) {
1126                 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1127                         _(e.what()), -1, 0, 0));
1128                 failed_export = true;
1129         }
1130         catch (exception const & e) {
1131                 errorList.push_back(ErrorItem(_("conversion failed"),
1132                         _(e.what()), -1, 0, 0));
1133                 failed_export = true;
1134         }
1135         catch (...) {
1136                 lyxerr << "Caught some really weird exception..." << endl;
1137                 lyx_exit(1);
1138         }
1139
1140         ofs.close();
1141         if (ofs.fail()) {
1142                 failed_export = true;
1143                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1144         }
1145
1146         errors("Export");
1147         return !failed_export;
1148 }
1149
1150
1151 void Buffer::writeLaTeXSource(odocstream & os,
1152                            string const & original_path,
1153                            OutputParams const & runparams_in,
1154                            bool const output_preamble, bool const output_body) const
1155 {
1156         // The child documents, if any, shall be already loaded at this point.
1157
1158         OutputParams runparams = runparams_in;
1159
1160         // Classify the unicode characters appearing in math insets
1161         Encodings::initUnicodeMath(*this);
1162
1163         // validate the buffer.
1164         LYXERR(Debug::LATEX, "  Validating buffer...");
1165         LaTeXFeatures features(*this, params(), runparams);
1166         validate(features);
1167         LYXERR(Debug::LATEX, "  Buffer validation done.");
1168
1169         // The starting paragraph of the coming rows is the
1170         // first paragraph of the document. (Asger)
1171         if (output_preamble && runparams.nice) {
1172                 os << "%% LyX " << lyx_version << " created this file.  "
1173                         "For more info, see http://www.lyx.org/.\n"
1174                         "%% Do not edit unless you really know what "
1175                         "you are doing.\n";
1176                 d->texrow.newline();
1177                 d->texrow.newline();
1178         }
1179         LYXERR(Debug::INFO, "lyx document header finished");
1180
1181         // Don't move this behind the parent_buffer=0 code below,
1182         // because then the macros will not get the right "redefinition"
1183         // flag as they don't see the parent macros which are output before.
1184         updateMacros();
1185
1186         // fold macros if possible, still with parent buffer as the
1187         // macros will be put in the prefix anyway.
1188         updateMacroInstances();
1189
1190         // There are a few differences between nice LaTeX and usual files:
1191         // usual is \batchmode and has a
1192         // special input@path to allow the including of figures
1193         // with either \input or \includegraphics (what figinsets do).
1194         // input@path is set when the actual parameter
1195         // original_path is set. This is done for usual tex-file, but not
1196         // for nice-latex-file. (Matthias 250696)
1197         // Note that input@path is only needed for something the user does
1198         // in the preamble, included .tex files or ERT, files included by
1199         // LyX work without it.
1200         if (output_preamble) {
1201                 if (!runparams.nice) {
1202                         // code for usual, NOT nice-latex-file
1203                         os << "\\batchmode\n"; // changed
1204                         // from \nonstopmode
1205                         d->texrow.newline();
1206                 }
1207                 if (!original_path.empty()) {
1208                         // FIXME UNICODE
1209                         // We don't know the encoding of inputpath
1210                         docstring const inputpath = from_utf8(latex_path(original_path));
1211                         os << "\\makeatletter\n"
1212                            << "\\def\\input@path{{"
1213                            << inputpath << "/}}\n"
1214                            << "\\makeatother\n";
1215                         d->texrow.newline();
1216                         d->texrow.newline();
1217                         d->texrow.newline();
1218                 }
1219
1220                 // get parent macros (if this buffer has a parent) which will be
1221                 // written at the document begin further down.
1222                 MacroSet parentMacros;
1223                 listParentMacros(parentMacros, features);
1224
1225                 // Write the preamble
1226                 runparams.use_babel = params().writeLaTeX(os, features, d->texrow);
1227
1228                 runparams.use_japanese = features.isRequired("japanese");
1229
1230                 if (!output_body)
1231                         return;
1232
1233                 // make the body.
1234                 os << "\\begin{document}\n";
1235                 d->texrow.newline();
1236
1237                 // output the parent macros
1238                 MacroSet::iterator it = parentMacros.begin();
1239                 MacroSet::iterator end = parentMacros.end();
1240                 for (; it != end; ++it)
1241                         (*it)->write(os, true);
1242         } // output_preamble
1243
1244         d->texrow.start(paragraphs().begin()->id(), 0);
1245
1246         LYXERR(Debug::INFO, "preamble finished, now the body.");
1247
1248         // if we are doing a real file with body, even if this is the
1249         // child of some other buffer, let's cut the link here.
1250         // This happens for example if only a child document is printed.
1251         Buffer const * save_parent = 0;
1252         if (output_preamble) {
1253                 save_parent = d->parent();
1254                 d->setParent(0);
1255         }
1256
1257         // the real stuff
1258         latexParagraphs(*this, text(), os, d->texrow, runparams);
1259
1260         // Restore the parenthood if needed
1261         if (output_preamble)
1262                 d->setParent(save_parent);
1263
1264         // add this just in case after all the paragraphs
1265         os << endl;
1266         d->texrow.newline();
1267
1268         if (output_preamble) {
1269                 os << "\\end{document}\n";
1270                 d->texrow.newline();
1271                 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1272         } else {
1273                 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1274         }
1275         runparams_in.encoding = runparams.encoding;
1276
1277         // Just to be sure. (Asger)
1278         d->texrow.newline();
1279
1280         LYXERR(Debug::INFO, "Finished making LaTeX file.");
1281         LYXERR(Debug::INFO, "Row count was " << d->texrow.rows() - 1 << '.');
1282 }
1283
1284
1285 bool Buffer::isLatex() const
1286 {
1287         return params().documentClass().outputType() == LATEX;
1288 }
1289
1290
1291 bool Buffer::isLiterate() const
1292 {
1293         return params().documentClass().outputType() == LITERATE;
1294 }
1295
1296
1297 bool Buffer::isDocBook() const
1298 {
1299         return params().documentClass().outputType() == DOCBOOK;
1300 }
1301
1302
1303 void Buffer::makeDocBookFile(FileName const & fname,
1304                               OutputParams const & runparams,
1305                               bool const body_only) const
1306 {
1307         LYXERR(Debug::LATEX, "makeDocBookFile...");
1308
1309         ofdocstream ofs;
1310         if (!openFileWrite(ofs, fname))
1311                 return;
1312
1313         writeDocBookSource(ofs, fname.absFilename(), runparams, body_only);
1314
1315         ofs.close();
1316         if (ofs.fail())
1317                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1318 }
1319
1320
1321 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1322                              OutputParams const & runparams,
1323                              bool const only_body) const
1324 {
1325         LaTeXFeatures features(*this, params(), runparams);
1326         validate(features);
1327
1328         d->texrow.reset();
1329
1330         DocumentClass const & tclass = params().documentClass();
1331         string const top_element = tclass.latexname();
1332
1333         if (!only_body) {
1334                 if (runparams.flavor == OutputParams::XML)
1335                         os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1336
1337                 // FIXME UNICODE
1338                 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1339
1340                 // FIXME UNICODE
1341                 if (! tclass.class_header().empty())
1342                         os << from_ascii(tclass.class_header());
1343                 else if (runparams.flavor == OutputParams::XML)
1344                         os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1345                             << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1346                 else
1347                         os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1348
1349                 docstring preamble = from_utf8(params().preamble);
1350                 if (runparams.flavor != OutputParams::XML ) {
1351                         preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1352                         preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1353                         preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1354                         preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1355                 }
1356
1357                 string const name = runparams.nice
1358                         ? changeExtension(absFileName(), ".sgml") : fname;
1359                 preamble += features.getIncludedFiles(name);
1360                 preamble += features.getLyXSGMLEntities();
1361
1362                 if (!preamble.empty()) {
1363                         os << "\n [ " << preamble << " ]";
1364                 }
1365                 os << ">\n\n";
1366         }
1367
1368         string top = top_element;
1369         top += " lang=\"";
1370         if (runparams.flavor == OutputParams::XML)
1371                 top += params().language->code();
1372         else
1373                 top += params().language->code().substr(0, 2);
1374         top += '"';
1375
1376         if (!params().options.empty()) {
1377                 top += ' ';
1378                 top += params().options;
1379         }
1380
1381         os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1382             << " file was created by LyX " << lyx_version
1383             << "\n  See http://www.lyx.org/ for more information -->\n";
1384
1385         params().documentClass().counters().reset();
1386
1387         updateMacros();
1388
1389         sgml::openTag(os, top);
1390         os << '\n';
1391         docbookParagraphs(text(), *this, os, runparams);
1392         sgml::closeTag(os, top_element);
1393 }
1394
1395
1396 void Buffer::makeLyXHTMLFile(FileName const & fname,
1397                               OutputParams const & runparams,
1398                               bool const body_only) const
1399 {
1400         LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
1401
1402         ofdocstream ofs;
1403         if (!openFileWrite(ofs, fname))
1404                 return;
1405
1406         writeLyXHTMLSource(ofs, runparams, body_only);
1407
1408         ofs.close();
1409         if (ofs.fail())
1410                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1411 }
1412
1413
1414 void Buffer::writeLyXHTMLSource(odocstream & os,
1415                              OutputParams const & runparams,
1416                              bool const only_body) const
1417 {
1418         LaTeXFeatures features(*this, params(), runparams);
1419         validate(features);
1420
1421         d->texrow.reset();
1422
1423         if (!only_body) {
1424                 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1425                 os << "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1 plus MathML 2.0//EN\" \"http://www.w3.org/TR/MathML2/dtd/xhtml-math11-f.dtd\">\n";
1426                 // FIXME Language should be set properly.
1427                 os << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n";
1428                 // FIXME Header
1429                 os << "<head>\n";
1430                 // FIXME Presumably need to set this right
1431                 os << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
1432                 // FIXME Get this during validation? What about other meta-data?
1433                 os << "<title>TBA</title>\n";
1434
1435                 os << features.getTClassHTMLPreamble();
1436
1437                 os << '\n';
1438
1439                 docstring const styleinfo = features.getTClassHTMLStyles();
1440                 if (!styleinfo.empty()) {
1441                         os << "<style type='text/css'>\n";
1442                         os << styleinfo;
1443                         os << "</style>\n";
1444                 }
1445                 os << "</head>\n<body>\n";
1446         }
1447
1448         XHTMLStream xs(os);
1449         params().documentClass().counters().reset();
1450         xhtmlParagraphs(text(), *this, xs, runparams);
1451         if (!only_body)
1452                 os << "</body>\n</html>\n";
1453 }
1454
1455
1456 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1457 // Other flags: -wall -v0 -x
1458 int Buffer::runChktex()
1459 {
1460         setBusy(true);
1461
1462         // get LaTeX-Filename
1463         FileName const path(temppath());
1464         string const name = addName(path.absFilename(), latexName());
1465         string const org_path = filePath();
1466
1467         PathChanger p(path); // path to LaTeX file
1468         message(_("Running chktex..."));
1469
1470         // Generate the LaTeX file if neccessary
1471         OutputParams runparams(&params().encoding());
1472         runparams.flavor = OutputParams::LATEX;
1473         runparams.nice = false;
1474         makeLaTeXFile(FileName(name), org_path, runparams);
1475
1476         TeXErrors terr;
1477         Chktex chktex(lyxrc.chktex_command, onlyFilename(name), filePath());
1478         int const res = chktex.run(terr); // run chktex
1479
1480         if (res == -1) {
1481                 Alert::error(_("chktex failure"),
1482                              _("Could not run chktex successfully."));
1483         } else if (res > 0) {
1484                 ErrorList & errlist = d->errorLists["ChkTeX"];
1485                 errlist.clear();
1486                 bufferErrors(terr, errlist);
1487         }
1488
1489         setBusy(false);
1490
1491         errors("ChkTeX");
1492
1493         return res;
1494 }
1495
1496
1497 void Buffer::validate(LaTeXFeatures & features) const
1498 {
1499         params().validate(features);
1500
1501         updateMacros();
1502
1503         for_each(paragraphs().begin(), paragraphs().end(),
1504                  boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1505
1506         if (lyxerr.debugging(Debug::LATEX)) {
1507                 features.showStruct();
1508         }
1509 }
1510
1511
1512 void Buffer::getLabelList(vector<docstring> & list) const
1513 {
1514         // If this is a child document, use the parent's list instead.
1515         Buffer const * const pbuf = d->parent();
1516         if (pbuf) {
1517                 pbuf->getLabelList(list);
1518                 return;
1519         }
1520
1521         list.clear();
1522         Toc & toc = d->toc_backend.toc("label");
1523         TocIterator toc_it = toc.begin();
1524         TocIterator end = toc.end();
1525         for (; toc_it != end; ++toc_it) {
1526                 if (toc_it->depth() == 0)
1527                         list.push_back(toc_it->str());
1528         }
1529 }
1530
1531
1532 void Buffer::updateBibfilesCache(UpdateScope scope) const
1533 {
1534         // If this is a child document, use the parent's cache instead.
1535         Buffer const * const pbuf = d->parent();
1536         if (pbuf && scope != UpdateChildOnly) {
1537                 pbuf->updateBibfilesCache();
1538                 return;
1539         }
1540
1541         d->bibfilesCache_.clear();
1542         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1543                 if (it->lyxCode() == BIBTEX_CODE) {
1544                         InsetBibtex const & inset =
1545                                 static_cast<InsetBibtex const &>(*it);
1546                         support::FileNameList const bibfiles = inset.getBibFiles();
1547                         d->bibfilesCache_.insert(d->bibfilesCache_.end(),
1548                                 bibfiles.begin(),
1549                                 bibfiles.end());
1550                 } else if (it->lyxCode() == INCLUDE_CODE) {
1551                         InsetInclude & inset =
1552                                 static_cast<InsetInclude &>(*it);
1553                         inset.updateBibfilesCache();
1554                         support::FileNameList const & bibfiles =
1555                                         inset.getBibfilesCache();
1556                         d->bibfilesCache_.insert(d->bibfilesCache_.end(),
1557                                 bibfiles.begin(),
1558                                 bibfiles.end());
1559                 }
1560         }
1561         // the bibinfo cache is now invalid
1562         d->bibinfoCacheValid_ = false;
1563 }
1564
1565
1566 void Buffer::invalidateBibinfoCache()
1567 {
1568         d->bibinfoCacheValid_ = false;
1569 }
1570
1571
1572 support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const
1573 {
1574         // If this is a child document, use the parent's cache instead.
1575         Buffer const * const pbuf = d->parent();
1576         if (pbuf && scope != UpdateChildOnly)
1577                 return pbuf->getBibfilesCache();
1578
1579         // We update the cache when first used instead of at loading time.
1580         if (d->bibfilesCache_.empty())
1581                 const_cast<Buffer *>(this)->updateBibfilesCache(scope);
1582
1583         return d->bibfilesCache_;
1584 }
1585
1586
1587 BiblioInfo const & Buffer::masterBibInfo() const
1588 {
1589         // if this is a child document and the parent is already loaded
1590         // use the parent's list instead  [ale990412]
1591         Buffer const * const tmp = masterBuffer();
1592         LASSERT(tmp, /**/);
1593         if (tmp != this)
1594                 return tmp->masterBibInfo();
1595         return localBibInfo();
1596 }
1597
1598
1599 BiblioInfo const & Buffer::localBibInfo() const
1600 {
1601         if (d->bibinfoCacheValid_) {
1602                 support::FileNameList const & bibfilesCache = getBibfilesCache();
1603                 // compare the cached timestamps with the actual ones.
1604                 support::FileNameList::const_iterator ei = bibfilesCache.begin();
1605                 support::FileNameList::const_iterator en = bibfilesCache.end();
1606                 for (; ei != en; ++ ei) {
1607                         time_t lastw = ei->lastModified();
1608                         if (lastw != d->bibfileStatus_[*ei]) {
1609                                 d->bibinfoCacheValid_ = false;
1610                                 d->bibfileStatus_[*ei] = lastw;
1611                                 break;
1612                         }
1613                 }
1614         }
1615
1616         if (!d->bibinfoCacheValid_) {
1617                 d->bibinfo_.clear();
1618                 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1619                         it->fillWithBibKeys(d->bibinfo_, it);
1620                 d->bibinfoCacheValid_ = true;
1621         }
1622         return d->bibinfo_;
1623 }
1624
1625
1626 bool Buffer::isDepClean(string const & name) const
1627 {
1628         DepClean::const_iterator const it = d->dep_clean.find(name);
1629         if (it == d->dep_clean.end())
1630                 return true;
1631         return it->second;
1632 }
1633
1634
1635 void Buffer::markDepClean(string const & name)
1636 {
1637         d->dep_clean[name] = true;
1638 }
1639
1640
1641 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1642 {
1643         if (isInternal()) {
1644                 // FIXME? if there is an Buffer LFUN that can be dispatched even
1645                 // if internal, put a switch '(cmd.action)' here.
1646                 return false;
1647         }
1648
1649         bool enable = true;
1650
1651         switch (cmd.action) {
1652
1653                 case LFUN_BUFFER_TOGGLE_READ_ONLY:
1654                         flag.setOnOff(isReadonly());
1655                         break;
1656
1657                 // FIXME: There is need for a command-line import.
1658                 //case LFUN_BUFFER_IMPORT:
1659
1660                 case LFUN_BUFFER_AUTO_SAVE:
1661                         break;
1662
1663                 case LFUN_BUFFER_EXPORT_CUSTOM:
1664                         // FIXME: Nothing to check here?
1665                         break;
1666
1667                 case LFUN_BUFFER_EXPORT: {
1668                         docstring const arg = cmd.argument();
1669                         enable = arg == "custom" || isExportable(to_utf8(arg));
1670                         if (!enable)
1671                                 flag.message(bformat(
1672                                         _("Don't know how to export to format: %1$s"), arg));
1673                         break;
1674                 }
1675
1676                 case LFUN_MASTER_BUFFER_UPDATE:
1677                 case LFUN_MASTER_BUFFER_VIEW:
1678                         enable = parent() != 0;
1679                         break;
1680                 case LFUN_BUFFER_UPDATE:
1681                 case LFUN_BUFFER_VIEW: {
1682                         string format = to_utf8(cmd.argument());
1683                         if (cmd.argument().empty())
1684                                 format = getDefaultOutputFormat();
1685                         typedef vector<Format const *> Formats;
1686                         Formats formats;
1687                         formats = exportableFormats(true);
1688                         Formats::const_iterator fit = formats.begin();
1689                         Formats::const_iterator end = formats.end();
1690                         enable = false;
1691                         for (; fit != end ; ++fit) {
1692                                 if ((*fit)->name() == format)
1693                                         enable = true;
1694                         }
1695                         break;
1696                 }
1697                 case LFUN_BUFFER_CHKTEX:
1698                         enable = isLatex() && !lyxrc.chktex_command.empty();
1699                         break;
1700
1701                 case LFUN_BUILD_PROGRAM:
1702                         enable = isExportable("program");
1703                         break;
1704
1705                 case LFUN_BRANCH_ACTIVATE:
1706                 case LFUN_BRANCH_DEACTIVATE: {
1707                         BranchList const & branchList = params().branchlist();
1708                         docstring const branchName = cmd.argument();
1709                         enable = !branchName.empty() && branchList.find(branchName);
1710                         break;
1711                 }
1712
1713                 case LFUN_BRANCH_ADD:
1714                 case LFUN_BRANCHES_RENAME:
1715                 case LFUN_BUFFER_PRINT:
1716                         // if no Buffer is present, then of course we won't be called!
1717                         break;
1718
1719                 case LFUN_BUFFER_LANGUAGE:
1720                         enable = !isReadonly();
1721                         break;
1722
1723                 default:
1724                         return false;
1725         }
1726         flag.setEnabled(enable);
1727         return true;
1728 }
1729
1730
1731 void Buffer::dispatch(string const & command, DispatchResult & result)
1732 {
1733         return dispatch(lyxaction.lookupFunc(command), result);
1734 }
1735
1736
1737 // NOTE We can end up here even if we have no GUI, because we are called
1738 // by LyX::exec to handled command-line requests. So we may need to check
1739 // whether we have a GUI or not. The boolean use_gui holds this information.
1740 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
1741 {
1742         if (isInternal()) {
1743                 // FIXME? if there is an Buffer LFUN that can be dispatched even
1744                 // if internal, put a switch '(cmd.action)' here.
1745                 dr.dispatched(false);
1746                 return;
1747         }
1748         string const argument = to_utf8(func.argument());
1749         // We'll set this back to false if need be.
1750         bool dispatched = true;
1751         undo().beginUndoGroup();
1752
1753         switch (func.action) {
1754         case LFUN_BUFFER_TOGGLE_READ_ONLY:
1755                 if (lyxvc().inUse())
1756                         lyxvc().toggleReadOnly();
1757                 else
1758                         setReadonly(!isReadonly());
1759                 break;
1760
1761         case LFUN_BUFFER_EXPORT: {
1762                 if (argument == "custom") {
1763                         lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "sendto"));
1764                         break;
1765                 }
1766                 doExport(argument, false);
1767                 bool success = doExport(argument, false);
1768                 dr.setError(success);
1769                 if (!success)
1770                         dr.setMessage(bformat(_("Error exporting to format: %1$s."),
1771                                               func.argument()));
1772                 break;
1773         }
1774
1775         case LFUN_BUFFER_UPDATE: {
1776                 string format = argument;
1777                 if (argument.empty())
1778                         format = getDefaultOutputFormat();
1779                 doExport(format, true);
1780                 break;
1781         }
1782
1783         case LFUN_BUFFER_VIEW: {
1784                 string format = argument;
1785                 if (argument.empty())
1786                         format = getDefaultOutputFormat();
1787                 preview(format);
1788                 break;
1789         }
1790
1791         case LFUN_MASTER_BUFFER_UPDATE: {
1792                 string format = argument;
1793                 if (argument.empty())
1794                         format = masterBuffer()->getDefaultOutputFormat();
1795                 masterBuffer()->doExport(format, true);
1796                 break;
1797         }
1798
1799         case LFUN_MASTER_BUFFER_VIEW: {
1800                 string format = argument;
1801                 if (argument.empty())
1802                         format = masterBuffer()->getDefaultOutputFormat();
1803                 masterBuffer()->preview(format);
1804                 break;
1805         }
1806
1807         case LFUN_BUILD_PROGRAM:
1808                 doExport("program", true);
1809                 break;
1810
1811         case LFUN_BUFFER_CHKTEX:
1812                 runChktex();
1813                 break;
1814
1815         case LFUN_BUFFER_EXPORT_CUSTOM: {
1816                 string format_name;
1817                 string command = split(argument, format_name, ' ');
1818                 Format const * format = formats.getFormat(format_name);
1819                 if (!format) {
1820                         lyxerr << "Format \"" << format_name
1821                                 << "\" not recognized!"
1822                                 << endl;
1823                         break;
1824                 }
1825
1826                 // The name of the file created by the conversion process
1827                 string filename;
1828
1829                 // Output to filename
1830                 if (format->name() == "lyx") {
1831                         string const latexname = latexName(false);
1832                         filename = changeExtension(latexname,
1833                                 format->extension());
1834                         filename = addName(temppath(), filename);
1835
1836                         if (!writeFile(FileName(filename)))
1837                                 break;
1838
1839                 } else {
1840                         doExport(format_name, true, filename);
1841                 }
1842
1843                 // Substitute $$FName for filename
1844                 if (!contains(command, "$$FName"))
1845                         command = "( " + command + " ) < $$FName";
1846                 command = subst(command, "$$FName", filename);
1847
1848                 // Execute the command in the background
1849                 Systemcall call;
1850                 call.startscript(Systemcall::DontWait, command);
1851                 break;
1852         }
1853
1854         // FIXME: There is need for a command-line import.
1855         /*
1856         case LFUN_BUFFER_IMPORT:
1857                 doImport(argument);
1858                 break;
1859         */
1860
1861         case LFUN_BUFFER_AUTO_SAVE:
1862                 autoSave();
1863                 break;
1864
1865         case LFUN_BRANCH_ADD: {
1866                 docstring const branch_name = func.argument();
1867                 if (branch_name.empty()) {
1868                         dispatched = false;
1869                         break;
1870                 }
1871                 BranchList & branch_list = params().branchlist();
1872                 Branch * branch = branch_list.find(branch_name);
1873                 if (branch) {
1874                         LYXERR0("Branch " << branch_name << " already exists.");
1875                         dr.setError(true);
1876                         docstring const msg =
1877                                 bformat(_("Branch \"%1$s\" already exists."), branch_name);
1878                         dr.setMessage(msg);
1879                 } else {
1880                         branch_list.add(branch_name);
1881                         branch = branch_list.find(branch_name);
1882                         string const x11hexname = X11hexname(branch->color());
1883                         docstring const str = branch_name + ' ' + from_ascii(x11hexname);
1884                         lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
1885                         dr.setError(false);
1886                         dr.update(Update::Force);
1887                 }
1888                 break;
1889         }
1890
1891         case LFUN_BRANCH_ACTIVATE:
1892         case LFUN_BRANCH_DEACTIVATE: {
1893                 BranchList & branchList = params().branchlist();
1894                 docstring const branchName = func.argument();
1895                 // the case without a branch name is handled elsewhere
1896                 if (branchName.empty()) {
1897                         dispatched = false;
1898                         break;
1899                 }
1900                 Branch * branch = branchList.find(branchName);
1901                 if (!branch) {
1902                         LYXERR0("Branch " << branchName << " does not exist.");
1903                         dr.setError(true);
1904                         docstring const msg =
1905                                 bformat(_("Branch \"%1$s\" does not exist."), branchName);
1906                         dr.setMessage(msg);
1907                 } else {
1908                         branch->setSelected(func.action == LFUN_BRANCH_ACTIVATE);
1909                         dr.setError(false);
1910                         dr.update(Update::Force);
1911                 }
1912                 break;
1913         }
1914
1915         case LFUN_BRANCHES_RENAME: {
1916                 if (func.argument().empty())
1917                         break;
1918
1919                 docstring const oldname = from_utf8(func.getArg(0));
1920                 docstring const newname = from_utf8(func.getArg(1));
1921                 InsetIterator it  = inset_iterator_begin(inset());
1922                 InsetIterator const end = inset_iterator_end(inset());
1923                 bool success = false;
1924                 for (; it != end; ++it) {
1925                         if (it->lyxCode() == BRANCH_CODE) {
1926                                 InsetBranch & ins = static_cast<InsetBranch &>(*it);
1927                                 if (ins.branch() == oldname) {
1928                                         undo().recordUndo(it);
1929                                         ins.rename(newname);
1930                                         success = true;
1931                                         continue;
1932                                 }
1933                         }
1934                         if (it->lyxCode() == INCLUDE_CODE) {
1935                                 // get buffer of external file
1936                                 InsetInclude const & ins =
1937                                         static_cast<InsetInclude const &>(*it);
1938                                 Buffer * child = ins.getChildBuffer();
1939                                 if (!child)
1940                                         continue;
1941                                 child->dispatch(func, dr);
1942                         }
1943                 }
1944
1945                 if (success)
1946                         dr.update(Update::Force);
1947                 break;
1948         }
1949
1950         case LFUN_BUFFER_PRINT: {
1951                 // we'll assume there's a problem until we succeed
1952                 dr.setError(true);
1953                 string target = func.getArg(0);
1954                 string target_name = func.getArg(1);
1955                 string command = func.getArg(2);
1956
1957                 if (target.empty()
1958                     || target_name.empty()
1959                     || command.empty()) {
1960                         LYXERR0("Unable to parse " << func.argument());
1961                         docstring const msg =
1962                                 bformat(_("Unable to parse \"%1$s\""), func.argument());
1963                         dr.setMessage(msg);
1964                         break;
1965                 }
1966                 if (target != "printer" && target != "file") {
1967                         LYXERR0("Unrecognized target \"" << target << '"');
1968                         docstring const msg =
1969                                 bformat(_("Unrecognized target \"%1$s\""), from_utf8(target));
1970                         dr.setMessage(msg);
1971                         break;
1972                 }
1973
1974                 if (!doExport("dvi", true)) {
1975                         showPrintError(absFileName());
1976                         dr.setMessage(_("Error exporting to DVI."));
1977                         break;
1978                 }
1979
1980                 // Push directory path.
1981                 string const path = temppath();
1982                 // Prevent the compiler from optimizing away p
1983                 FileName pp(path);
1984                 PathChanger p(pp);
1985
1986                 // there are three cases here:
1987                 // 1. we print to a file
1988                 // 2. we print directly to a printer
1989                 // 3. we print using a spool command (print to file first)
1990                 Systemcall one;
1991                 int res = 0;
1992                 string const dviname = changeExtension(latexName(true), "dvi");
1993
1994                 if (target == "printer") {
1995                         if (!lyxrc.print_spool_command.empty()) {
1996                                 // case 3: print using a spool
1997                                 string const psname = changeExtension(dviname,".ps");
1998                                 command += ' ' + lyxrc.print_to_file
1999                                         + quoteName(psname)
2000                                         + ' '
2001                                         + quoteName(dviname);
2002
2003                                 string command2 = lyxrc.print_spool_command + ' ';
2004                                 if (target_name != "default") {
2005                                         command2 += lyxrc.print_spool_printerprefix
2006                                                 + target_name
2007                                                 + ' ';
2008                                 }
2009                                 command2 += quoteName(psname);
2010                                 // First run dvips.
2011                                 // If successful, then spool command
2012                                 res = one.startscript(Systemcall::Wait, command);
2013
2014                                 if (res == 0) {
2015                                         // If there's no GUI, we have to wait on this command. Otherwise,
2016                                         // LyX deletes the temporary directory, and with it the spooled
2017                                         // file, before it can be printed!!
2018                                         Systemcall::Starttype stype = use_gui ?
2019                                                 Systemcall::DontWait : Systemcall::Wait;
2020                                         res = one.startscript(stype, command2);
2021                                 }
2022                         } else {
2023                                 // case 2: print directly to a printer
2024                                 if (target_name != "default")
2025                                         command += ' ' + lyxrc.print_to_printer + target_name + ' ';
2026                                 // as above....
2027                                 Systemcall::Starttype stype = use_gui ?
2028                                         Systemcall::DontWait : Systemcall::Wait;
2029                                 res = one.startscript(stype, command + quoteName(dviname));
2030                         }
2031
2032                 } else {
2033                         // case 1: print to a file
2034                         FileName const filename(makeAbsPath(target_name, filePath()));
2035                         FileName const dvifile(makeAbsPath(dviname, path));
2036                         if (filename.exists()) {
2037                                 docstring text = bformat(
2038                                         _("The file %1$s already exists.\n\n"
2039                                           "Do you want to overwrite that file?"),
2040                                         makeDisplayPath(filename.absFilename()));
2041                                 if (Alert::prompt(_("Overwrite file?"),
2042                                                   text, 0, 1, _("&Overwrite"), _("&Cancel")) != 0)
2043                                         break;
2044                         }
2045                         command += ' ' + lyxrc.print_to_file
2046                                 + quoteName(filename.toFilesystemEncoding())
2047                                 + ' '
2048                                 + quoteName(dvifile.toFilesystemEncoding());
2049                         // as above....
2050                         Systemcall::Starttype stype = use_gui ?
2051                                 Systemcall::DontWait : Systemcall::Wait;
2052                         res = one.startscript(stype, command);
2053                 }
2054
2055                 if (res == 0)
2056                         dr.setError(false);
2057                 else {
2058                         dr.setMessage(_("Error running external commands."));
2059                         showPrintError(absFileName());
2060                 }
2061                 break;
2062         }
2063
2064         case LFUN_BUFFER_LANGUAGE: {
2065                 Language const * oldL = params().language;
2066                 Language const * newL = languages.getLanguage(argument);
2067                 if (!newL || oldL == newL)
2068                         break;
2069                 if (oldL->rightToLeft() == newL->rightToLeft() && !isMultiLingual())
2070                         changeLanguage(oldL, newL);
2071                 break;
2072         }
2073
2074         default:
2075                 dispatched = false;
2076                 break;
2077         }
2078         dr.dispatched(dispatched);
2079         undo().endUndoGroup();
2080 }
2081
2082
2083 void Buffer::changeLanguage(Language const * from, Language const * to)
2084 {
2085         LASSERT(from, /**/);
2086         LASSERT(to, /**/);
2087
2088         for_each(par_iterator_begin(),
2089                  par_iterator_end(),
2090                  bind(&Paragraph::changeLanguage, _1, params(), from, to));
2091 }
2092
2093
2094 bool Buffer::isMultiLingual() const
2095 {
2096         ParConstIterator end = par_iterator_end();
2097         for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2098                 if (it->isMultiLingual(params()))
2099                         return true;
2100
2101         return false;
2102 }
2103
2104
2105 DocIterator Buffer::getParFromID(int const id) const
2106 {
2107         Buffer * buf = const_cast<Buffer *>(this);
2108         if (id < 0) {
2109                 // John says this is called with id == -1 from undo
2110                 lyxerr << "getParFromID(), id: " << id << endl;
2111                 return doc_iterator_end(buf);
2112         }
2113
2114         for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2115                 if (it.paragraph().id() == id)
2116                         return it;
2117
2118         return doc_iterator_end(buf);
2119 }
2120
2121
2122 bool Buffer::hasParWithID(int const id) const
2123 {
2124         return !getParFromID(id).atEnd();
2125 }
2126
2127
2128 ParIterator Buffer::par_iterator_begin()
2129 {
2130         return ParIterator(doc_iterator_begin(this));
2131 }
2132
2133
2134 ParIterator Buffer::par_iterator_end()
2135 {
2136         return ParIterator(doc_iterator_end(this));
2137 }
2138
2139
2140 ParConstIterator Buffer::par_iterator_begin() const
2141 {
2142         return ParConstIterator(doc_iterator_begin(this));
2143 }
2144
2145
2146 ParConstIterator Buffer::par_iterator_end() const
2147 {
2148         return ParConstIterator(doc_iterator_end(this));
2149 }
2150
2151
2152 Language const * Buffer::language() const
2153 {
2154         return params().language;
2155 }
2156
2157
2158 docstring const Buffer::B_(string const & l10n) const
2159 {
2160         return params().B_(l10n);
2161 }
2162
2163
2164 bool Buffer::isClean() const
2165 {
2166         return d->lyx_clean;
2167 }
2168
2169
2170 bool Buffer::isBakClean() const
2171 {
2172         return d->bak_clean;
2173 }
2174
2175
2176 bool Buffer::isExternallyModified(CheckMethod method) const
2177 {
2178         LASSERT(d->filename.exists(), /**/);
2179         // if method == timestamp, check timestamp before checksum
2180         return (method == checksum_method
2181                 || d->timestamp_ != d->filename.lastModified())
2182                 && d->checksum_ != d->filename.checksum();
2183 }
2184
2185
2186 void Buffer::saveCheckSum(FileName const & file) const
2187 {
2188         if (file.exists()) {
2189                 d->timestamp_ = file.lastModified();
2190                 d->checksum_ = file.checksum();
2191         } else {
2192                 // in the case of save to a new file.
2193                 d->timestamp_ = 0;
2194                 d->checksum_ = 0;
2195         }
2196 }
2197
2198
2199 void Buffer::markClean() const
2200 {
2201         if (!d->lyx_clean) {
2202                 d->lyx_clean = true;
2203                 updateTitles();
2204         }
2205         // if the .lyx file has been saved, we don't need an
2206         // autosave
2207         d->bak_clean = true;
2208 }
2209
2210
2211 void Buffer::markBakClean() const
2212 {
2213         d->bak_clean = true;
2214 }
2215
2216
2217 void Buffer::setUnnamed(bool flag)
2218 {
2219         d->unnamed = flag;
2220 }
2221
2222
2223 bool Buffer::isUnnamed() const
2224 {
2225         return d->unnamed;
2226 }
2227
2228
2229 /// \note
2230 /// Don't check unnamed, here: isInternal() is used in
2231 /// newBuffer(), where the unnamed flag has not been set by anyone
2232 /// yet. Also, for an internal buffer, there should be no need for
2233 /// retrieving fileName() nor for checking if it is unnamed or not.
2234 bool Buffer::isInternal() const
2235 {
2236         return fileName().extension() == "internal";
2237 }
2238
2239
2240 void Buffer::markDirty()
2241 {
2242         if (d->lyx_clean) {
2243                 d->lyx_clean = false;
2244                 updateTitles();
2245         }
2246         d->bak_clean = false;
2247
2248         DepClean::iterator it = d->dep_clean.begin();
2249         DepClean::const_iterator const end = d->dep_clean.end();
2250
2251         for (; it != end; ++it)
2252                 it->second = false;
2253 }
2254
2255
2256 FileName Buffer::fileName() const
2257 {
2258         return d->filename;
2259 }
2260
2261
2262 string Buffer::absFileName() const
2263 {
2264         return d->filename.absFilename();
2265 }
2266
2267
2268 string Buffer::filePath() const
2269 {
2270         return d->filename.onlyPath().absFilename() + "/";
2271 }
2272
2273
2274 bool Buffer::isReadonly() const
2275 {
2276         return d->read_only;
2277 }
2278
2279
2280 void Buffer::setParent(Buffer const * buffer)
2281 {
2282         // Avoids recursive include.
2283         d->setParent(buffer == this ? 0 : buffer);
2284         updateMacros();
2285 }
2286
2287
2288 Buffer const * Buffer::parent() const
2289 {
2290         return d->parent();
2291 }
2292
2293
2294 void Buffer::collectRelatives(BufferSet & bufs) const
2295 {
2296         bufs.insert(this);
2297         if (parent())
2298                 parent()->collectRelatives(bufs);
2299
2300         // loop over children
2301         Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2302         Impl::BufferPositionMap::iterator end = d->children_positions.end();
2303         for (; it != end; ++it)
2304                 bufs.insert(const_cast<Buffer *>(it->first));
2305 }
2306
2307
2308 std::vector<Buffer const *> Buffer::allRelatives() const
2309 {
2310         BufferSet bufs;
2311         collectRelatives(bufs);
2312         BufferSet::iterator it = bufs.begin();
2313         std::vector<Buffer const *> ret;
2314         for (; it != bufs.end(); ++it)
2315                 ret.push_back(*it);
2316         return ret;
2317 }
2318
2319
2320 Buffer const * Buffer::masterBuffer() const
2321 {
2322         Buffer const * const pbuf = d->parent();
2323         if (!pbuf)
2324                 return this;
2325
2326         return pbuf->masterBuffer();
2327 }
2328
2329
2330 bool Buffer::isChild(Buffer * child) const
2331 {
2332         return d->children_positions.find(child) != d->children_positions.end();
2333 }
2334
2335
2336 DocIterator Buffer::firstChildPosition(Buffer const * child)
2337 {
2338         Impl::BufferPositionMap::iterator it;
2339         it = d->children_positions.find(child);
2340         if (it == d->children_positions.end())
2341                 return DocIterator(this);
2342         return it->second;
2343 }
2344
2345
2346 std::vector<Buffer *> Buffer::getChildren(bool grand_children) const
2347 {
2348         std::vector<Buffer *> clist;
2349         // loop over children
2350         Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2351         Impl::BufferPositionMap::iterator end = d->children_positions.end();
2352         for (; it != end; ++it) {
2353                 Buffer * child = const_cast<Buffer *>(it->first);
2354                 clist.push_back(child);
2355                 if (grand_children) {
2356                         // there might be grandchildren
2357                         std::vector<Buffer *> glist = child->getChildren();
2358                         for (vector<Buffer *>::const_iterator git = glist.begin();
2359                                  git != glist.end(); ++git)
2360                                 clist.push_back(*git);
2361                 }
2362         }
2363         return clist;
2364 }
2365
2366
2367 template<typename M>
2368 typename M::iterator greatest_below(M & m, typename M::key_type const & x)
2369 {
2370         if (m.empty())
2371                 return m.end();
2372
2373         typename M::iterator it = m.lower_bound(x);
2374         if (it == m.begin())
2375                 return m.end();
2376
2377         it--;
2378         return it;
2379 }
2380
2381
2382 MacroData const * Buffer::getBufferMacro(docstring const & name,
2383                                          DocIterator const & pos) const
2384 {
2385         LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
2386
2387         // if paragraphs have no macro context set, pos will be empty
2388         if (pos.empty())
2389                 return 0;
2390
2391         // we haven't found anything yet
2392         DocIterator bestPos = par_iterator_begin();
2393         MacroData const * bestData = 0;
2394
2395         // find macro definitions for name
2396         Impl::NamePositionScopeMacroMap::iterator nameIt
2397                 = d->macros.find(name);
2398         if (nameIt != d->macros.end()) {
2399                 // find last definition in front of pos or at pos itself
2400                 Impl::PositionScopeMacroMap::const_iterator it
2401                         = greatest_below(nameIt->second, pos);
2402                 if (it != nameIt->second.end()) {
2403                         while (true) {
2404                                 // scope ends behind pos?
2405                                 if (pos < it->second.first) {
2406                                         // Looks good, remember this. If there
2407                                         // is no external macro behind this,
2408                                         // we found the right one already.
2409                                         bestPos = it->first;
2410                                         bestData = &it->second.second;
2411                                         break;
2412                                 }
2413
2414                                 // try previous macro if there is one
2415                                 if (it == nameIt->second.begin())
2416                                         break;
2417                                 it--;
2418                         }
2419                 }
2420         }
2421
2422         // find macros in included files
2423         Impl::PositionScopeBufferMap::const_iterator it
2424                 = greatest_below(d->position_to_children, pos);
2425         if (it == d->position_to_children.end())
2426                 // no children before
2427                 return bestData;
2428
2429         while (true) {
2430                 // do we know something better (i.e. later) already?
2431                 if (it->first < bestPos )
2432                         break;
2433
2434                 // scope ends behind pos?
2435                 if (pos < it->second.first) {
2436                         // look for macro in external file
2437                         d->macro_lock = true;
2438                         MacroData const * data
2439                         = it->second.second->getMacro(name, false);
2440                         d->macro_lock = false;
2441                         if (data) {
2442                                 bestPos = it->first;
2443                                 bestData = data;
2444                                 break;
2445                         }
2446                 }
2447
2448                 // try previous file if there is one
2449                 if (it == d->position_to_children.begin())
2450                         break;
2451                 --it;
2452         }
2453
2454         // return the best macro we have found
2455         return bestData;
2456 }
2457
2458
2459 MacroData const * Buffer::getMacro(docstring const & name,
2460         DocIterator const & pos, bool global) const
2461 {
2462         if (d->macro_lock)
2463                 return 0;
2464
2465         // query buffer macros
2466         MacroData const * data = getBufferMacro(name, pos);
2467         if (data != 0)
2468                 return data;
2469
2470         // If there is a master buffer, query that
2471         Buffer const * const pbuf = d->parent();
2472         if (pbuf) {
2473                 d->macro_lock = true;
2474                 MacroData const * macro = pbuf->getMacro(
2475                         name, *this, false);
2476                 d->macro_lock = false;
2477                 if (macro)
2478                         return macro;
2479         }
2480
2481         if (global) {
2482                 data = MacroTable::globalMacros().get(name);
2483                 if (data != 0)
2484                         return data;
2485         }
2486
2487         return 0;
2488 }
2489
2490
2491 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
2492 {
2493         // set scope end behind the last paragraph
2494         DocIterator scope = par_iterator_begin();
2495         scope.pit() = scope.lastpit() + 1;
2496
2497         return getMacro(name, scope, global);
2498 }
2499
2500
2501 MacroData const * Buffer::getMacro(docstring const & name,
2502         Buffer const & child, bool global) const
2503 {
2504         // look where the child buffer is included first
2505         Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
2506         if (it == d->children_positions.end())
2507                 return 0;
2508
2509         // check for macros at the inclusion position
2510         return getMacro(name, it->second, global);
2511 }
2512
2513
2514 void Buffer::updateMacros(DocIterator & it, DocIterator & scope) const
2515 {
2516         pit_type lastpit = it.lastpit();
2517
2518         // look for macros in each paragraph
2519         while (it.pit() <= lastpit) {
2520                 Paragraph & par = it.paragraph();
2521
2522                 // iterate over the insets of the current paragraph
2523                 InsetList const & insets = par.insetList();
2524                 InsetList::const_iterator iit = insets.begin();
2525                 InsetList::const_iterator end = insets.end();
2526                 for (; iit != end; ++iit) {
2527                         it.pos() = iit->pos;
2528
2529                         // is it a nested text inset?
2530                         if (iit->inset->asInsetText()) {
2531                                 // Inset needs its own scope?
2532                                 InsetText const * itext = iit->inset->asInsetText();
2533                                 bool newScope = itext->isMacroScope();
2534
2535                                 // scope which ends just behind the inset
2536                                 DocIterator insetScope = it;
2537                                 ++insetScope.pos();
2538
2539                                 // collect macros in inset
2540                                 it.push_back(CursorSlice(*iit->inset));
2541                                 updateMacros(it, newScope ? insetScope : scope);
2542                                 it.pop_back();
2543                                 continue;
2544                         }
2545
2546                         // is it an external file?
2547                         if (iit->inset->lyxCode() == INCLUDE_CODE) {
2548                                 // get buffer of external file
2549                                 InsetInclude const & inset =
2550                                         static_cast<InsetInclude const &>(*iit->inset);
2551                                 d->macro_lock = true;
2552                                 Buffer * child = inset.getChildBuffer();
2553                                 d->macro_lock = false;
2554                                 if (!child)
2555                                         continue;
2556
2557                                 // register its position, but only when it is
2558                                 // included first in the buffer
2559                                 if (d->children_positions.find(child) ==
2560                                         d->children_positions.end())
2561                                                 d->children_positions[child] = it;
2562
2563                                 // register child with its scope
2564                                 d->position_to_children[it] = Impl::ScopeBuffer(scope, child);
2565                                 continue;
2566                         }
2567
2568                         if (iit->inset->lyxCode() != MATHMACRO_CODE)
2569                                 continue;
2570
2571                         // get macro data
2572                         MathMacroTemplate & macroTemplate =
2573                                 static_cast<MathMacroTemplate &>(*iit->inset);
2574                         MacroContext mc(this, it);
2575                         macroTemplate.updateToContext(mc);
2576
2577                         // valid?
2578                         bool valid = macroTemplate.validMacro();
2579                         // FIXME: Should be fixNameAndCheckIfValid() in fact,
2580                         // then the BufferView's cursor will be invalid in
2581                         // some cases which leads to crashes.
2582                         if (!valid)
2583                                 continue;
2584
2585                         // register macro
2586                         // FIXME (Abdel), I don't understandt why we pass 'it' here
2587                         // instead of 'macroTemplate' defined above... is this correct?
2588                         d->macros[macroTemplate.name()][it] =
2589                                 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(this), it));
2590                 }
2591
2592                 // next paragraph
2593                 it.pit()++;
2594                 it.pos() = 0;
2595         }
2596 }
2597
2598
2599 void Buffer::updateMacros() const
2600 {
2601         if (d->macro_lock)
2602                 return;
2603
2604         LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
2605
2606         // start with empty table
2607         d->macros.clear();
2608         d->children_positions.clear();
2609         d->position_to_children.clear();
2610
2611         // Iterate over buffer, starting with first paragraph
2612         // The scope must be bigger than any lookup DocIterator
2613         // later. For the global lookup, lastpit+1 is used, hence
2614         // we use lastpit+2 here.
2615         DocIterator it = par_iterator_begin();
2616         DocIterator outerScope = it;
2617         outerScope.pit() = outerScope.lastpit() + 2;
2618         updateMacros(it, outerScope);
2619 }
2620
2621
2622 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
2623 {
2624         InsetIterator it  = inset_iterator_begin(inset());
2625         InsetIterator const end = inset_iterator_end(inset());
2626         for (; it != end; ++it) {
2627                 if (it->lyxCode() == BRANCH_CODE) {
2628                         InsetBranch & br = static_cast<InsetBranch &>(*it);
2629                         docstring const name = br.branch();
2630                         if (!from_master && !params().branchlist().find(name))
2631                                 result.push_back(name);
2632                         else if (from_master && !masterBuffer()->params().branchlist().find(name))
2633                                 result.push_back(name);
2634                         continue;
2635                 }
2636                 if (it->lyxCode() == INCLUDE_CODE) {
2637                         // get buffer of external file
2638                         InsetInclude const & ins =
2639                                 static_cast<InsetInclude const &>(*it);
2640                         Buffer * child = ins.getChildBuffer();
2641                         if (!child)
2642                                 continue;
2643                         child->getUsedBranches(result, true);
2644                 }
2645         }
2646         // remove duplicates
2647         result.unique();
2648 }
2649
2650
2651 void Buffer::updateMacroInstances() const
2652 {
2653         LYXERR(Debug::MACROS, "updateMacroInstances for "
2654                 << d->filename.onlyFileName());
2655         DocIterator it = doc_iterator_begin(this);
2656         DocIterator end = doc_iterator_end(this);
2657         for (; it != end; it.forwardPos()) {
2658                 // look for MathData cells in InsetMathNest insets
2659                 Inset * inset = it.nextInset();
2660                 if (!inset)
2661                         continue;
2662
2663                 InsetMath * minset = inset->asInsetMath();
2664                 if (!minset)
2665                         continue;
2666
2667                 // update macro in all cells of the InsetMathNest
2668                 DocIterator::idx_type n = minset->nargs();
2669                 MacroContext mc = MacroContext(this, it);
2670                 for (DocIterator::idx_type i = 0; i < n; ++i) {
2671                         MathData & data = minset->cell(i);
2672                         data.updateMacros(0, mc);
2673                 }
2674         }
2675 }
2676
2677
2678 void Buffer::listMacroNames(MacroNameSet & macros) const
2679 {
2680         if (d->macro_lock)
2681                 return;
2682
2683         d->macro_lock = true;
2684
2685         // loop over macro names
2686         Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
2687         Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
2688         for (; nameIt != nameEnd; ++nameIt)
2689                 macros.insert(nameIt->first);
2690
2691         // loop over children
2692         Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2693         Impl::BufferPositionMap::iterator end = d->children_positions.end();
2694         for (; it != end; ++it)
2695                 it->first->listMacroNames(macros);
2696
2697         // call parent
2698         Buffer const * const pbuf = d->parent();
2699         if (pbuf)
2700                 pbuf->listMacroNames(macros);
2701
2702         d->macro_lock = false;
2703 }
2704
2705
2706 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
2707 {
2708         Buffer const * const pbuf = d->parent();
2709         if (!pbuf)
2710                 return;
2711
2712         MacroNameSet names;
2713         pbuf->listMacroNames(names);
2714
2715         // resolve macros
2716         MacroNameSet::iterator it = names.begin();
2717         MacroNameSet::iterator end = names.end();
2718         for (; it != end; ++it) {
2719                 // defined?
2720                 MacroData const * data =
2721                 pbuf->getMacro(*it, *this, false);
2722                 if (data) {
2723                         macros.insert(data);
2724
2725                         // we cannot access the original MathMacroTemplate anymore
2726                         // here to calls validate method. So we do its work here manually.
2727                         // FIXME: somehow make the template accessible here.
2728                         if (data->optionals() > 0)
2729                                 features.require("xargs");
2730                 }
2731         }
2732 }
2733
2734
2735 Buffer::References & Buffer::references(docstring const & label)
2736 {
2737         if (d->parent())
2738                 return const_cast<Buffer *>(masterBuffer())->references(label);
2739
2740         RefCache::iterator it = d->ref_cache_.find(label);
2741         if (it != d->ref_cache_.end())
2742                 return it->second.second;
2743
2744         static InsetLabel const * dummy_il = 0;
2745         static References const dummy_refs;
2746         it = d->ref_cache_.insert(
2747                 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
2748         return it->second.second;
2749 }
2750
2751
2752 Buffer::References const & Buffer::references(docstring const & label) const
2753 {
2754         return const_cast<Buffer *>(this)->references(label);
2755 }
2756
2757
2758 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
2759 {
2760         masterBuffer()->d->ref_cache_[label].first = il;
2761 }
2762
2763
2764 InsetLabel const * Buffer::insetLabel(docstring const & label) const
2765 {
2766         return masterBuffer()->d->ref_cache_[label].first;
2767 }
2768
2769
2770 void Buffer::clearReferenceCache() const
2771 {
2772         if (!d->parent())
2773                 d->ref_cache_.clear();
2774 }
2775
2776
2777 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
2778         InsetCode code)
2779 {
2780         //FIXME: This does not work for child documents yet.
2781         LASSERT(code == CITE_CODE, /**/);
2782         // Check if the label 'from' appears more than once
2783         vector<docstring> labels;
2784         string paramName;
2785         BiblioInfo const & keys = masterBibInfo();
2786         BiblioInfo::const_iterator bit  = keys.begin();
2787         BiblioInfo::const_iterator bend = keys.end();
2788
2789         for (; bit != bend; ++bit)
2790                 // FIXME UNICODE
2791                 labels.push_back(bit->first);
2792         paramName = "key";
2793
2794         if (count(labels.begin(), labels.end(), from) > 1)
2795                 return;
2796
2797         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2798                 if (it->lyxCode() == code) {
2799                         InsetCommand & inset = static_cast<InsetCommand &>(*it);
2800                         docstring const oldValue = inset.getParam(paramName);
2801                         if (oldValue == from)
2802                                 inset.setParam(paramName, to);
2803                 }
2804         }
2805 }
2806
2807
2808 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
2809         pit_type par_end, bool full_source) const
2810 {
2811         OutputParams runparams(&params().encoding());
2812         runparams.nice = true;
2813         runparams.flavor = params().useXetex ?
2814                 OutputParams::XETEX : OutputParams::LATEX;
2815         runparams.linelen = lyxrc.plaintext_linelen;
2816         // No side effect of file copying and image conversion
2817         runparams.dryrun = true;
2818
2819         if (full_source) {
2820                 os << "% " << _("Preview source code") << "\n\n";
2821                 d->texrow.reset();
2822                 d->texrow.newline();
2823                 d->texrow.newline();
2824                 if (isDocBook())
2825                         writeDocBookSource(os, absFileName(), runparams, false);
2826                 else
2827                         // latex or literate
2828                         writeLaTeXSource(os, string(), runparams, true, true);
2829         } else {
2830                 runparams.par_begin = par_begin;
2831                 runparams.par_end = par_end;
2832                 if (par_begin + 1 == par_end) {
2833                         os << "% "
2834                            << bformat(_("Preview source code for paragraph %1$d"), par_begin)
2835                            << "\n\n";
2836                 } else {
2837                         os << "% "
2838                            << bformat(_("Preview source code from paragraph %1$s to %2$s"),
2839                                         convert<docstring>(par_begin),
2840                                         convert<docstring>(par_end - 1))
2841                            << "\n\n";
2842                 }
2843                 TexRow texrow;
2844                 texrow.reset();
2845                 texrow.newline();
2846                 texrow.newline();
2847                 // output paragraphs
2848                 if (isDocBook())
2849                         docbookParagraphs(text(), *this, os, runparams);
2850                 else
2851                         // latex or literate
2852                         latexParagraphs(*this, text(), os, texrow, runparams);
2853         }
2854 }
2855
2856
2857 ErrorList & Buffer::errorList(string const & type) const
2858 {
2859         static ErrorList emptyErrorList;
2860         map<string, ErrorList>::iterator I = d->errorLists.find(type);
2861         if (I == d->errorLists.end())
2862                 return emptyErrorList;
2863
2864         return I->second;
2865 }
2866
2867
2868 void Buffer::updateTocItem(std::string const & type,
2869         DocIterator const & dit) const
2870 {
2871         if (gui_)
2872                 gui_->updateTocItem(type, dit);
2873 }
2874
2875
2876 void Buffer::structureChanged() const
2877 {
2878         if (gui_)
2879                 gui_->structureChanged();
2880 }
2881
2882
2883 void Buffer::errors(string const & err, bool from_master) const
2884 {
2885         if (gui_)
2886                 gui_->errors(err, from_master);
2887 }
2888
2889
2890 void Buffer::message(docstring const & msg) const
2891 {
2892         if (gui_)
2893                 gui_->message(msg);
2894 }
2895
2896
2897 void Buffer::setBusy(bool on) const
2898 {
2899         if (gui_)
2900                 gui_->setBusy(on);
2901 }
2902
2903
2904 void Buffer::setReadOnly(bool on) const
2905 {
2906         if (d->wa_)
2907                 d->wa_->setReadOnly(on);
2908 }
2909
2910
2911 void Buffer::updateTitles() const
2912 {
2913         if (d->wa_)
2914                 d->wa_->updateTitles();
2915 }
2916
2917
2918 void Buffer::resetAutosaveTimers() const
2919 {
2920         if (gui_)
2921                 gui_->resetAutosaveTimers();
2922 }
2923
2924
2925 bool Buffer::hasGuiDelegate() const
2926 {
2927         return gui_;
2928 }
2929
2930
2931 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
2932 {
2933         gui_ = gui;
2934 }
2935
2936
2937
2938 namespace {
2939
2940 class AutoSaveBuffer : public ForkedProcess {
2941 public:
2942         ///
2943         AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
2944                 : buffer_(buffer), fname_(fname) {}
2945         ///
2946         virtual boost::shared_ptr<ForkedProcess> clone() const
2947         {
2948                 return boost::shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
2949         }
2950         ///
2951         int start()
2952         {
2953                 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
2954                                                  from_utf8(fname_.absFilename())));
2955                 return run(DontWait);
2956         }
2957 private:
2958         ///
2959         virtual int generateChild();
2960         ///
2961         Buffer const & buffer_;
2962         FileName fname_;
2963 };
2964
2965
2966 int AutoSaveBuffer::generateChild()
2967 {
2968 #if defined(__APPLE__)
2969         /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
2970          *   We should use something else like threads.
2971          *
2972          * Since I do not know how to determine at run time what is the OS X
2973          * version, I just disable forking altogether for now (JMarc)
2974          */
2975         pid_t const pid = -1;
2976 #else
2977         // tmp_ret will be located (usually) in /tmp
2978         // will that be a problem?
2979         // Note that this calls ForkedCalls::fork(), so it's
2980         // ok cross-platform.
2981         pid_t const pid = fork();
2982         // If you want to debug the autosave
2983         // you should set pid to -1, and comment out the fork.
2984         if (pid != 0 && pid != -1)
2985                 return pid;
2986 #endif
2987
2988         // pid = -1 signifies that lyx was unable
2989         // to fork. But we will do the save
2990         // anyway.
2991         bool failed = false;
2992         FileName const tmp_ret = FileName::tempName("lyxauto");
2993         if (!tmp_ret.empty()) {
2994                 buffer_.writeFile(tmp_ret);
2995                 // assume successful write of tmp_ret
2996                 if (!tmp_ret.moveTo(fname_))
2997                         failed = true;
2998         } else
2999                 failed = true;
3000
3001         if (failed) {
3002                 // failed to write/rename tmp_ret so try writing direct
3003                 if (!buffer_.writeFile(fname_)) {
3004                         // It is dangerous to do this in the child,
3005                         // but safe in the parent, so...
3006                         if (pid == -1) // emit message signal.
3007                                 buffer_.message(_("Autosave failed!"));
3008                 }
3009         }
3010
3011         if (pid == 0) // we are the child so...
3012                 _exit(0);
3013
3014         return pid;
3015 }
3016
3017 } // namespace anon
3018
3019
3020 FileName Buffer::getAutosaveFilename() const
3021 {
3022         // if the document is unnamed try to save in the backup dir, else
3023         // in the default document path, and as a last try in the filePath,
3024         // which will most often be the temporary directory
3025         string fpath;
3026         if (isUnnamed())
3027                 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
3028                         : lyxrc.backupdir_path;
3029         if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
3030                 fpath = filePath();
3031
3032         string const fname = "#" + d->filename.onlyFileName() + "#";
3033         return makeAbsPath(fname, fpath);
3034 }
3035
3036
3037 void Buffer::removeAutosaveFile() const
3038 {
3039         FileName const f = getAutosaveFilename();
3040         if (f.exists())
3041                 f.removeFile();
3042 }
3043
3044
3045 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
3046 {
3047         FileName const newauto = getAutosaveFilename();
3048         if (!(oldauto == newauto || oldauto.moveTo(newauto)))
3049                 LYXERR0("Unable to remove autosave file `" << oldauto << "'!");
3050 }
3051
3052
3053 // Perfect target for a thread...
3054 void Buffer::autoSave() const
3055 {
3056         if (isBakClean() || isReadonly()) {
3057                 // We don't save now, but we'll try again later
3058                 resetAutosaveTimers();
3059                 return;
3060         }
3061
3062         // emit message signal.
3063         message(_("Autosaving current document..."));
3064         AutoSaveBuffer autosave(*this, getAutosaveFilename());
3065         autosave.start();
3066
3067         markBakClean();
3068         resetAutosaveTimers();
3069 }
3070
3071
3072 string Buffer::bufferFormat() const
3073 {
3074         string format = params().documentClass().outputFormat();
3075         if (format == "latex") {
3076                 if (params().useXetex)
3077                         return "xetex";
3078                 if (params().encoding().package() == Encoding::japanese)
3079                         return "platex";
3080         }
3081         return format;
3082 }
3083
3084
3085 string Buffer::getDefaultOutputFormat() const
3086 {
3087         if (!params().defaultOutputFormat.empty()
3088             && params().defaultOutputFormat != "default")
3089                 return params().defaultOutputFormat;
3090         typedef vector<Format const *> Formats;
3091         Formats formats = exportableFormats(true);
3092         if (isDocBook()
3093             || isLiterate()
3094             || params().useXetex
3095             || params().encoding().package() == Encoding::japanese) {
3096                 if (formats.empty())
3097                         return string();
3098                 // return the first we find
3099                 return formats.front()->name();
3100         }
3101         return lyxrc.default_view_format;
3102 }
3103
3104
3105
3106 bool Buffer::doExport(string const & format, bool put_in_tempdir,
3107         string & result_file) const
3108 {
3109         string backend_format;
3110         OutputParams runparams(&params().encoding());
3111         runparams.flavor = OutputParams::LATEX;
3112         runparams.linelen = lyxrc.plaintext_linelen;
3113         vector<string> backs = backends();
3114         if (find(backs.begin(), backs.end(), format) == backs.end()) {
3115                 // Get shortest path to format
3116                 Graph::EdgePath path;
3117                 for (vector<string>::const_iterator it = backs.begin();
3118                      it != backs.end(); ++it) {
3119                         Graph::EdgePath p = theConverters().getPath(*it, format);
3120                         if (!p.empty() && (path.empty() || p.size() < path.size())) {
3121                                 backend_format = *it;
3122                                 path = p;
3123                         }
3124                 }
3125                 if (!path.empty())
3126                         runparams.flavor = theConverters().getFlavor(path);
3127                 else {
3128                         Alert::error(_("Couldn't export file"),
3129                                 bformat(_("No information for exporting the format %1$s."),
3130                                    formats.prettyName(format)));
3131                         return false;
3132                 }
3133         } else {
3134                 backend_format = format;
3135                 // FIXME: Don't hardcode format names here, but use a flag
3136                 if (backend_format == "pdflatex")
3137                         runparams.flavor = OutputParams::PDFLATEX;
3138         }
3139
3140         string filename = latexName(false);
3141         filename = addName(temppath(), filename);
3142         filename = changeExtension(filename,
3143                                    formats.extension(backend_format));
3144
3145         // fix macros
3146         updateMacroInstances();
3147
3148         // Plain text backend
3149         if (backend_format == "text") {
3150                 runparams.flavor = OutputParams::TEXT;
3151                 writePlaintextFile(*this, FileName(filename), runparams);
3152         }
3153         // HTML backend
3154         else if (backend_format == "xhtml") {
3155                 runparams.flavor = OutputParams::HTML;
3156                 makeLyXHTMLFile(FileName(filename), runparams);
3157         }       else if (backend_format == "lyx")
3158                 writeFile(FileName(filename));
3159         // Docbook backend
3160         else if (isDocBook()) {
3161                 runparams.nice = !put_in_tempdir;
3162                 makeDocBookFile(FileName(filename), runparams);
3163         }
3164         // LaTeX backend
3165         else if (backend_format == format) {
3166                 runparams.nice = true;
3167                 if (!makeLaTeXFile(FileName(filename), string(), runparams))
3168                         return false;
3169         } else if (!lyxrc.tex_allows_spaces
3170                    && contains(filePath(), ' ')) {
3171                 Alert::error(_("File name error"),
3172                            _("The directory path to the document cannot contain spaces."));
3173                 return false;
3174         } else {
3175                 runparams.nice = false;
3176                 if (!makeLaTeXFile(FileName(filename), filePath(), runparams))
3177                         return false;
3178         }
3179
3180         string const error_type = (format == "program")
3181                 ? "Build" : bufferFormat();
3182         ErrorList & error_list = d->errorLists[error_type];
3183         string const ext = formats.extension(format);
3184         FileName const tmp_result_file(changeExtension(filename, ext));
3185         bool const success = theConverters().convert(this, FileName(filename),
3186                 tmp_result_file, FileName(absFileName()), backend_format, format,
3187                 error_list);
3188         // Emit the signal to show the error list.
3189         if (format != backend_format) {
3190                 errors(error_type);
3191                 // also to the children, in case of master-buffer-view
3192                 std::vector<Buffer *> clist = getChildren();
3193                 for (vector<Buffer *>::const_iterator cit = clist.begin();
3194                      cit != clist.end(); ++cit)
3195                         (*cit)->errors(error_type, true);
3196         }
3197         if (!success)
3198                 return false;
3199
3200         if (put_in_tempdir) {
3201                 result_file = tmp_result_file.absFilename();
3202                 return true;
3203         }
3204
3205         result_file = changeExtension(exportFileName().absFilename(), ext);
3206         // We need to copy referenced files (e. g. included graphics
3207         // if format == "dvi") to the result dir.
3208         vector<ExportedFile> const files =
3209                 runparams.exportdata->externalFiles(format);
3210         string const dest = onlyPath(result_file);
3211         CopyStatus status = SUCCESS;
3212         for (vector<ExportedFile>::const_iterator it = files.begin();
3213                 it != files.end() && status != CANCEL; ++it) {
3214                 string const fmt = formats.getFormatFromFile(it->sourceName);
3215                 status = copyFile(fmt, it->sourceName,
3216                         makeAbsPath(it->exportName, dest),
3217                         it->exportName, status == FORCE);
3218         }
3219         if (status == CANCEL) {
3220                 message(_("Document export cancelled."));
3221         } else if (tmp_result_file.exists()) {
3222                 // Finally copy the main file
3223                 status = copyFile(format, tmp_result_file,
3224                         FileName(result_file), result_file,
3225                         status == FORCE);
3226                 message(bformat(_("Document exported as %1$s "
3227                         "to file `%2$s'"),
3228                         formats.prettyName(format),
3229                         makeDisplayPath(result_file)));
3230         } else {
3231                 // This must be a dummy converter like fax (bug 1888)
3232                 message(bformat(_("Document exported as %1$s"),
3233                         formats.prettyName(format)));
3234         }
3235
3236         return true;
3237 }
3238
3239
3240 bool Buffer::doExport(string const & format, bool put_in_tempdir) const
3241 {
3242         string result_file;
3243         return doExport(format, put_in_tempdir, result_file);
3244 }
3245
3246
3247 bool Buffer::preview(string const & format) const
3248 {
3249         string result_file;
3250         if (!doExport(format, true, result_file))
3251                 return false;
3252         return formats.view(*this, FileName(result_file), format);
3253 }
3254
3255
3256 bool Buffer::isExportable(string const & format) const
3257 {
3258         vector<string> backs = backends();
3259         for (vector<string>::const_iterator it = backs.begin();
3260              it != backs.end(); ++it)
3261                 if (theConverters().isReachable(*it, format))
3262                         return true;
3263         return false;
3264 }
3265
3266
3267 vector<Format const *> Buffer::exportableFormats(bool only_viewable) const
3268 {
3269         vector<string> const backs = backends();
3270         vector<Format const *> result =
3271                 theConverters().getReachable(backs[0], only_viewable, true);
3272         for (vector<string>::const_iterator it = backs.begin() + 1;
3273              it != backs.end(); ++it) {
3274                 vector<Format const *>  r =
3275                         theConverters().getReachable(*it, only_viewable, false);
3276                 result.insert(result.end(), r.begin(), r.end());
3277         }
3278         return result;
3279 }
3280
3281
3282 vector<string> Buffer::backends() const
3283 {
3284         vector<string> v;
3285         v.push_back(bufferFormat());
3286         // FIXME: Don't hardcode format names here, but use a flag
3287         if (v.back() == "latex")
3288                 v.push_back("pdflatex");
3289         v.push_back("xhtml");
3290         v.push_back("text");
3291         v.push_back("lyx");
3292         return v;
3293 }
3294
3295
3296 bool Buffer::readFileHelper(FileName const & s)
3297 {
3298         // File information about normal file
3299         if (!s.exists()) {
3300                 docstring const file = makeDisplayPath(s.absFilename(), 50);
3301                 docstring text = bformat(_("The specified document\n%1$s"
3302                                                      "\ncould not be read."), file);
3303                 Alert::error(_("Could not read document"), text);
3304                 return false;
3305         }
3306
3307         // Check if emergency save file exists and is newer.
3308         FileName const e(s.absFilename() + ".emergency");
3309
3310         if (e.exists() && s.exists() && e.lastModified() > s.lastModified()) {
3311                 docstring const file = makeDisplayPath(s.absFilename(), 20);
3312                 docstring const text =
3313                         bformat(_("An emergency save of the document "
3314                                   "%1$s exists.\n\n"
3315                                                "Recover emergency save?"), file);
3316                 switch (Alert::prompt(_("Load emergency save?"), text, 0, 2,
3317                                       _("&Recover"),  _("&Load Original"),
3318                                       _("&Cancel")))
3319                 {
3320                 case 0: {
3321                         // the file is not saved if we load the emergency file.
3322                         markDirty();
3323                         docstring str;
3324                         bool res;
3325
3326                         if ((res = readFile(e)) == success)
3327                                 str = _("Document was successfully recovered.");
3328                         else
3329                                 str = _("Document was NOT successfully recovered.");
3330                         str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
3331                                                 from_utf8(e.absFilename()));
3332
3333                         if (!Alert::prompt(_("Delete emergency file?"), str, 1, 1,
3334                                         _("&Remove"), _("&Keep it"))) {
3335                                 e.removeFile();
3336                                 if (res == success)
3337                                         Alert::warning(_("Emergency file deleted"),
3338                                                 _("Do not forget to save your file now!"), true);
3339                                 }
3340                         return res;
3341                 }
3342                 case 1:
3343                         if (!Alert::prompt(_("Delete emergency file?"),
3344                                         _("Remove emergency file now?"), 1, 1,
3345                                         _("&Remove"), _("&Keep it")))
3346                                 e.removeFile();
3347                         break;
3348                 default:
3349                         return false;
3350                 }
3351         }
3352
3353         // Now check if autosave file is newer.
3354         FileName const a(onlyPath(s.absFilename()) + '#' + onlyFilename(s.absFilename()) + '#');
3355
3356         if (a.exists() && s.exists() && a.lastModified() > s.lastModified()) {
3357                 docstring const file = makeDisplayPath(s.absFilename(), 20);
3358                 docstring const text =
3359                         bformat(_("The backup of the document "
3360                                   "%1$s is newer.\n\nLoad the "
3361                                                "backup instead?"), file);
3362                 switch (Alert::prompt(_("Load backup?"), text, 0, 2,
3363                                       _("&Load backup"), _("Load &original"),
3364                                       _("&Cancel") ))
3365                 {
3366                 case 0:
3367                         // the file is not saved if we load the autosave file.
3368                         markDirty();
3369                         return readFile(a);
3370                 case 1:
3371                         // Here we delete the autosave
3372                         a.removeFile();
3373                         break;
3374                 default:
3375                         return false;
3376                 }
3377         }
3378         return readFile(s);
3379 }
3380
3381
3382 bool Buffer::loadLyXFile(FileName const & s)
3383 {
3384         if (s.isReadableFile()) {
3385                 if (readFileHelper(s)) {
3386                         lyxvc().file_found_hook(s);
3387                         if (!s.isWritable())
3388                                 setReadonly(true);
3389                         return true;
3390                 }
3391         } else {
3392                 docstring const file = makeDisplayPath(s.absFilename(), 20);
3393                 // Here we probably should run
3394                 if (LyXVC::file_not_found_hook(s)) {
3395                         docstring const text =
3396                                 bformat(_("Do you want to retrieve the document"
3397                                                        " %1$s from version control?"), file);
3398                         int const ret = Alert::prompt(_("Retrieve from version control?"),
3399                                 text, 0, 1, _("&Retrieve"), _("&Cancel"));
3400
3401                         if (ret == 0) {
3402                                 // How can we know _how_ to do the checkout?
3403                                 // With the current VC support it has to be,
3404                                 // a RCS file since CVS do not have special ,v files.
3405                                 RCS::retrieve(s);
3406                                 return loadLyXFile(s);
3407                         }
3408                 }
3409         }
3410         return false;
3411 }
3412
3413
3414 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
3415 {
3416         TeXErrors::Errors::const_iterator cit = terr.begin();
3417         TeXErrors::Errors::const_iterator end = terr.end();
3418
3419         for (; cit != end; ++cit) {
3420                 int id_start = -1;
3421                 int pos_start = -1;
3422                 int errorRow = cit->error_in_line;
3423                 bool found = d->texrow.getIdFromRow(errorRow, id_start,
3424                                                        pos_start);
3425                 int id_end = -1;
3426                 int pos_end = -1;
3427                 do {
3428                         ++errorRow;
3429                         found = d->texrow.getIdFromRow(errorRow, id_end, pos_end);
3430                 } while (found && id_start == id_end && pos_start == pos_end);
3431
3432                 errorList.push_back(ErrorItem(cit->error_desc,
3433                         cit->error_text, id_start, pos_start, pos_end));
3434         }
3435 }
3436
3437
3438 void Buffer::setBuffersForInsets() const
3439 {
3440         inset().setBuffer(const_cast<Buffer &>(*this));
3441 }
3442
3443
3444 void Buffer::updateLabels(UpdateScope scope) const
3445 {
3446         // Use the master text class also for child documents
3447         Buffer const * const master = masterBuffer();
3448         DocumentClass const & textclass = master->params().documentClass();
3449
3450         // keep the buffers to be children in this set. If the call from the
3451         // master comes back we can see which of them were actually seen (i.e.
3452         // via an InsetInclude). The remaining ones in the set need still be updated.
3453         static std::set<Buffer const *> bufToUpdate;
3454         if (scope == UpdateMaster) {
3455                 // If this is a child document start with the master
3456                 if (master != this) {
3457                         bufToUpdate.insert(this);
3458                         master->updateLabels();
3459                         // Do this here in case the master has no gui associated with it. Then,
3460                         // the TocModel is not updated and TocModel::toc_ is invalid (bug 5699).
3461                         if (!master->gui_)
3462                                 structureChanged();
3463
3464                         // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
3465                         if (bufToUpdate.find(this) == bufToUpdate.end())
3466                                 return;
3467                 }
3468
3469                 // start over the counters in the master
3470                 textclass.counters().reset();
3471         }
3472
3473         // update will be done below for this buffer
3474         bufToUpdate.erase(this);
3475
3476         // update all caches
3477         clearReferenceCache();
3478         updateMacros();
3479
3480         Buffer & cbuf = const_cast<Buffer &>(*this);
3481
3482         LASSERT(!text().paragraphs().empty(), /**/);
3483
3484         // do the real work
3485         ParIterator parit = cbuf.par_iterator_begin();
3486         updateLabels(parit);
3487
3488         if (master != this)
3489                 // TocBackend update will be done later.
3490                 return;
3491
3492         cbuf.tocBackend().update();
3493         if (scope == UpdateMaster)
3494                 cbuf.structureChanged();
3495 }
3496
3497
3498 static depth_type getDepth(DocIterator const & it)
3499 {
3500         depth_type depth = 0;
3501         for (size_t i = 0 ; i < it.depth() ; ++i)
3502                 if (!it[i].inset().inMathed())
3503                         depth += it[i].paragraph().getDepth() + 1;
3504         // remove 1 since the outer inset does not count
3505         return depth - 1;
3506 }
3507
3508 static depth_type getItemDepth(ParIterator const & it)
3509 {
3510         Paragraph const & par = *it;
3511         LabelType const labeltype = par.layout().labeltype;
3512
3513         if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
3514                 return 0;
3515
3516         // this will hold the lowest depth encountered up to now.
3517         depth_type min_depth = getDepth(it);
3518         ParIterator prev_it = it;
3519         while (true) {
3520                 if (prev_it.pit())
3521                         --prev_it.top().pit();
3522                 else {
3523                         // start of nested inset: go to outer par
3524                         prev_it.pop_back();
3525                         if (prev_it.empty()) {
3526                                 // start of document: nothing to do
3527                                 return 0;
3528                         }
3529                 }
3530
3531                 // We search for the first paragraph with same label
3532                 // that is not more deeply nested.
3533                 Paragraph & prev_par = *prev_it;
3534                 depth_type const prev_depth = getDepth(prev_it);
3535                 if (labeltype == prev_par.layout().labeltype) {
3536                         if (prev_depth < min_depth)
3537                                 return prev_par.itemdepth + 1;
3538                         if (prev_depth == min_depth)
3539                                 return prev_par.itemdepth;
3540                 }
3541                 min_depth = min(min_depth, prev_depth);
3542                 // small optimization: if we are at depth 0, we won't
3543                 // find anything else
3544                 if (prev_depth == 0)
3545                         return 0;
3546         }
3547 }
3548
3549
3550 static bool needEnumCounterReset(ParIterator const & it)
3551 {
3552         Paragraph const & par = *it;
3553         LASSERT(par.layout().labeltype == LABEL_ENUMERATE, /**/);
3554         depth_type const cur_depth = par.getDepth();
3555         ParIterator prev_it = it;
3556         while (prev_it.pit()) {
3557                 --prev_it.top().pit();
3558                 Paragraph const & prev_par = *prev_it;
3559                 if (prev_par.getDepth() <= cur_depth)
3560                         return  prev_par.layout().labeltype != LABEL_ENUMERATE;
3561         }
3562         // start of nested inset: reset
3563         return true;
3564 }
3565
3566
3567 // set the label of a paragraph. This includes the counters.
3568 void Buffer::setLabel(ParIterator & it) const
3569 {
3570         BufferParams const & bp = this->masterBuffer()->params();
3571         DocumentClass const & textclass = bp.documentClass();
3572         Paragraph & par = it.paragraph();
3573         Layout const & layout = par.layout();
3574         Counters & counters = textclass.counters();
3575
3576         if (par.params().startOfAppendix()) {
3577                 // FIXME: only the counter corresponding to toplevel
3578                 // sectionning should be reset
3579                 counters.reset();
3580                 counters.appendix(true);
3581         }
3582         par.params().appendix(counters.appendix());
3583
3584         // Compute the item depth of the paragraph
3585         par.itemdepth = getItemDepth(it);
3586
3587         if (layout.margintype == MARGIN_MANUAL
3588             || layout.latextype == LATEX_BIB_ENVIRONMENT) {
3589                 if (par.params().labelWidthString().empty())
3590                         par.params().labelWidthString(par.expandLabel(layout, bp));
3591         } else {
3592                 par.params().labelWidthString(docstring());
3593         }
3594
3595         switch(layout.labeltype) {
3596         case LABEL_COUNTER:
3597                 if (layout.toclevel <= bp.secnumdepth
3598                     && (layout.latextype != LATEX_ENVIRONMENT
3599                         || it.text()->isFirstInSequence(it.pit()))) {
3600                         counters.step(layout.counter);
3601                         par.params().labelString(
3602                                 par.expandLabel(layout, bp));
3603                 } else
3604                         par.params().labelString(docstring());
3605                 break;
3606
3607         case LABEL_ITEMIZE: {
3608                 // At some point of time we should do something more
3609                 // clever here, like:
3610                 //   par.params().labelString(
3611                 //    bp.user_defined_bullet(par.itemdepth).getText());
3612                 // for now, use a simple hardcoded label
3613                 docstring itemlabel;
3614                 switch (par.itemdepth) {
3615                 case 0:
3616                         itemlabel = char_type(0x2022);
3617                         break;
3618                 case 1:
3619                         itemlabel = char_type(0x2013);
3620                         break;
3621                 case 2:
3622                         itemlabel = char_type(0x2217);
3623                         break;
3624                 case 3:
3625                         itemlabel = char_type(0x2219); // or 0x00b7
3626                         break;
3627                 }
3628                 par.params().labelString(itemlabel);
3629                 break;
3630         }
3631
3632         case LABEL_ENUMERATE: {
3633                 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
3634
3635                 switch (par.itemdepth) {
3636                 case 2:
3637                         enumcounter += 'i';
3638                 case 1:
3639                         enumcounter += 'i';
3640                 case 0:
3641                         enumcounter += 'i';
3642                         break;
3643                 case 3:
3644                         enumcounter += "iv";
3645                         break;
3646                 default:
3647                         // not a valid enumdepth...
3648                         break;
3649                 }
3650
3651                 // Maybe we have to reset the enumeration counter.
3652                 if (needEnumCounterReset(it))
3653                         counters.reset(enumcounter);
3654                 counters.step(enumcounter);
3655
3656                 string const & lang = par.getParLanguage(bp)->code();
3657                 par.params().labelString(counters.theCounter(enumcounter, lang));
3658
3659                 break;
3660         }
3661
3662         case LABEL_SENSITIVE: {
3663                 string const & type = counters.current_float();
3664                 docstring full_label;
3665                 if (type.empty())
3666                         full_label = this->B_("Senseless!!! ");
3667                 else {
3668                         docstring name = this->B_(textclass.floats().getType(type).name());
3669                         if (counters.hasCounter(from_utf8(type))) {
3670                                 string const & lang = par.getParLanguage(bp)->code();
3671                                 counters.step(from_utf8(type));
3672                                 full_label = bformat(from_ascii("%1$s %2$s:"),
3673                                                      name,
3674                                                      counters.theCounter(from_utf8(type), lang));
3675                         } else
3676                                 full_label = bformat(from_ascii("%1$s #:"), name);
3677                 }
3678                 par.params().labelString(full_label);
3679                 break;
3680         }
3681
3682         case LABEL_NO_LABEL:
3683                 par.params().labelString(docstring());
3684                 break;
3685
3686         case LABEL_MANUAL:
3687         case LABEL_TOP_ENVIRONMENT:
3688         case LABEL_CENTERED_TOP_ENVIRONMENT:
3689         case LABEL_STATIC:
3690         case LABEL_BIBLIO:
3691                 par.params().labelString(par.expandLabel(layout, bp));
3692                 break;
3693         }
3694 }
3695
3696
3697 void Buffer::updateLabels(ParIterator & parit) const
3698 {
3699         LASSERT(parit.pit() == 0, /**/);
3700
3701         // set the position of the text in the buffer to be able
3702         // to resolve macros in it. This has nothing to do with
3703         // labels, but by putting it here we avoid implementing
3704         // a whole bunch of traversal routines just for this call.
3705         parit.text()->setMacrocontextPosition(parit);
3706
3707         depth_type maxdepth = 0;
3708         pit_type const lastpit = parit.lastpit();
3709         for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
3710                 // reduce depth if necessary
3711                 parit->params().depth(min(parit->params().depth(), maxdepth));
3712                 maxdepth = parit->getMaxDepthAfter();
3713
3714                 // set the counter for this paragraph
3715                 setLabel(parit);
3716
3717                 // Now the insets
3718                 InsetList::const_iterator iit = parit->insetList().begin();
3719                 InsetList::const_iterator end = parit->insetList().end();
3720                 for (; iit != end; ++iit) {
3721                         parit.pos() = iit->pos;
3722                         iit->inset->updateLabels(parit);
3723                 }
3724         }
3725 }
3726
3727
3728 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
3729         WordLangTuple & word_lang, docstring_list & suggestions) const
3730 {
3731         int progress = 0;
3732         WordLangTuple wl;
3733         suggestions.clear();
3734         word_lang = WordLangTuple();
3735         // OK, we start from here.
3736         DocIterator const end = doc_iterator_end(this);
3737         for (; from != end; from.forwardPos()) {
3738                 // We are only interested in text so remove the math CursorSlice.
3739                 while (from.inMathed())
3740                         from.forwardInset();
3741                 to = from;
3742                 if (from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions)) {
3743                         word_lang = wl;
3744                         break;
3745                 }
3746                 from = to;
3747                 ++progress;
3748         }
3749         return progress;
3750 }
3751
3752 } // namespace lyx