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