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