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