src/buffer.C

   1 /**
   2  * \file buffer.C
   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  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "buffer.h"
  14
  15 #include "author.h"
  16 #include "buffer_funcs.h"
  17 #include "bufferlist.h"
  18 #include "bufferparams.h"
  19 #include "counters.h"
  20 #include "Bullet.h"
  21 #include "Chktex.h"
  22 #include "debug.h"
  23 #include "errorlist.h"
  24 #include "exporter.h"
  25 #include "format.h"
  26 #include "funcrequest.h"
  27 #include "gettext.h"
  28 #include "insetiterator.h"
  29 #include "language.h"
  30 #include "LaTeX.h"
  31 #include "LaTeXFeatures.h"
  32 #include "LyXAction.h"
  33 #include "lyxlex.h"
  34 #include "lyxtext.h"
  35 #include "lyxrc.h"
  36 #include "lyxvc.h"
  37 #include "lyx_main.h"
  38 #include "messages.h"
  39 #include "output.h"
  40 #include "output_docbook.h"
  41 #include "output_latex.h"
  42 #include "output_linuxdoc.h"
  43 #include "paragraph.h"
  44 #include "paragraph_funcs.h"
  45 #include "ParagraphParameters.h"
  46 #include "pariterator.h"
  47 #include "sgml.h"
  48 #include "texrow.h"
  49 #include "undo.h"
  50 #include "version.h"
  51
  52 #include "insets/insetbibitem.h"
  53 #include "insets/insetbibtex.h"
  54 #include "insets/insetinclude.h"
  55 #include "insets/insettext.h"
  56
  57 #include "mathed/math_macrotemplate.h"
  58 #include "mathed/math_macrotable.h"
  59 #include "mathed/math_support.h"
  60
  61 #include "frontends/Alert.h"
  62
  63 #include "graphics/Previews.h"
  64
  65 #include "support/FileInfo.h"
  66 #include "support/filetools.h"
  67 #include "support/gzstream.h"
  68 #include "support/lyxlib.h"
  69 #include "support/os.h"
  70 #include "support/path.h"
  71 #include "support/textutils.h"
  72 #include "support/tostr.h"
  73 #include "support/std_sstream.h"
  74
  75 #include <boost/bind.hpp>
  76
  77 #include <iomanip>
  78 #include <stack>
  79
  80 #include <utime.h>
  81
  82 using lyx::pos_type;
  83 using lyx::par_type;
  84
  85 using lyx::support::AddName;
  86 using lyx::support::atoi;
  87 using lyx::support::bformat;
  88 using lyx::support::ChangeExtension;
  89 using lyx::support::cmd_ret;
  90 using lyx::support::createBufferTmpDir;
  91 using lyx::support::destroyDir;
  92 using lyx::support::FileInfo;
  93 using lyx::support::FileInfo;
  94 using lyx::support::getExtFromContents;
  95 using lyx::support::IsDirWriteable;
  96 using lyx::support::IsFileWriteable;
  97 using lyx::support::LibFileSearch;
  98 using lyx::support::ltrim;
  99 using lyx::support::MakeAbsPath;
 100 using lyx::support::MakeDisplayPath;
 101 using lyx::support::MakeLatexName;
 102 using lyx::support::OnlyFilename;
 103 using lyx::support::OnlyPath;
 104 using lyx::support::Path;
 105 using lyx::support::QuoteName;
 106 using lyx::support::removeAutosaveFile;
 107 using lyx::support::rename;
 108 using lyx::support::RunCommand;
 109 using lyx::support::split;
 110 using lyx::support::strToInt;
 111 using lyx::support::subst;
 112 using lyx::support::tempName;
 113 using lyx::support::trim;
 114
 115 namespace os = lyx::support::os;
 116
 117 using std::endl;
 118 using std::for_each;
 119 using std::make_pair;
 120
 121 using std::ifstream;
 122 using std::ios;
 123 using std::map;
 124 using std::ostream;
 125 using std::ostringstream;
 126 using std::ofstream;
 127 using std::pair;
 128 using std::stack;
 129 using std::vector;
 130 using std::string;
 131
 132
 133 // all these externs should eventually be removed.
 134 extern BufferList bufferlist;
 135
 136 namespace {
 137
 138 const int LYX_FORMAT = 232;
 139
 140 } // namespace anon
 141
 142
 143 typedef std::map<string, bool> DepClean;
 144
 145 struct Buffer::Impl
 146 {
 147         Impl(Buffer & parent, string const & file, bool readonly);
 148
 149         limited_stack<Undo> undostack;
 150         limited_stack<Undo> redostack;
 151         BufferParams params;
 152         LyXVC lyxvc;
 153         string temppath;
 154         TexRow texrow;
 155
 156         /// need to regenerate .tex?
 157         DepClean dep_clean;
 158
 159         /// is save needed?
 160         mutable bool lyx_clean;
 161
 162         /// is autosave needed?
 163         mutable bool bak_clean;
 164
 165         /// is this a unnamed file (New...)?
 166         bool unnamed;
 167
 168         /// buffer is r/o
 169         bool read_only;
 170
 171         /// name of the file the buffer is associated with.
 172         string filename;
 173
 174         /// The path to the document file.
 175         string filepath;
 176
 177         boost::scoped_ptr<Messages> messages;
 178
 179         /** Set to true only when the file is fully loaded.
 180          *  Used to prevent the premature generation of previews
 181          *  and by the citation inset.
 182          */
 183         bool file_fully_loaded;
 184
 185         /// our LyXText that should be wrapped in an InsetText
 186         InsetText inset;
 187
 188         ///
 189         MacroTable macros;
 190 };
 191
 192
 193 Buffer::Impl::Impl(Buffer & parent, string const & file, bool readonly_)
 194         : lyx_clean(true), bak_clean(true), unnamed(false), read_only(readonly_),
 195           filename(file), filepath(OnlyPath(file)), file_fully_loaded(false),
 196                 inset(params)
 197 {
 198         lyxvc.buffer(&parent);
 199         temppath = createBufferTmpDir();
 200         // FIXME: And now do something if temppath == string(), because we
 201         // assume from now on that temppath points to a valid temp dir.
 202         // See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg67406.html
 203 }
 204
 205
 206 Buffer::Buffer(string const & file, bool ronly)
 207         : pimpl_(new Impl(*this, file, ronly))
 208 {
 209         lyxerr[Debug::INFO] << "Buffer::Buffer()" << endl;
 210 }
 211
 212
 213 Buffer::~Buffer()
 214 {
 215         lyxerr[Debug::INFO] << "Buffer::~Buffer()" << endl;
 216         // here the buffer should take care that it is
 217         // saved properly, before it goes into the void.
 218
 219         closing();
 220
 221         if (!temppath().empty() && destroyDir(temppath()) != 0) {
 222                 Alert::warning(_("Could not remove temporary directory"),
 223                         bformat(_("Could not remove the temporary directory %1$s"), temppath()));
 224         }
 225
 226         // Remove any previewed LaTeX snippets associated with this buffer.
 227         lyx::graphics::Previews::get().removeLoader(*this);
 228 }
 229
 230
 231 LyXText & Buffer::text() const
 232 {
 233         return const_cast<LyXText &>(pimpl_->inset.text_);
 234 }
 235
 236
 237 InsetBase & Buffer::inset() const
 238 {
 239         return const_cast<InsetText &>(pimpl_->inset);
 240 }
 241
 242
 243 limited_stack<Undo> & Buffer::undostack()
 244 {
 245         return pimpl_->undostack;
 246 }
 247
 248
 249 limited_stack<Undo> const & Buffer::undostack() const
 250 {
 251         return pimpl_->undostack;
 252 }
 253
 254
 255 limited_stack<Undo> & Buffer::redostack()
 256 {
 257         return pimpl_->redostack;
 258 }
 259
 260
 261 limited_stack<Undo> const & Buffer::redostack() const
 262 {
 263         return pimpl_->redostack;
 264 }
 265
 266
 267 BufferParams & Buffer::params()
 268 {
 269         return pimpl_->params;
 270 }
 271
 272
 273 BufferParams const & Buffer::params() const
 274 {
 275         return pimpl_->params;
 276 }
 277
 278
 279 ParagraphList & Buffer::paragraphs()
 280 {
 281         return text().paragraphs();
 282 }
 283
 284
 285 ParagraphList const & Buffer::paragraphs() const
 286 {
 287         return text().paragraphs();
 288 }
 289
 290
 291 LyXVC & Buffer::lyxvc()
 292 {
 293         return pimpl_->lyxvc;
 294 }
 295
 296
 297 LyXVC const & Buffer::lyxvc() const
 298 {
 299         return pimpl_->lyxvc;
 300 }
 301
 302
 303 string const & Buffer::temppath() const
 304 {
 305         return pimpl_->temppath;
 306 }
 307
 308
 309 TexRow & Buffer::texrow()
 310 {
 311         return pimpl_->texrow;
 312 }
 313
 314
 315 TexRow const & Buffer::texrow() const
 316 {
 317         return pimpl_->texrow;
 318 }
 319
 320
 321 string const Buffer::getLatexName(bool no_path) const
 322 {
 323         string const name = ChangeExtension(MakeLatexName(fileName()), ".tex");
 324         return no_path ? OnlyFilename(name) : name;
 325 }
 326
 327
 328 pair<Buffer::LogType, string> const Buffer::getLogName() const
 329 {
 330         string const filename = getLatexName(false);
 331
 332         if (filename.empty())
 333                 return make_pair(Buffer::latexlog, string());
 334
 335         string const path = temppath();
 336
 337         string const fname = AddName(path,
 338                                      OnlyFilename(ChangeExtension(filename,
 339                                                                   ".log")));
 340         string const bname =
 341                 AddName(path, OnlyFilename(
 342                         ChangeExtension(filename,
 343                                         formats.extension("literate") + ".out")));
 344
 345         // If no Latex log or Build log is newer, show Build log
 346
 347         FileInfo const f_fi(fname);
 348         FileInfo const b_fi(bname);
 349
 350         if (b_fi.exist() &&
 351             (!f_fi.exist() || f_fi.getModificationTime() < b_fi.getModificationTime())) {
 352                 lyxerr[Debug::FILES] << "Log name calculated as: " << bname << endl;
 353                 return make_pair(Buffer::buildlog, bname);
 354         }
 355         lyxerr[Debug::FILES] << "Log name calculated as: " << fname << endl;
 356         return make_pair(Buffer::latexlog, fname);
 357 }
 358
 359
 360 void Buffer::setReadonly(bool flag)
 361 {
 362         if (pimpl_->read_only != flag) {
 363                 pimpl_->read_only = flag;
 364                 readonly(flag);
 365         }
 366 }
 367
 368
 369 void Buffer::setFileName(string const & newfile)
 370 {
 371         pimpl_->filename = MakeAbsPath(newfile);
 372         pimpl_->filepath = OnlyPath(pimpl_->filename);
 373         setReadonly(IsFileWriteable(pimpl_->filename) == 0);
 374         updateTitles();
 375 }
 376
 377
 378 // We'll remove this later. (Lgb)
 379 namespace {
 380
 381 void unknownClass(string const & unknown)
 382 {
 383         Alert::warning(_("Unknown document class"),
 384                 bformat(_("Using the default document class, because the "
 385                         "class %1$s is unknown."), unknown));
 386 }
 387
 388 } // anon
 389
 390
 391 int Buffer::readHeader(LyXLex & lex)
 392 {
 393         int unknown_tokens = 0;
 394
 395         while (lex.isOK()) {
 396                 lex.nextToken();
 397                 string const token = lex.getString();
 398
 399                 if (token.empty())
 400                         continue;
 401
 402                 if (token == "\\end_header")
 403                         break;
 404
 405                 lyxerr[Debug::PARSER] << "Handling header token: `"
 406                                       << token << '\'' << endl;
 407
 408
 409                 string unknown = params().readToken(lex, token);
 410                 if (!unknown.empty()) {
 411                         if (unknown[0] != '\\') {
 412                                 unknownClass(unknown);
 413                         } else {
 414                                 ++unknown_tokens;
 415                                 string const s = bformat(_("Unknown token: "
 416                                                            "%1$s %2$s\n"),
 417                                                          token,
 418                                                          lex.getString());
 419                                 error(ErrorItem(_("Header error"), s,
 420                                                 -1, 0, 0));
 421                         }
 422                 }
 423         }
 424         return unknown_tokens;
 425 }
 426
 427
 428 // Uwe C. Schroeder
 429 // changed to be public and have one parameter
 430 // Returns false if "\end_document" is not read (Asger)
 431 bool Buffer::readBody(LyXLex & lex)
 432 {
 433         if (paragraphs().empty()) {
 434                 readHeader(lex);
 435                 if (!params().getLyXTextClass().load()) {
 436                         string theclass = params().getLyXTextClass().name();
 437                         Alert::error(_("Can't load document class"), bformat(
 438                                         "Using the default document class, because the "
 439                                         " class %1$s could not be loaded.", theclass));
 440                         params().textclass = 0;
 441                 }
 442         } else {
 443                 // We don't want to adopt the parameters from the
 444                 // document we insert, so read them into a temporary buffer
 445                 // and then discard it
 446
 447                 Buffer tmpbuf("", false);
 448                 tmpbuf.readHeader(lex);
 449         }
 450
 451         return text().read(*this, lex);
 452 }
 453
 454
 455 // needed to insert the selection
 456 void Buffer::insertStringAsLines(ParagraphList & pars,
 457         par_type & par, pos_type & pos,
 458         LyXFont const & fn, string const & str)
 459 {
 460         LyXLayout_ptr const & layout = pars[par].layout();
 461
 462         LyXFont font = fn;
 463
 464         pars[par].checkInsertChar(font);
 465         // insert the string, don't insert doublespace
 466         bool space_inserted = true;
 467         bool autobreakrows = pars[par].autoBreakRows();
 468         for (string::const_iterator cit = str.begin();
 469             cit != str.end(); ++cit) {
 470                 if (*cit == '\n') {
 471                         if (autobreakrows && (!pars[par].empty() || pars[par].allowEmpty())) {
 472                                 breakParagraph(params(), paragraphs(), par, pos,
 473                                                layout->isEnvironment());
 474                                 ++par;
 475                                 pos = 0;
 476                                 space_inserted = true;
 477                         } else {
 478                                 continue;
 479                         }
 480                         // do not insert consecutive spaces if !free_spacing
 481                 } else if ((*cit == ' ' || *cit == '\t') &&
 482                            space_inserted && !pars[par].isFreeSpacing()) {
 483                         continue;
 484                 } else if (*cit == '\t') {
 485                         if (!pars[par].isFreeSpacing()) {
 486                                 // tabs are like spaces here
 487                                 pars[par].insertChar(pos, ' ', font);
 488                                 ++pos;
 489                                 space_inserted = true;
 490                         } else {
 491                                 const pos_type n = 8 - pos % 8;
 492                                 for (pos_type i = 0; i < n; ++i) {
 493                                         pars[par].insertChar(pos, ' ', font);
 494                                         ++pos;
 495                                 }
 496                                 space_inserted = true;
 497                         }
 498                 } else if (!IsPrintable(*cit)) {
 499                         // Ignore unprintables
 500                         continue;
 501                 } else {
 502                         // just insert the character
 503                         pars[par].insertChar(pos, *cit, font);
 504                         ++pos;
 505                         space_inserted = (*cit == ' ');
 506                 }
 507
 508         }
 509 }
 510
 511
 512 bool Buffer::readFile(string const & filename)
 513 {
 514         // Check if the file is compressed.
 515         string const format = getExtFromContents(filename);
 516         if (format == "gzip" || format == "zip" || format == "compress") {
 517                 params().compressed = true;
 518         }
 519
 520         // remove dummy empty par
 521         paragraphs().clear();
 522         bool ret = readFile(filename, paragraphs().size());
 523
 524         // After we have read a file, we must ensure that the buffer
 525         // language is set and used in the gui.
 526         // If you know of a better place to put this, please tell me. (Lgb)
 527         updateDocLang(params().language);
 528
 529         return ret;
 530 }
 531
 532
 533 bool Buffer::readFile(string const & filename, par_type pit)
 534 {
 535         LyXLex lex(0, 0);
 536         lex.setFile(filename);
 537         return readFile(lex, filename, pit);
 538 }
 539
 540
 541 bool Buffer::fully_loaded() const
 542 {
 543         return pimpl_->file_fully_loaded;
 544 }
 545
 546
 547 void Buffer::fully_loaded(bool value)
 548 {
 549         pimpl_->file_fully_loaded = value;
 550 }
 551
 552
 553 bool Buffer::readFile(LyXLex & lex, string const & filename, par_type pit)
 554 {
 555         BOOST_ASSERT(!filename.empty());
 556
 557         if (!lex.isOK()) {
 558                 Alert::error(_("Document could not be read"),
 559                              bformat(_("%1$s could not be read."), filename));
 560                 return false;
 561         }
 562
 563         lex.next();
 564         string const token(lex.getString());
 565
 566         if (!lex.isOK()) {
 567                 Alert::error(_("Document could not be read"),
 568                              bformat(_("%1$s could not be read."), filename));
 569                 return false;
 570         }
 571
 572         // the first token _must_ be...
 573         if (token != "\\lyxformat") {
 574                 lyxerr << "Token: " << token << endl;
 575
 576                 Alert::error(_("Document format failure"),
 577                              bformat(_("%1$s is not a LyX document."),
 578                                        filename));
 579                 return false;
 580         }
 581
 582         lex.eatLine();
 583         string tmp_format = lex.getString();
 584         //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
 585         // if present remove ".," from string.
 586         string::size_type dot = tmp_format.find_first_of(".,");
 587         //lyxerr << "           dot found at " << dot << endl;
 588         if (dot != string::npos)
 589                         tmp_format.erase(dot, 1);
 590         int file_format = strToInt(tmp_format);
 591         //lyxerr << "format: " << file_format << endl;
 592
 593         if (file_format > LYX_FORMAT) {
 594                 Alert::warning(_("Document format failure"),
 595                                bformat(_("%1$s was created with a newer"
 596                                          " version of LyX. This is likely to"
 597                                          " cause problems."),
 598                                          filename));
 599         } else if (file_format < LYX_FORMAT) {
 600                 string const tmpfile = tempName();
 601                 if (tmpfile.empty()) {
 602                         Alert::error(_("Conversion failed"),
 603                                      bformat(_("%1$s is from an earlier"
 604                                               " version of LyX, but a temporary"
 605                                               " file for converting it could"
 606                                               " not be created."),
 607                                               filename));
 608                         return false;
 609                 }
 610                 string command = LibFileSearch("lyx2lyx", "lyx2lyx");
 611                 if (command.empty()) {
 612                         Alert::error(_("Conversion script not found"),
 613                                      bformat(_("%1$s is from an earlier"
 614                                                " version of LyX, but the"
 615                                                " conversion script lyx2lyx"
 616                                                " could not be found."),
 617                                                filename));
 618                         return false;
 619                 }
 620                 command += " -t"
 621                         + tostr(LYX_FORMAT)
 622                         + " -o " + tmpfile + ' '
 623                         + QuoteName(filename);
 624                 lyxerr[Debug::INFO] << "Running '"
 625                                     << command << '\''
 626                                     << endl;
 627                 cmd_ret const ret = RunCommand(command);
 628                 if (ret.first != 0) {
 629                         Alert::error(_("Conversion script failed"),
 630                                      bformat(_("%1$s is from an earlier version"
 631                                               " of LyX, but the lyx2lyx script"
 632                                               " failed to convert it."),
 633                                               filename));
 634                         return false;
 635                 } else {
 636                         bool ret = readFile(tmpfile, pit);
 637                         // Do stuff with tmpfile name and buffer name here.
 638                         return ret;
 639                 }
 640
 641         }
 642
 643         bool the_end = readBody(lex);
 644         params().setPaperStuff();
 645
 646 #ifdef WITH_WARNINGS
 647 #warning Look here!
 648 #endif
 649 #if 0
 650         if (token == "\\end_document")
 651                 the_end_read = true;
 652
 653         if (!the_end) {
 654                 Alert::error(_("Document format failure"),
 655                              bformat(_("%1$s ended unexpectedly, which means"
 656                                        " that it is probably corrupted."),
 657                                        filename));
 658         }
 659 #endif
 660         pimpl_->file_fully_loaded = true;
 661         return true;
 662 }
 663
 664
 665 // Should probably be moved to somewhere else: BufferView? LyXView?
 666 bool Buffer::save() const
 667 {
 668         // We don't need autosaves in the immediate future. (Asger)
 669         resetAutosaveTimers();
 670
 671         // make a backup
 672         string s;
 673         if (lyxrc.make_backup) {
 674                 s = fileName() + '~';
 675                 if (!lyxrc.backupdir_path.empty())
 676                         s = AddName(lyxrc.backupdir_path,
 677                                     subst(os::slashify_path(s),'/','!'));
 678
 679                 // Rename is the wrong way of making a backup,
 680                 // this is the correct way.
 681                 /* truss cp fil fil2:
 682                    lstat("LyXVC3.lyx", 0xEFFFF898)                 Err#2 ENOENT
 683                    stat("LyXVC.lyx", 0xEFFFF688)                   = 0
 684                    open("LyXVC.lyx", O_RDONLY)                     = 3
 685                    open("LyXVC3.lyx", O_WRONLY|O_CREAT|O_TRUNC, 0600) = 4
 686                    fstat(4, 0xEFFFF508)                            = 0
 687                    fstat(3, 0xEFFFF508)                            = 0
 688                    read(3, " # T h i s   f i l e   w".., 8192)     = 5579
 689                    write(4, " # T h i s   f i l e   w".., 5579)    = 5579
 690                    read(3, 0xEFFFD4A0, 8192)                       = 0
 691                    close(4)                                        = 0
 692                    close(3)                                        = 0
 693                    chmod("LyXVC3.lyx", 0100644)                    = 0
 694                    lseek(0, 0, SEEK_CUR)                           = 46440
 695                    _exit(0)
 696                 */
 697
 698                 // Should probably have some more error checking here.
 699                 // Doing it this way, also makes the inodes stay the same.
 700                 // This is still not a very good solution, in particular we
 701                 // might loose the owner of the backup.
 702                 FileInfo finfo(fileName());
 703                 if (finfo.exist()) {
 704                         mode_t fmode = finfo.getMode();
 705                         struct utimbuf times = {
 706                                 finfo.getAccessTime(),
 707                                 finfo.getModificationTime() };
 708
 709                         ifstream ifs(fileName().c_str());
 710                         ofstream ofs(s.c_str(), ios::out|ios::trunc);
 711                         if (ifs && ofs) {
 712                                 ofs << ifs.rdbuf();
 713                                 ifs.close();
 714                                 ofs.close();
 715                                 ::chmod(s.c_str(), fmode);
 716
 717                                 if (::utime(s.c_str(), &times)) {
 718                                         lyxerr << "utime error." << endl;
 719                                 }
 720                         } else {
 721                                 lyxerr << "LyX was not able to make "
 722                                         "backup copy. Beware." << endl;
 723                         }
 724                 }
 725         }
 726
 727         if (writeFile(fileName())) {
 728                 markClean();
 729                 removeAutosaveFile(fileName());
 730         } else {
 731                 // Saving failed, so backup is not backup
 732                 if (lyxrc.make_backup)
 733                         rename(s, fileName());
 734                 return false;
 735         }
 736         return true;
 737 }
 738
 739
 740 bool Buffer::writeFile(string const & fname) const
 741 {
 742         if (pimpl_->read_only && fname == fileName())
 743                 return false;
 744
 745         FileInfo finfo(fname);
 746         if (finfo.exist() && !finfo.writable())
 747                 return false;
 748
 749         bool retval;
 750
 751         if (params().compressed) {
 752                 gz::ogzstream ofs(fname.c_str());
 753                 if (!ofs)
 754                         return false;
 755
 756                 retval = do_writeFile(ofs);
 757
 758         } else {
 759                 ofstream ofs(fname.c_str());
 760                 if (!ofs)
 761                         return false;
 762
 763                 retval = do_writeFile(ofs);
 764         }
 765
 766         return retval;
 767 }
 768
 769
 770 bool Buffer::do_writeFile(ostream & ofs) const
 771 {
 772 #ifdef HAVE_LOCALE
 773         // Use the standard "C" locale for file output.
 774         ofs.imbue(std::locale::classic());
 775 #endif
 776
 777         // The top of the file should not be written by params().
 778
 779         // write out a comment in the top of the file
 780         ofs << "#LyX " << lyx_version
 781             << " created this file. For more info see http://www.lyx.org/\n"
 782             << "\\lyxformat " << LYX_FORMAT << "\n";
 783
 784         // now write out the buffer parameters.
 785         params().writeFile(ofs);
 786
 787         ofs << "\\end_header\n";
 788
 789         // write the text
 790         text().write(*this, ofs);
 791
 792         // Write marker that shows file is complete
 793         ofs << "\n\\end_document" << endl;
 794
 795         // Shouldn't really be needed....
 796         //ofs.close();
 797
 798         // how to check if close went ok?
 799         // Following is an attempt... (BE 20001011)
 800
 801         // good() returns false if any error occured, including some
 802         //        formatting error.
 803         // bad()  returns true if something bad happened in the buffer,
 804         //        which should include file system full errors.
 805
 806         bool status = true;
 807         if (!ofs) {
 808                 status = false;
 809                 lyxerr << "File was not closed properly." << endl;
 810         }
 811
 812         return status;
 813 }
 814
 815
 816 void Buffer::makeLaTeXFile(string const & fname,
 817                            string const & original_path,
 818                            OutputParams const & runparams,
 819                            bool output_preamble, bool output_body)
 820 {
 821         lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
 822
 823         ofstream ofs;
 824         if (!openFileWrite(ofs, fname))
 825                 return;
 826
 827         makeLaTeXFile(ofs, original_path,
 828                       runparams, output_preamble, output_body);
 829
 830         ofs.close();
 831         if (ofs.fail())
 832                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
 833 }
 834
 835
 836 void Buffer::makeLaTeXFile(ostream & os,
 837                            string const & original_path,
 838                            OutputParams const & runparams_in,
 839                            bool output_preamble, bool output_body)
 840 {
 841         OutputParams runparams = runparams_in;
 842
 843         // validate the buffer.
 844         lyxerr[Debug::LATEX] << "  Validating buffer..." << endl;
 845         LaTeXFeatures features(*this, params(), runparams.nice);
 846         validate(features);
 847         lyxerr[Debug::LATEX] << "  Buffer validation done." << endl;
 848
 849         texrow().reset();
 850         // The starting paragraph of the coming rows is the
 851         // first paragraph of the document. (Asger)
 852         texrow().start(paragraphs().begin()->id(), 0);
 853
 854         if (output_preamble && runparams.nice) {
 855                 os << "%% LyX " << lyx_version << " created this file.  "
 856                         "For more info, see http://www.lyx.org/.\n"
 857                         "%% Do not edit unless you really know what "
 858                         "you are doing.\n";
 859                 texrow().newline();
 860                 texrow().newline();
 861         }
 862         lyxerr[Debug::INFO] << "lyx header finished" << endl;
 863         // There are a few differences between nice LaTeX and usual files:
 864         // usual is \batchmode and has a
 865         // special input@path to allow the including of figures
 866         // with either \input or \includegraphics (what figinsets do).
 867         // input@path is set when the actual parameter
 868         // original_path is set. This is done for usual tex-file, but not
 869         // for nice-latex-file. (Matthias 250696)
 870         // Note that input@path is only needed for something the user does
 871         // in the preamble, included .tex files or ERT, files included by
 872         // LyX work without it.
 873         if (output_preamble) {
 874                 if (!runparams.nice) {
 875                         // code for usual, NOT nice-latex-file
 876                         os << "\\batchmode\n"; // changed
 877                         // from \nonstopmode
 878                         texrow().newline();
 879                 }
 880                 if (!original_path.empty()) {
 881                         string inputpath = os::external_path(original_path);
 882                         subst(inputpath, "~", "\\string~");
 883                         os << "\\makeatletter\n"
 884                             << "\\def\\input@path{{"
 885                             << inputpath << "/}}\n"
 886                             << "\\makeatother\n";
 887                         texrow().newline();
 888                         texrow().newline();
 889                         texrow().newline();
 890                 }
 891
 892                 // Write the preamble
 893                 runparams.use_babel = params().writeLaTeX(os, features, texrow());
 894
 895                 if (!output_body)
 896                         return;
 897
 898                 // make the body.
 899                 os << "\\begin{document}\n";
 900                 texrow().newline();
 901         } // output_preamble
 902         lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
 903
 904         if (!lyxrc.language_auto_begin) {
 905                 os << subst(lyxrc.language_command_begin, "$$lang",
 906                              params().language->babel())
 907                     << endl;
 908                 texrow().newline();
 909         }
 910
 911         // if we are doing a real file with body, even if this is the
 912         // child of some other buffer, let's cut the link here.
 913         // This happens for example if only a child document is printed.
 914         string save_parentname;
 915         if (output_preamble) {
 916                 save_parentname = params().parentname;
 917                 params().parentname.erase();
 918         }
 919
 920         // the real stuff
 921         latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
 922
 923         // Restore the parenthood if needed
 924         if (output_preamble)
 925                 params().parentname = save_parentname;
 926
 927         // add this just in case after all the paragraphs
 928         os << endl;
 929         texrow().newline();
 930
 931         if (!lyxrc.language_auto_end) {
 932                 os << subst(lyxrc.language_command_end, "$$lang",
 933                              params().language->babel())
 934                     << endl;
 935                 texrow().newline();
 936         }
 937
 938         if (output_preamble) {
 939                 os << "\\end{document}\n";
 940                 texrow().newline();
 941
 942                 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
 943         } else {
 944                 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
 945                                      << endl;
 946         }
 947
 948         // Just to be sure. (Asger)
 949         texrow().newline();
 950
 951         lyxerr[Debug::INFO] << "Finished making LaTeX file." << endl;
 952         lyxerr[Debug::INFO] << "Row count was " << texrow().rows() - 1
 953                             << '.' << endl;
 954 }
 955
 956
 957 bool Buffer::isLatex() const
 958 {
 959         return params().getLyXTextClass().outputType() == LATEX;
 960 }
 961
 962
 963 bool Buffer::isLinuxDoc() const
 964 {
 965         return params().getLyXTextClass().outputType() == LINUXDOC;
 966 }
 967
 968
 969 bool Buffer::isLiterate() const
 970 {
 971         return params().getLyXTextClass().outputType() == LITERATE;
 972 }
 973
 974
 975 bool Buffer::isDocBook() const
 976 {
 977         return params().getLyXTextClass().outputType() == DOCBOOK;
 978 }
 979
 980
 981 bool Buffer::isSGML() const
 982 {
 983         LyXTextClass const & tclass = params().getLyXTextClass();
 984
 985         return tclass.outputType() == LINUXDOC ||
 986                tclass.outputType() == DOCBOOK;
 987 }
 988
 989
 990 void Buffer::makeLinuxDocFile(string const & fname,
 991                               OutputParams const & runparams,
 992                               bool body_only)
 993 {
 994         ofstream ofs;
 995         if (!openFileWrite(ofs, fname))
 996                 return;
 997
 998         LaTeXFeatures features(*this, params(), runparams.nice);
 999         validate(features);
1000
1001         texrow().reset();
1002
1003         LyXTextClass const & tclass = params().getLyXTextClass();
1004
1005         string top_element = tclass.latexname();
1006
1007         if (!body_only) {
1008                 ofs << tclass.class_header();
1009
1010                 string preamble = params().preamble;
1011                 string const name = runparams.nice ? ChangeExtension(pimpl_->filename, ".sgml")
1012                          : fname;
1013                 preamble += features.getIncludedFiles(name);
1014                 preamble += features.getLyXSGMLEntities();
1015
1016                 if (!preamble.empty()) {
1017                         ofs << " [ " << preamble << " ]";
1018                 }
1019                 ofs << ">\n\n";
1020
1021                 if (params().options.empty())
1022                         sgml::openTag(ofs, 0, false, top_element);
1023                 else {
1024                         string top = top_element;
1025                         top += ' ';
1026                         top += params().options;
1027                         sgml::openTag(ofs, 0, false, top);
1028                 }
1029         }
1030
1031         ofs << "<!-- LyX "  << lyx_version
1032             << " created this file. For more info see http://www.lyx.org/"
1033             << " -->\n";
1034
1035         linuxdocParagraphs(*this, paragraphs(), ofs, runparams);
1036
1037         if (!body_only) {
1038                 ofs << "\n\n";
1039                 sgml::closeTag(ofs, 0, false, top_element);
1040         }
1041
1042         ofs.close();
1043         if (ofs.fail())
1044                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1045 }
1046
1047
1048 void Buffer::makeDocBookFile(string const & fname,
1049                              OutputParams const & runparams,
1050                              bool only_body)
1051 {
1052         ofstream ofs;
1053         if (!openFileWrite(ofs, fname))
1054                 return;
1055
1056         LaTeXFeatures features(*this, params(), runparams.nice);
1057         validate(features);
1058
1059         texrow().reset();
1060
1061         LyXTextClass const & tclass = params().getLyXTextClass();
1062         string top_element = tclass.latexname();
1063
1064         if (!only_body) {
1065                 ofs << subst(tclass.class_header(), "#", top_element);
1066
1067                 string preamble = params().preamble;
1068                 string const name = runparams.nice ? ChangeExtension(pimpl_->filename, ".sgml")
1069                          : fname;
1070                 preamble += features.getIncludedFiles(name);
1071                 preamble += features.getLyXSGMLEntities();
1072
1073                 if (!preamble.empty()) {
1074                         ofs << "\n [ " << preamble << " ]";
1075                 }
1076                 ofs << ">\n\n";
1077         }
1078
1079         string top = top_element;
1080         top += " lang=\"";
1081         top += params().language->code();
1082         top += '"';
1083
1084         if (!params().options.empty()) {
1085                 top += ' ';
1086                 top += params().options;
1087         }
1088         sgml::openTag(ofs, 0, false, top);
1089
1090         ofs << "<!-- SGML/XML file was created by LyX " << lyx_version
1091             << "\n  See http://www.lyx.org/ for more information -->\n";
1092
1093         params().getLyXTextClass().counters().reset();
1094         docbookParagraphs(*this, paragraphs(), ofs, runparams);
1095
1096         ofs << "\n\n";
1097         sgml::closeTag(ofs, 0, false, top_element);
1098
1099         ofs.close();
1100         if (ofs.fail())
1101                 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1102 }
1103
1104
1105 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1106 // Other flags: -wall -v0 -x
1107 int Buffer::runChktex()
1108 {
1109         busy(true);
1110
1111         // get LaTeX-Filename
1112         string const name = getLatexName();
1113         string const path = temppath();
1114         string const org_path = filePath();
1115
1116         Path p(path); // path to LaTeX file
1117         message(_("Running chktex..."));
1118
1119         // Generate the LaTeX file if neccessary
1120         OutputParams runparams;
1121         runparams.flavor = OutputParams::LATEX;
1122         runparams.nice = false;
1123         makeLaTeXFile(name, org_path, runparams);
1124
1125         TeXErrors terr;
1126         Chktex chktex(lyxrc.chktex_command, name, filePath());
1127         int res = chktex.run(terr); // run chktex
1128
1129         if (res == -1) {
1130                 Alert::error(_("chktex failure"),
1131                              _("Could not run chktex successfully."));
1132         } else if (res > 0) {
1133                 // Insert all errors as errors boxes
1134                 bufferErrors(*this, terr);
1135         }
1136
1137         busy(false);
1138
1139         return res;
1140 }
1141
1142
1143 void Buffer::validate(LaTeXFeatures & features) const
1144 {
1145         LyXTextClass const & tclass = params().getLyXTextClass();
1146
1147         if (params().tracking_changes) {
1148                 features.require("dvipost");
1149                 features.require("color");
1150         }
1151
1152         // AMS Style is at document level
1153         if (params().use_amsmath == BufferParams::AMS_ON
1154             || tclass.provides(LyXTextClass::amsmath))
1155                 features.require("amsmath");
1156
1157         for_each(paragraphs().begin(), paragraphs().end(),
1158                  boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1159
1160         // the bullet shapes are buffer level not paragraph level
1161         // so they are tested here
1162         for (int i = 0; i < 4; ++i) {
1163                 if (params().user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1164                         int const font = params().user_defined_bullet(i).getFont();
1165                         if (font == 0) {
1166                                 int const c = params()
1167                                         .user_defined_bullet(i)
1168                                         .getCharacter();
1169                                 if (c == 16
1170                                    || c == 17
1171                                    || c == 25
1172                                    || c == 26
1173                                    || c == 31) {
1174                                         features.require("latexsym");
1175                                 }
1176                         } else if (font == 1) {
1177                                 features.require("amssymb");
1178                         } else if ((font >= 2 && font <= 5)) {
1179                                 features.require("pifont");
1180                         }
1181                 }
1182         }
1183
1184         if (lyxerr.debugging(Debug::LATEX)) {
1185                 features.showStruct();
1186         }
1187 }
1188
1189
1190 void Buffer::getLabelList(std::vector<string> & list) const
1191 {
1192         /// if this is a child document and the parent is already loaded
1193         /// Use the parent's list instead  [ale990407]
1194         Buffer const * tmp = getMasterBuffer();
1195         if (!tmp) {
1196                 lyxerr << "getMasterBuffer() failed!" << endl;
1197                 BOOST_ASSERT(tmp);
1198         }
1199         if (tmp != this) {
1200                 tmp->getLabelList(list);
1201                 return;
1202         }
1203
1204         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1205                 it.nextInset()->getLabelList(*this, list);
1206 }
1207
1208
1209 // This is also a buffer property (ale)
1210 void Buffer::fillWithBibKeys(std::vector<std::pair<string, string> > & keys)
1211         const
1212 {
1213         /// if this is a child document and the parent is already loaded
1214         /// use the parent's list instead  [ale990412]
1215         Buffer const * tmp = getMasterBuffer();
1216         BOOST_ASSERT(tmp);
1217         if (tmp != this) {
1218                 tmp->fillWithBibKeys(keys);
1219                 return;
1220         }
1221
1222         for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1223                 if (it->lyxCode() == InsetOld::BIBTEX_CODE) {
1224                         InsetBibtex const & inset =
1225                                 dynamic_cast<InsetBibtex const &>(*it);
1226                         inset.fillWithBibKeys(*this, keys);
1227                 } else if (it->lyxCode() == InsetOld::INCLUDE_CODE) {
1228                         InsetInclude const & inset =
1229                                 dynamic_cast<InsetInclude const &>(*it);
1230                         inset.fillWithBibKeys(*this, keys);
1231                 } else if (it->lyxCode() == InsetOld::BIBITEM_CODE) {
1232                         InsetBibitem const & inset =
1233                                 dynamic_cast<InsetBibitem const &>(*it);
1234                         string const key = inset.getContents();
1235                         string const opt = inset.getOptions();
1236                         string const ref; // = pit->asString(this, false);
1237                         string const info = opt + "TheBibliographyRef" + ref;
1238                         keys.push_back(pair<string, string>(key, info));
1239                 }
1240         }
1241 }
1242
1243
1244 bool Buffer::isDepClean(string const & name) const
1245 {
1246         DepClean::const_iterator it = pimpl_->dep_clean.find(name);
1247         if (it == pimpl_->dep_clean.end())
1248                 return true;
1249         return it->second;
1250 }
1251
1252
1253 void Buffer::markDepClean(string const & name)
1254 {
1255         pimpl_->dep_clean[name] = true;
1256 }
1257
1258
1259 bool Buffer::dispatch(string const & command, bool * result)
1260 {
1261         return dispatch(lyxaction.lookupFunc(command), result);
1262 }
1263
1264
1265 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1266 {
1267         bool dispatched = true;
1268
1269         switch (func.action) {
1270                 case LFUN_EXPORT: {
1271                         bool const tmp = Exporter::Export(this, func.argument, false);
1272                         if (result)
1273                                 *result = tmp;
1274                         break;
1275                 }
1276
1277                 default:
1278                         dispatched = false;
1279         }
1280         return dispatched;
1281 }
1282
1283
1284 void Buffer::changeLanguage(Language const * from, Language const * to)
1285 {
1286         lyxerr << "Changing Language!" << endl;
1287
1288         // Take care of l10n/i18n
1289         updateDocLang(to);
1290
1291         ParIterator end = par_iterator_end();
1292         for (ParIterator it = par_iterator_begin(); it != end; ++it)
1293                 it->changeLanguage(params(), from, to);
1294 }
1295
1296
1297 void Buffer::updateDocLang(Language const * nlang)
1298 {
1299         pimpl_->messages.reset(new Messages(nlang->code()));
1300 }
1301
1302
1303 bool Buffer::isMultiLingual() const
1304 {
1305         ParConstIterator end = par_iterator_end();
1306         for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1307                 if (it->isMultiLingual(params()))
1308                         return true;
1309
1310         return false;
1311 }
1312
1313
1314 ParIterator Buffer::getParFromID(int id) const
1315 {
1316         ParConstIterator it = par_iterator_begin();
1317         ParConstIterator end = par_iterator_end();
1318
1319         if (id < 0) {
1320                 // John says this is called with id == -1 from undo
1321                 lyxerr << "getParFromID(), id: " << id << endl;
1322                 return end;
1323         }
1324
1325         for (; it != end; ++it)
1326                 if (it->id() == id)
1327                         return it;
1328
1329         return end;
1330 }
1331
1332
1333 bool Buffer::hasParWithID(int id) const
1334 {
1335         ParConstIterator it = par_iterator_begin();
1336         ParConstIterator end = par_iterator_end();
1337
1338         if (id < 0) {
1339                 // John says this is called with id == -1 from undo
1340                 lyxerr << "hasParWithID(), id: " << id << endl;
1341                 return 0;
1342         }
1343
1344         for (; it != end; ++it)
1345                 if (it->id() == id)
1346                         return true;
1347
1348         return false;
1349 }
1350
1351
1352 ParIterator Buffer::par_iterator_begin()
1353 {
1354         return ::par_iterator_begin(inset());
1355 }
1356
1357
1358 ParIterator Buffer::par_iterator_end()
1359 {
1360         return ::par_iterator_end(inset());
1361 }
1362
1363
1364 ParConstIterator Buffer::par_iterator_begin() const
1365 {
1366         return ::par_const_iterator_begin(inset());
1367 }
1368
1369
1370 ParConstIterator Buffer::par_iterator_end() const
1371 {
1372         return ::par_const_iterator_end(inset());
1373 }
1374
1375
1376 Language const * Buffer::getLanguage() const
1377 {
1378         return params().language;
1379 }
1380
1381
1382 string const Buffer::B_(string const & l10n) const
1383 {
1384         if (pimpl_->messages.get()) {
1385                 return pimpl_->messages->get(l10n);
1386         }
1387
1388         return _(l10n);
1389 }
1390
1391
1392 bool Buffer::isClean() const
1393 {
1394         return pimpl_->lyx_clean;
1395 }
1396
1397
1398 bool Buffer::isBakClean() const
1399 {
1400         return pimpl_->bak_clean;
1401 }
1402
1403
1404 void Buffer::markClean() const
1405 {
1406         if (!pimpl_->lyx_clean) {
1407                 pimpl_->lyx_clean = true;
1408                 updateTitles();
1409         }
1410         // if the .lyx file has been saved, we don't need an
1411         // autosave
1412         pimpl_->bak_clean = true;
1413 }
1414
1415
1416 void Buffer::markBakClean()
1417 {
1418         pimpl_->bak_clean = true;
1419 }
1420
1421
1422 void Buffer::setUnnamed(bool flag)
1423 {
1424         pimpl_->unnamed = flag;
1425 }
1426
1427
1428 bool Buffer::isUnnamed() const
1429 {
1430         return pimpl_->unnamed;
1431 }
1432
1433
1434 void Buffer::markDirty()
1435 {
1436         if (pimpl_->lyx_clean) {
1437                 pimpl_->lyx_clean = false;
1438                 updateTitles();
1439         }
1440         pimpl_->bak_clean = false;
1441
1442         DepClean::iterator it = pimpl_->dep_clean.begin();
1443         DepClean::const_iterator const end = pimpl_->dep_clean.end();
1444
1445         for (; it != end; ++it) {
1446                 it->second = false;
1447         }
1448 }
1449
1450
1451 string const & Buffer::fileName() const
1452 {
1453         return pimpl_->filename;
1454 }
1455
1456
1457 string const & Buffer::filePath() const
1458 {
1459         return pimpl_->filepath;
1460 }
1461
1462
1463 bool Buffer::isReadonly() const
1464 {
1465         return pimpl_->read_only;
1466 }
1467
1468
1469 void Buffer::setParentName(string const & name)
1470 {
1471         params().parentname = name;
1472 }
1473
1474
1475 Buffer const * Buffer::getMasterBuffer() const
1476 {
1477         if (!params().parentname.empty()
1478             && bufferlist.exists(params().parentname)) {
1479                 Buffer const * buf = bufferlist.getBuffer(params().parentname);
1480                 if (buf)
1481                         return buf->getMasterBuffer();
1482         }
1483
1484         return this;
1485 }
1486
1487
1488 MacroData const & Buffer::getMacro(std::string const & name) const
1489 {
1490         return pimpl_->macros.get(name);
1491 }
1492
1493
1494 bool Buffer::hasMacro(string const & name) const
1495 {
1496         return pimpl_->macros.has(name);
1497 }
1498
1499
1500 void Buffer::insertMacro(string const & name, MacroData const & data)
1501 {
1502         pimpl_->macros.insert(name, data);
1503 }
1504
1505
1506 void Buffer::buildMacros()
1507 {
1508         // Start with global table.
1509         pimpl_->macros = MacroTable::globalMacros();
1510
1511         // Now add our own.
1512         ParagraphList & pars = text().paragraphs();
1513         for (size_t i = 0, n = pars.size(); i != n; ++i) {
1514                 //lyxerr << "searching main par " << i
1515                 //      << " for macro definitions" << std::endl;
1516                 InsetList::iterator it = pars[i].insetlist.begin();
1517                 InsetList::iterator end = pars[i].insetlist.end();
1518                 for ( ; it != end; ++it) {
1519                         //lyxerr << "found inset code " << it->inset->lyxCode() << std::endl;
1520                         if (it->inset->lyxCode() == InsetBase::MATHMACRO_CODE) {
1521                                 MathMacroTemplate & mac
1522                                         = static_cast<MathMacroTemplate &>(*it->inset);
1523                                 insertMacro(mac.name(), mac.asMacroData());
1524                         }
1525                 }
1526         }
1527 }