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