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