src/buffer.C

   1 /* This file is part of
   2  * ======================================================
   3  *
   4  *           LyX, The Document Processor
   5  *
   6  *           Copyright 1995 Matthias Ettrich
   7  *           Copyright 1995-2001 The LyX Team.
   8  *
   9  *           This file is Copyright 1996-2001
  10  *           Lars Gullik Bjønnes
  11  *
  12  * ======================================================
  13  */
  14
  15 #include <config.h>
  16
  17 #include "buffer.h"
  18 #include "bufferlist.h"
  19 #include "LyXAction.h"
  20 #include "lyxrc.h"
  21 #include "lyxlex.h"
  22 #include "tex-strings.h"
  23 #include "layout.h"
  24 #include "bufferview_funcs.h"
  25 #include "lyxfont.h"
  26 #include "version.h"
  27 #include "LaTeX.h"
  28 #include "Chktex.h"
  29 #include "debug.h"
  30 #include "LaTeXFeatures.h"
  31 #include "lyxtext.h"
  32 #include "gettext.h"
  33 #include "language.h"
  34 #include "exporter.h"
  35 #include "Lsstream.h"
  36 #include "converter.h"
  37 #include "BufferView.h"
  38 #include "ParagraphParameters.h"
  39 #include "iterators.h"
  40 #include "lyxtextclasslist.h"
  41 #include "sgml.h"
  42 #include "paragraph_funcs.h"
  43 #include "author.h"
  44
  45 #include "frontends/LyXView.h"
  46
  47 #include "mathed/formulamacro.h"
  48 #include "mathed/formula.h"
  49
  50 #include "insets/inset.h"
  51 #include "insets/inseterror.h"
  52 #include "insets/insetlabel.h"
  53 #include "insets/insetref.h"
  54 #include "insets/inseturl.h"
  55 #include "insets/insetnote.h"
  56 #include "insets/insetquotes.h"
  57 #include "insets/insetlatexaccent.h"
  58 #include "insets/insetbib.h"
  59 #include "insets/insetcite.h"
  60 #include "insets/insetexternal.h"
  61 #include "insets/insetindex.h"
  62 #include "insets/insetinclude.h"
  63 #include "insets/insettoc.h"
  64 #include "insets/insetparent.h"
  65 #include "insets/insetspecialchar.h"
  66 #include "insets/insettext.h"
  67 #include "insets/insetert.h"
  68 #include "insets/insetgraphics.h"
  69 #include "insets/insetfoot.h"
  70 #include "insets/insetmarginal.h"
  71 #include "insets/insetoptarg.h"
  72 #include "insets/insetminipage.h"
  73 #include "insets/insetfloat.h"
  74 #include "insets/insetwrap.h"
  75 #include "insets/insettabular.h"
  76 #if 0
  77 #include "insets/insettheorem.h"
  78 #include "insets/insetlist.h"
  79 #endif
  80 #include "insets/insetcaption.h"
  81 #include "insets/insetfloatlist.h"
  82
  83 #include "frontends/Dialogs.h"
  84 #include "frontends/Alert.h"
  85
  86 #include "graphics/Previews.h"
  87
  88 #include "support/textutils.h"
  89 #include "support/filetools.h"
  90 #include "support/path.h"
  91 #include "support/os.h"
  92 #include "support/lyxlib.h"
  93 #include "support/FileInfo.h"
  94 #include "support/lyxmanip.h"
  95 #include "support/lyxtime.h"
  96
  97 #include <boost/bind.hpp>
  98 #include <boost/tuple/tuple.hpp>
  99 #include "BoostFormat.h"
 100
 101 #include <fstream>
 102 #include <iomanip>
 103 #include <map>
 104 #include <stack>
 105 #include <list>
 106 #include <algorithm>
 107
 108 #include <cstdlib>
 109 #include <cmath>
 110 #include <unistd.h>
 111 #include <sys/types.h>
 112 #include <utime.h>
 113
 114 #ifdef HAVE_LOCALE
 115 #include <locale>
 116 #endif
 117
 118 #ifndef CXX_GLOBAL_CSTD
 119 using std::pow;
 120 #endif
 121
 122 using std::ostream;
 123 using std::ofstream;
 124 using std::ifstream;
 125 using std::fstream;
 126 using std::ios;
 127 using std::setw;
 128 using std::endl;
 129 using std::pair;
 130 using std::make_pair;
 131 using std::vector;
 132 using std::map;
 133 using std::max;
 134 using std::set;
 135 using std::stack;
 136 using std::list;
 137 using std::for_each;
 138
 139 using lyx::pos_type;
 140 using lyx::textclass_type;
 141
 142 // all these externs should eventually be removed.
 143 extern BufferList bufferlist;
 144
 145 namespace {
 146
 147 const int LYX_FORMAT = 222;
 148
 149 } // namespace anon
 150
 151 Buffer::Buffer(string const & file, bool ronly)
 152         : niceFile(true), lyx_clean(true), bak_clean(true),
 153           unnamed(false), read_only(ronly),
 154           filename_(file), users(0)
 155 {
 156         lyxerr[Debug::INFO] << "Buffer::Buffer()" << endl;
 157         filepath_ = OnlyPath(file);
 158         lyxvc.buffer(this);
 159         if (read_only || lyxrc.use_tempdir) {
 160                 tmppath = CreateBufferTmpDir();
 161         } else {
 162                 tmppath.erase();
 163         }
 164
 165         // set initial author
 166         authorlist.record(Author(lyxrc.user_name, lyxrc.user_email));
 167 }
 168
 169
 170 Buffer::~Buffer()
 171 {
 172         lyxerr[Debug::INFO] << "Buffer::~Buffer()" << endl;
 173         // here the buffer should take care that it is
 174         // saved properly, before it goes into the void.
 175
 176         // make sure that views using this buffer
 177         // forgets it.
 178         if (users)
 179                 users->buffer(0);
 180
 181         if (!tmppath.empty()) {
 182                 DestroyBufferTmpDir(tmppath);
 183         }
 184
 185         paragraphs.clear();
 186
 187         // Remove any previewed LaTeX snippets assocoated with this buffer.
 188         grfx::Previews::get().removeLoader(this);
 189 }
 190
 191
 192 string const Buffer::getLatexName(bool no_path) const
 193 {
 194         string const name = ChangeExtension(MakeLatexName(fileName()), ".tex");
 195         if (no_path)
 196                 return OnlyFilename(name);
 197         else
 198                 return name;
 199 }
 200
 201
 202 pair<Buffer::LogType, string> const Buffer::getLogName() const
 203 {
 204         string const filename = getLatexName(false);
 205
 206         if (filename.empty())
 207                 return make_pair(Buffer::latexlog, string());
 208
 209         string path = OnlyPath(filename);
 210
 211         if (lyxrc.use_tempdir || !IsDirWriteable(path))
 212                 path = tmppath;
 213
 214         string const fname = AddName(path,
 215                                      OnlyFilename(ChangeExtension(filename,
 216                                                                   ".log")));
 217         string const bname =
 218                 AddName(path, OnlyFilename(
 219                         ChangeExtension(filename,
 220                                         formats.extension("literate") + ".out")));
 221
 222         // If no Latex log or Build log is newer, show Build log
 223
 224         FileInfo const f_fi(fname);
 225         FileInfo const b_fi(bname);
 226
 227         if (b_fi.exist() &&
 228             (!f_fi.exist() || f_fi.getModificationTime() < b_fi.getModificationTime())) {
 229                 lyxerr[Debug::FILES] << "Log name calculated as: " << bname << endl;
 230                 return make_pair(Buffer::buildlog, bname);
 231         }
 232         lyxerr[Debug::FILES] << "Log name calculated as: " << fname << endl;
 233         return make_pair(Buffer::latexlog, fname);
 234 }
 235
 236
 237 void Buffer::setReadonly(bool flag)
 238 {
 239         if (read_only != flag) {
 240                 read_only = flag;
 241                 updateTitles();
 242                 users->owner()->getDialogs().updateBufferDependent(false);
 243         }
 244 }
 245
 246
 247 AuthorList & Buffer::authors()
 248 {
 249         return authorlist;
 250 }
 251
 252
 253 /// Update window titles of all users
 254 // Should work on a list
 255 void Buffer::updateTitles() const
 256 {
 257         if (users)
 258                 users->owner()->updateWindowTitle();
 259 }
 260
 261
 262 /// Reset autosave timer of all users
 263 // Should work on a list
 264 void Buffer::resetAutosaveTimers() const
 265 {
 266         if (users)
 267                 users->owner()->resetAutosaveTimer();
 268 }
 269
 270
 271 void Buffer::setFileName(string const & newfile)
 272 {
 273         filename_ = MakeAbsPath(newfile);
 274         filepath_ = OnlyPath(filename_);
 275         setReadonly(IsFileWriteable(filename_) == 0);
 276         updateTitles();
 277 }
 278
 279
 280 // We'll remove this later. (Lgb)
 281 namespace {
 282
 283 string last_inset_read;
 284
 285 #ifdef WITH_WARNINGS
 286 #warning And _why_ is this here? (Lgb)
 287 #endif
 288 int unknown_layouts;
 289 int unknown_tokens;
 290 vector<int> author_ids;
 291
 292 } // anon
 293
 294
 295 // candidate for move to BufferView
 296 // (at least some parts in the beginning of the func)
 297 //
 298 // Uwe C. Schroeder
 299 // changed to be public and have one parameter
 300 // if par = 0 normal behavior
 301 // else insert behavior
 302 // Returns false if "\the_end" is not read (Asger)
 303 bool Buffer::readLyXformat2(LyXLex & lex, Paragraph * par)
 304 {
 305         unknown_layouts = 0;
 306         unknown_tokens = 0;
 307         author_ids.clear();
 308
 309         int pos = 0;
 310         Paragraph::depth_type depth = 0;
 311         bool the_end_read = false;
 312
 313         Paragraph * first_par = 0;
 314         LyXFont font(LyXFont::ALL_INHERIT, params.language);
 315
 316         if (!par) {
 317                 par = new Paragraph;
 318                 par->layout(params.getLyXTextClass().defaultLayout());
 319         } else {
 320                 // We are inserting into an existing document
 321                 users->text->breakParagraph(users);
 322                 first_par = users->text->ownerParagraph();
 323                 pos = 0;
 324                 markDirty();
 325                 // We don't want to adopt the parameters from the
 326                 // document we insert, so we skip until the text begins:
 327                 while (lex.isOK()) {
 328                         lex.nextToken();
 329                         string const pretoken = lex.getString();
 330                         if (pretoken == "\\layout") {
 331                                 lex.pushToken(pretoken);
 332                                 break;
 333                         }
 334                 }
 335         }
 336
 337         while (lex.isOK()) {
 338                 lex.nextToken();
 339                 string const token = lex.getString();
 340
 341                 if (token.empty()) continue;
 342
 343                 lyxerr[Debug::PARSER] << "Handling token: `"
 344                                       << token << '\'' << endl;
 345
 346                 the_end_read =
 347                         parseSingleLyXformat2Token(lex, par, first_par,
 348                                                    token, pos, depth,
 349                                                    font);
 350         }
 351
 352         if (!first_par)
 353                 first_par = par;
 354
 355         paragraphs.set(first_par);
 356
 357         if (unknown_layouts > 0) {
 358                 string s = _("Couldn't set the layout for ");
 359                 if (unknown_layouts == 1) {
 360                         s += _("one paragraph");
 361                 } else {
 362                         s += tostr(unknown_layouts);
 363                         s += _(" paragraphs");
 364                 }
 365 #if USE_BOOST_FORMAT
 366                 Alert::alert(_("Textclass Loading Error!"), s,
 367                            boost::io::str(boost::format(_("When reading %1$s")) % fileName()));
 368 #else
 369                 Alert::alert(_("Textclass Loading Error!"), s,
 370                              _("When reading ") + fileName());
 371 #endif
 372         }
 373
 374         if (unknown_tokens > 0) {
 375                 string s = _("Encountered ");
 376                 if (unknown_tokens == 1) {
 377                         s += _("one unknown token");
 378                 } else {
 379                         s += tostr(unknown_tokens);
 380                         s += _(" unknown tokens");
 381                 }
 382 #if USE_BOOST_FORMAT
 383                 Alert::alert(_("Textclass Loading Error!"), s,
 384                            boost::io::str(boost::format(_("When reading %1$s")) % fileName()));
 385 #else
 386                 Alert::alert(_("Textclass Loading Error!"), s,
 387                              _("When reading ") +  fileName());
 388 #endif
 389         }
 390
 391         return the_end_read;
 392 }
 393
 394
 395 namespace {
 396         // This stuff is, in the traditional LyX terminology, Super UGLY
 397         // but this code is too b0rken to admit of a better solution yet
 398         Change current_change;
 399 };
 400
 401
 402 bool
 403 Buffer::parseSingleLyXformat2Token(LyXLex & lex, Paragraph *& par,
 404                                    Paragraph *& first_par,
 405                                    string const & token, int & pos,
 406                                    Paragraph::depth_type & depth,
 407                                    LyXFont & font
 408         )
 409 {
 410         bool the_end_read = false;
 411
 412         // The order of the tags tested may seem unnatural, but this
 413         // has been done in order to reduce the number of string
 414         // comparisons needed to recognize a given token. This leads
 415         // on large documents like UserGuide to a reduction of a
 416         // factor 5! (JMarc)
 417         if (token[0] != '\\') {
 418                 for (string::const_iterator cit = token.begin();
 419                      cit != token.end(); ++cit) {
 420                         par->insertChar(pos, (*cit), font, current_change);
 421                         ++pos;
 422                 }
 423         } else if (token == "\\layout") {
 424                 // reset the font as we start a new layout and if the font is
 425                 // not ALL_INHERIT,document_language then it will be set to the
 426                 // right values after this tag (Jug 20020420)
 427                 font = LyXFont(LyXFont::ALL_INHERIT, params.language);
 428
 429                 lex.eatLine();
 430                 string layoutname = lex.getString();
 431
 432                 LyXTextClass const & tclass = params.getLyXTextClass();
 433
 434                 if (layoutname.empty()) {
 435                         layoutname = tclass.defaultLayoutName();
 436                 }
 437                 bool hasLayout = tclass.hasLayout(layoutname);
 438                 if (!hasLayout) {
 439                         lyxerr << "Layout '" << layoutname << "' does not"
 440                                << " exist in textclass '" << tclass.name()
 441                                << "'." << endl;
 442                         lyxerr << "Trying to use default layout instead."
 443                                << endl;
 444                         layoutname = tclass.defaultLayoutName();
 445                 }
 446
 447 #ifdef USE_CAPTION
 448                 // The is the compability reading of layout caption.
 449                 // It can be removed in LyX version 1.3.0. (Lgb)
 450                 if (compare_ascii_no_case(layoutname, "caption") == 0) {
 451                         // We expect that the par we are now working on is
 452                         // really inside a InsetText inside a InsetFloat.
 453                         // We also know that captions can only be
 454                         // one paragraph. (Lgb)
 455
 456                         // We should now read until the next "\layout"
 457                         // is reached.
 458                         // This is probably not good enough, what if the
 459                         // caption is the last par in the document (Lgb)
 460                         istream & ist = lex.getStream();
 461                         stringstream ss;
 462                         string line;
 463                         int begin = 0;
 464                         while (true) {
 465                                 getline(ist, line);
 466                                 if (prefixIs(line, "\\layout")) {
 467                                         lex.pushToken(line);
 468                                         break;
 469                                 }
 470                                 if (prefixIs(line, "\\begin_inset"))
 471                                         ++begin;
 472                                 if (prefixIs(line, "\\end_inset")) {
 473                                         if (begin)
 474                                                 --begin;
 475                                         else {
 476                                                 lex.pushToken(line);
 477                                                 break;
 478                                         }
 479                                 }
 480
 481                                 ss << line << '\n';
 482                         }
 483                         // Now we should have the whole layout in ss
 484                         // we should now be able to give this to the
 485                         // caption inset.
 486                         ss << "\\end_inset\n";
 487
 488                         // This seems like a bug in stringstream.
 489                         // We really should be able to use ss
 490                         // directly. (Lgb)
 491                         istringstream is(ss.str());
 492                         LyXLex tmplex(0, 0);
 493                         tmplex.setStream(is);
 494                         Inset * inset = new InsetCaption;
 495                         inset->Read(this, tmplex);
 496                         par->InsertInset(pos, inset, font);
 497                         ++pos;
 498                 } else {
 499 #endif
 500                         if (!first_par)
 501                                 first_par = par;
 502                         else {
 503                                 par = new Paragraph(par);
 504                                 par->layout(params.getLyXTextClass().defaultLayout());
 505                                 if (params.tracking_changes)
 506                                         par->trackChanges();
 507                         }
 508                         pos = 0;
 509                         par->layout(params.getLyXTextClass()[layoutname]);
 510                         // Test whether the layout is obsolete.
 511                         LyXLayout_ptr const & layout = par->layout();
 512                         if (!layout->obsoleted_by().empty())
 513                                 par->layout(params.getLyXTextClass()[layout->obsoleted_by()]);
 514                         par->params().depth(depth);
 515 #if USE_CAPTION
 516                 }
 517 #endif
 518
 519         } else if (token == "\\end_inset") {
 520                 lyxerr << "Solitary \\end_inset. Missing \\begin_inset?.\n"
 521                        << "Last inset read was: " << last_inset_read
 522                        << endl;
 523                 // Simply ignore this. The insets do not have
 524                 // to read this.
 525                 // But insets should read it, it is a part of
 526                 // the inset isn't it? Lgb.
 527         } else if (token == "\\begin_inset") {
 528                 readInset(lex, par, pos, font);
 529         } else if (token == "\\family") {
 530                 lex.next();
 531                 font.setLyXFamily(lex.getString());
 532         } else if (token == "\\series") {
 533                 lex.next();
 534                 font.setLyXSeries(lex.getString());
 535         } else if (token == "\\shape") {
 536                 lex.next();
 537                 font.setLyXShape(lex.getString());
 538         } else if (token == "\\size") {
 539                 lex.next();
 540                 font.setLyXSize(lex.getString());
 541         } else if (token == "\\lang") {
 542                 lex.next();
 543                 string const tok = lex.getString();
 544                 Language const * lang = languages.getLanguage(tok);
 545                 if (lang) {
 546                         font.setLanguage(lang);
 547                 } else {
 548                         font.setLanguage(params.language);
 549                         lex.printError("Unknown language `$$Token'");
 550                 }
 551         } else if (token == "\\numeric") {
 552                 lex.next();
 553                 font.setNumber(font.setLyXMisc(lex.getString()));
 554         } else if (token == "\\emph") {
 555                 lex.next();
 556                 font.setEmph(font.setLyXMisc(lex.getString()));
 557         } else if (token == "\\bar") {
 558                 lex.next();
 559                 string const tok = lex.getString();
 560                 // This is dirty, but gone with LyX3. (Asger)
 561                 if (tok == "under")
 562                         font.setUnderbar(LyXFont::ON);
 563                 else if (tok == "no")
 564                         font.setUnderbar(LyXFont::OFF);
 565                 else if (tok == "default")
 566                         font.setUnderbar(LyXFont::INHERIT);
 567                 else
 568                         lex.printError("Unknown bar font flag "
 569                                        "`$$Token'");
 570         } else if (token == "\\noun") {
 571                 lex.next();
 572                 font.setNoun(font.setLyXMisc(lex.getString()));
 573         } else if (token == "\\color") {
 574                 lex.next();
 575                 font.setLyXColor(lex.getString());
 576         } else if (token == "\\SpecialChar") {
 577                 LyXLayout_ptr const & layout = par->layout();
 578
 579                 // Insets don't make sense in a free-spacing context! ---Kayvan
 580                 if (layout->free_spacing || par->isFreeSpacing()) {
 581                         if (lex.isOK()) {
 582                                 lex.next();
 583                                 string const next_token = lex.getString();
 584                                 if (next_token == "\\-") {
 585                                         par->insertChar(pos, '-', font, current_change);
 586                                 } else if (next_token == "~") {
 587                                         par->insertChar(pos, ' ', font, current_change);
 588                                 } else {
 589                                         lex.printError("Token `$$Token' "
 590                                                        "is in free space "
 591                                                        "paragraph layout!");
 592                                         --pos;
 593                                 }
 594                         }
 595                 } else {
 596                         Inset * inset = new InsetSpecialChar;
 597                         inset->read(this, lex);
 598                         par->insertInset(pos, inset, font, current_change);
 599                 }
 600                 ++pos;
 601         } else if (token == "\\i") {
 602                 Inset * inset = new InsetLatexAccent;
 603                 inset->read(this, lex);
 604                 par->insertInset(pos, inset, font, current_change);
 605                 ++pos;
 606         } else if (token == "\\backslash") {
 607                 par->insertChar(pos, '\\', font, current_change);
 608                 ++pos;
 609         } else if (token == "\\begin_deeper") {
 610                 ++depth;
 611         } else if (token == "\\end_deeper") {
 612                 if (!depth) {
 613                         lex.printError("\\end_deeper: "
 614                                        "depth is already null");
 615                 }
 616                 else
 617                         --depth;
 618         } else if (token == "\\begin_preamble") {
 619                 params.readPreamble(lex);
 620         } else if (token == "\\textclass") {
 621                 lex.eatLine();
 622                 pair<bool, textclass_type> pp =
 623                         textclasslist.NumberOfClass(lex.getString());
 624                 if (pp.first) {
 625                         params.textclass = pp.second;
 626                 } else {
 627 #if USE_BOOST_FORMAT
 628                         Alert::alert(_("Textclass error"),
 629                                 boost::io::str(boost::format(_("The document uses an unknown textclass \"%1$s\".")) % lex.getString()),
 630                                 _("-- substituting default."));
 631 #else
 632                         Alert::alert(
 633                                 _("Textclass error"),
 634                                 _("The document uses an unknown textclass ")
 635                                 + lex.getString(),
 636                                 _("-- substituting default."));
 637 #endif
 638                         params.textclass = 0;
 639                 }
 640                 if (!params.getLyXTextClass().load()) {
 641                         // if the textclass wasn't loaded properly
 642                         // we need to either substitute another
 643                         // or stop loading the file.
 644                         // I can substitute but I don't see how I can
 645                         // stop loading... ideas??  ARRae980418
 646 #if USE_BOOST_FORMAT
 647                         Alert::alert(_("Textclass Loading Error!"),
 648                                    boost::io::str(boost::format(_("Can't load textclass %1$s")) %
 649                                    params.getLyXTextClass().name()),
 650                                    _("-- substituting default."));
 651 #else
 652                         Alert::alert(_("Textclass Loading Error!"),
 653                                      _("Can't load textclass ")
 654                                      + params.getLyXTextClass().name(),
 655                                      _("-- substituting default."));
 656 #endif
 657                         params.textclass = 0;
 658                 }
 659         } else if (token == "\\options") {
 660                 lex.eatLine();
 661                 params.options = lex.getString();
 662         } else if (token == "\\language") {
 663                 params.readLanguage(lex);
 664         } else if (token == "\\fontencoding") {
 665                 lex.eatLine();
 666         } else if (token == "\\inputencoding") {
 667                 lex.eatLine();
 668                 params.inputenc = lex.getString();
 669         } else if (token == "\\graphics") {
 670                 params.readGraphicsDriver(lex);
 671         } else if (token == "\\fontscheme") {
 672                 lex.eatLine();
 673                 params.fonts = lex.getString();
 674         } else if (token == "\\noindent") {
 675                 par->params().noindent(true);
 676         } else if (token == "\\leftindent") {
 677                 lex.nextToken();
 678                 LyXLength value(lex.getString());
 679                 par->params().leftIndent(value);
 680         } else if (token == "\\fill_top") {
 681                 par->params().spaceTop(VSpace(VSpace::VFILL));
 682         } else if (token == "\\fill_bottom") {
 683                 par->params().spaceBottom(VSpace(VSpace::VFILL));
 684         } else if (token == "\\line_top") {
 685                 par->params().lineTop(true);
 686         } else if (token == "\\line_bottom") {
 687                 par->params().lineBottom(true);
 688         } else if (token == "\\pagebreak_top") {
 689                 par->params().pagebreakTop(true);
 690         } else if (token == "\\pagebreak_bottom") {
 691                 par->params().pagebreakBottom(true);
 692         } else if (token == "\\start_of_appendix") {
 693                 par->params().startOfAppendix(true);
 694         } else if (token == "\\paragraph_separation") {
 695                 int tmpret = lex.findToken(string_paragraph_separation);
 696                 if (tmpret == -1)
 697                         ++tmpret;
 698                 params.paragraph_separation =
 699                         static_cast<BufferParams::PARSEP>(tmpret);
 700         } else if (token == "\\defskip") {
 701                 lex.nextToken();
 702                 params.defskip = VSpace(lex.getString());
 703         } else if (token == "\\quotes_language") {
 704                 int tmpret = lex.findToken(string_quotes_language);
 705                 if (tmpret == -1)
 706                         ++tmpret;
 707                 InsetQuotes::quote_language tmpl =
 708                         InsetQuotes::EnglishQ;
 709                 switch (tmpret) {
 710                 case 0:
 711                         tmpl = InsetQuotes::EnglishQ;
 712                         break;
 713                 case 1:
 714                         tmpl = InsetQuotes::SwedishQ;
 715                         break;
 716                 case 2:
 717                         tmpl = InsetQuotes::GermanQ;
 718                         break;
 719                 case 3:
 720                         tmpl = InsetQuotes::PolishQ;
 721                         break;
 722                 case 4:
 723                         tmpl = InsetQuotes::FrenchQ;
 724                         break;
 725                 case 5:
 726                         tmpl = InsetQuotes::DanishQ;
 727                         break;
 728                 }
 729                 params.quotes_language = tmpl;
 730         } else if (token == "\\quotes_times") {
 731                 lex.nextToken();
 732                 switch (lex.getInteger()) {
 733                 case 1:
 734                         params.quotes_times = InsetQuotes::SingleQ;
 735                         break;
 736                 case 2:
 737                         params.quotes_times = InsetQuotes::DoubleQ;
 738                         break;
 739                 }
 740         } else if (token == "\\papersize") {
 741                 int tmpret = lex.findToken(string_papersize);
 742                 if (tmpret == -1)
 743                         ++tmpret;
 744                 else
 745                         params.papersize2 = tmpret;
 746         } else if (token == "\\paperpackage") {
 747                 int tmpret = lex.findToken(string_paperpackages);
 748                 if (tmpret == -1) {
 749                         ++tmpret;
 750                         params.paperpackage = BufferParams::PACKAGE_NONE;
 751                 } else
 752                         params.paperpackage = tmpret;
 753         } else if (token == "\\use_geometry") {
 754                 lex.nextToken();
 755                 params.use_geometry = lex.getInteger();
 756         } else if (token == "\\use_amsmath") {
 757                 lex.nextToken();
 758                 params.use_amsmath = lex.getInteger();
 759         } else if (token == "\\use_natbib") {
 760                 lex.nextToken();
 761                 params.use_natbib = lex.getInteger();
 762         } else if (token == "\\use_numerical_citations") {
 763                 lex.nextToken();
 764                 params.use_numerical_citations = lex.getInteger();
 765         } else if (token == "\\tracking_changes") {
 766                 lex.nextToken();
 767                 params.tracking_changes = lex.getInteger();
 768                 // mark the first paragraph
 769                 if (params.tracking_changes)
 770                         par->trackChanges();
 771         } else if (token == "\\author") {
 772                 lex.nextToken();
 773                 istringstream ss(lex.getString());
 774                 Author a;
 775                 ss >> a;
 776                 int aid(authorlist.record(a));
 777                 lyxerr << "aid is " << aid << endl;
 778                 lyxerr << "listed aid is " << author_ids.size() << endl;
 779                 author_ids.push_back(authorlist.record(a));
 780         } else if (token == "\\paperorientation") {
 781                 int tmpret = lex.findToken(string_orientation);
 782                 if (tmpret == -1)
 783                         ++tmpret;
 784                 params.orientation =
 785                         static_cast<BufferParams::PAPER_ORIENTATION>(tmpret);
 786         } else if (token == "\\paperwidth") {
 787                 lex.next();
 788                 params.paperwidth = lex.getString();
 789         } else if (token == "\\paperheight") {
 790                 lex.next();
 791                 params.paperheight = lex.getString();
 792         } else if (token == "\\leftmargin") {
 793                 lex.next();
 794                 params.leftmargin = lex.getString();
 795         } else if (token == "\\topmargin") {
 796                 lex.next();
 797                 params.topmargin = lex.getString();
 798         } else if (token == "\\rightmargin") {
 799                 lex.next();
 800                 params.rightmargin = lex.getString();
 801         } else if (token == "\\bottommargin") {
 802                 lex.next();
 803                 params.bottommargin = lex.getString();
 804         } else if (token == "\\headheight") {
 805                 lex.next();
 806                 params.headheight = lex.getString();
 807         } else if (token == "\\headsep") {
 808                 lex.next();
 809                 params.headsep = lex.getString();
 810         } else if (token == "\\footskip") {
 811                 lex.next();
 812                 params.footskip = lex.getString();
 813         } else if (token == "\\paperfontsize") {
 814                 lex.nextToken();
 815                 params.fontsize = rtrim(lex.getString());
 816         } else if (token == "\\papercolumns") {
 817                 lex.nextToken();
 818                 params.columns = lex.getInteger();
 819         } else if (token == "\\papersides") {
 820                 lex.nextToken();
 821                 switch (lex.getInteger()) {
 822                 default:
 823                 case 1: params.sides = LyXTextClass::OneSide; break;
 824                 case 2: params.sides = LyXTextClass::TwoSides; break;
 825                 }
 826         } else if (token == "\\paperpagestyle") {
 827                 lex.nextToken();
 828                 params.pagestyle = rtrim(lex.getString());
 829         } else if (token == "\\bullet") {
 830                 lex.nextToken();
 831                 int const index = lex.getInteger();
 832                 lex.nextToken();
 833                 int temp_int = lex.getInteger();
 834                 params.user_defined_bullets[index].setFont(temp_int);
 835                 params.temp_bullets[index].setFont(temp_int);
 836                 lex.nextToken();
 837                 temp_int = lex.getInteger();
 838                 params.user_defined_bullets[index].setCharacter(temp_int);
 839                 params.temp_bullets[index].setCharacter(temp_int);
 840                 lex.nextToken();
 841                 temp_int = lex.getInteger();
 842                 params.user_defined_bullets[index].setSize(temp_int);
 843                 params.temp_bullets[index].setSize(temp_int);
 844                 lex.nextToken();
 845                 string const temp_str = lex.getString();
 846                 if (temp_str != "\\end_bullet") {
 847                                 // this element isn't really necessary for
 848                                 // parsing but is easier for humans
 849                                 // to understand bullets. Put it back and
 850                                 // set a debug message?
 851                         lex.printError("\\end_bullet expected, got" + temp_str);
 852                                 //how can I put it back?
 853                 }
 854         } else if (token == "\\bulletLaTeX") {
 855                 // The bullet class should be able to read this.
 856                 lex.nextToken();
 857                 int const index = lex.getInteger();
 858                 lex.next();
 859                 string temp_str = lex.getString();
 860                 string sum_str;
 861                 while (temp_str != "\\end_bullet") {
 862                                 // this loop structure is needed when user
 863                                 // enters an empty string since the first
 864                                 // thing returned will be the \\end_bullet
 865                                 // OR
 866                                 // if the LaTeX entry has spaces. Each element
 867                                 // therefore needs to be read in turn
 868                         sum_str += temp_str;
 869                         lex.next();
 870                         temp_str = lex.getString();
 871                 }
 872
 873                 params.user_defined_bullets[index].setText(sum_str);
 874                 params.temp_bullets[index].setText(sum_str);
 875         } else if (token == "\\secnumdepth") {
 876                 lex.nextToken();
 877                 params.secnumdepth = lex.getInteger();
 878         } else if (token == "\\tocdepth") {
 879                 lex.nextToken();
 880                 params.tocdepth = lex.getInteger();
 881         } else if (token == "\\spacing") {
 882                 lex.next();
 883                 string const tmp = rtrim(lex.getString());
 884                 Spacing::Space tmp_space = Spacing::Default;
 885                 float tmp_val = 0.0;
 886                 if (tmp == "single") {
 887                         tmp_space = Spacing::Single;
 888                 } else if (tmp == "onehalf") {
 889                         tmp_space = Spacing::Onehalf;
 890                 } else if (tmp == "double") {
 891                         tmp_space = Spacing::Double;
 892                 } else if (tmp == "other") {
 893                         lex.next();
 894                         tmp_space = Spacing::Other;
 895                         tmp_val = lex.getFloat();
 896                 } else {
 897                         lex.printError("Unknown spacing token: '$$Token'");
 898                 }
 899                 // Small hack so that files written with klyx will be
 900                 // parsed correctly.
 901                 if (first_par) {
 902                         par->params().spacing(Spacing(tmp_space, tmp_val));
 903                 } else {
 904                         params.spacing.set(tmp_space, tmp_val);
 905                 }
 906         } else if (token == "\\paragraph_spacing") {
 907                 lex.next();
 908                 string const tmp = rtrim(lex.getString());
 909                 if (tmp == "single") {
 910                         par->params().spacing(Spacing(Spacing::Single));
 911                 } else if (tmp == "onehalf") {
 912                         par->params().spacing(Spacing(Spacing::Onehalf));
 913                 } else if (tmp == "double") {
 914                         par->params().spacing(Spacing(Spacing::Double));
 915                 } else if (tmp == "other") {
 916                         lex.next();
 917                         par->params().spacing(Spacing(Spacing::Other,
 918                                          lex.getFloat()));
 919                 } else {
 920                         lex.printError("Unknown spacing token: '$$Token'");
 921                 }
 922         } else if (token == "\\float_placement") {
 923                 lex.nextToken();
 924                 params.float_placement = lex.getString();
 925         } else if (token == "\\align") {
 926                 int tmpret = lex.findToken(string_align);
 927                 if (tmpret == -1) ++tmpret;
 928                 int const tmpret2 = int(pow(2.0, tmpret));
 929                 par->params().align(LyXAlignment(tmpret2));
 930         } else if (token == "\\added_space_top") {
 931                 lex.nextToken();
 932                 VSpace value = VSpace(lex.getString());
 933                 // only add the length when value > 0 or
 934                 // with option keep
 935                 if ((value.length().len().value() != 0) ||
 936                     value.keep() ||
 937                     (value.kind() != VSpace::LENGTH))
 938                         par->params().spaceTop(value);
 939         } else if (token == "\\added_space_bottom") {
 940                 lex.nextToken();
 941                 VSpace value = VSpace(lex.getString());
 942                 // only add the length when value > 0 or
 943                 // with option keep
 944                 if ((value.length().len().value() != 0) ||
 945                    value.keep() ||
 946                     (value.kind() != VSpace::LENGTH))
 947                         par->params().spaceBottom(value);
 948         } else if (token == "\\labelwidthstring") {
 949                 lex.eatLine();
 950                 par->params().labelWidthString(lex.getString());
 951                 // do not delete this token, it is still needed!
 952         } else if (token == "\\newline") {
 953                 par->insertChar(pos, Paragraph::META_NEWLINE, font, current_change);
 954                 ++pos;
 955         } else if (token == "\\LyXTable") {
 956                 Inset * inset = new InsetTabular(*this);
 957                 inset->read(this, lex);
 958                 par->insertInset(pos, inset, font, current_change);
 959                 ++pos;
 960         } else if (token == "\\hfill") {
 961                 par->insertChar(pos, Paragraph::META_HFILL, font, current_change);
 962                 ++pos;
 963         } else if (token == "\\change_unchanged") {
 964                 // Hack ! Needed for empty paragraphs :/
 965                 if (!pos)
 966                         par->cleanChanges();
 967                 current_change = Change(Change::UNCHANGED);
 968         } else if (token == "\\change_inserted") {
 969                 lex.nextToken();
 970                 istringstream istr(lex.getString());
 971                 int aid;
 972                 lyx::time_type ct;
 973                 istr >> aid;
 974                 istr >> ct;
 975                 current_change = Change(Change::INSERTED, author_ids[aid], ct);
 976         } else if (token == "\\change_deleted") {
 977                 lex.nextToken();
 978                 istringstream istr(lex.getString());
 979                 int aid;
 980                 lyx::time_type ct;
 981                 istr >> aid;
 982                 istr >> ct;
 983                 current_change = Change(Change::DELETED, author_ids[aid], ct);
 984         } else if (token == "\\bibitem") {  // ale970302
 985                 if (!par->bibkey) {
 986                         InsetCommandParams p("bibitem", "dummy");
 987                         par->bibkey = new InsetBibKey(p);
 988                 }
 989                 par->bibkey->read(this, lex);
 990         } else if (token == "\\the_end") {
 991                 the_end_read = true;
 992         } else {
 993                 // This should be insurance for the future: (Asger)
 994                 ++unknown_tokens;
 995                 lex.eatLine();
 996 #if USE_BOOST_FORMAT
 997                 boost::format fmt(_("Unknown token: %1$s %2$s\n"));
 998                 fmt % token % lex.text();
 999                 string const s = fmt.str();
1000 #else
1001                 string const s = _("Unknown token: ") + token
1002                         + ' ' + lex.text() + '\n';
1003 #endif
1004                 // we can do this here this way because we're actually reading
1005                 // the buffer and don't care about LyXText right now.
1006                 InsetError * new_inset = new InsetError(s);
1007                 par->insertInset(pos, new_inset, LyXFont(LyXFont::ALL_INHERIT,
1008                                  params.language));
1009
1010         }
1011
1012         return the_end_read;
1013 }
1014
1015
1016 // needed to insert the selection
1017 void Buffer::insertStringAsLines(Paragraph *& par, pos_type & pos,
1018                                  LyXFont const & fn,string const & str) const
1019 {
1020         LyXLayout_ptr const & layout = par->layout();
1021
1022         LyXFont font = fn;
1023
1024         par->checkInsertChar(font);
1025         // insert the string, don't insert doublespace
1026         bool space_inserted = true;
1027         bool autobreakrows = !par->inInset() ||
1028                 static_cast<InsetText *>(par->inInset())->getAutoBreakRows();
1029         for(string::const_iterator cit = str.begin();
1030             cit != str.end(); ++cit) {
1031                 if (*cit == '\n') {
1032                         if (autobreakrows && (!par->empty() || layout->keepempty)) {
1033                                 breakParagraph(params, par, pos,
1034                                                layout->isEnvironment());
1035                                 par = par->next();
1036                                 pos = 0;
1037                                 space_inserted = true;
1038                         } else {
1039                                 continue;
1040                         }
1041                         // do not insert consecutive spaces if !free_spacing
1042                 } else if ((*cit == ' ' || *cit == '\t') &&
1043                            space_inserted && !layout->free_spacing &&
1044                                    !par->isFreeSpacing())
1045                 {
1046                         continue;
1047                 } else if (*cit == '\t') {
1048                         if (!layout->free_spacing && !par->isFreeSpacing()) {
1049                                 // tabs are like spaces here
1050                                 par->insertChar(pos, ' ', font, current_change);
1051                                 ++pos;
1052                                 space_inserted = true;
1053                         } else {
1054                                 const pos_type nb = 8 - pos % 8;
1055                                 for (pos_type a = 0; a < nb ; ++a) {
1056                                         par->insertChar(pos, ' ', font, current_change);
1057                                         ++pos;
1058                                 }
1059                                 space_inserted = true;
1060                         }
1061                 } else if (!IsPrintable(*cit)) {
1062                         // Ignore unprintables
1063                         continue;
1064                 } else {
1065                         // just insert the character
1066                         par->insertChar(pos, *cit, font);
1067                         ++pos;
1068                         space_inserted = (*cit == ' ');
1069                 }
1070
1071         }
1072 }
1073
1074
1075 void Buffer::readInset(LyXLex & lex, Paragraph *& par,
1076                        int & pos, LyXFont & font)
1077 {
1078         // consistency check
1079         if (lex.getString() != "\\begin_inset") {
1080                 lyxerr << "Buffer::readInset: Consistency check failed."
1081                        << endl;
1082         }
1083
1084         Inset * inset = 0;
1085
1086         lex.next();
1087         string const tmptok = lex.getString();
1088         last_inset_read = tmptok;
1089
1090         // test the different insets
1091         if (tmptok == "LatexCommand") {
1092                 InsetCommandParams inscmd;
1093                 inscmd.read(lex);
1094
1095                 string const cmdName = inscmd.getCmdName();
1096
1097                 // This strange command allows LyX to recognize "natbib" style
1098                 // citations: citet, citep, Citet etc.
1099                 if (compare_ascii_no_case(cmdName.substr(0,4), "cite") == 0) {
1100                         inset = new InsetCitation(inscmd);
1101                 } else if (cmdName == "bibitem") {
1102                         lex.printError("Wrong place for bibitem");
1103                         inset = new InsetBibKey(inscmd);
1104                 } else if (cmdName == "BibTeX") {
1105                         inset = new InsetBibtex(inscmd);
1106                 } else if (cmdName == "index") {
1107                         inset = new InsetIndex(inscmd);
1108                 } else if (cmdName == "include") {
1109                         inset = new InsetInclude(inscmd, *this);
1110                 } else if (cmdName == "label") {
1111                         inset = new InsetLabel(inscmd);
1112                 } else if (cmdName == "url"
1113                            || cmdName == "htmlurl") {
1114                         inset = new InsetUrl(inscmd);
1115                 } else if (cmdName == "ref"
1116                            || cmdName == "pageref"
1117                            || cmdName == "vref"
1118                            || cmdName == "vpageref"
1119                            || cmdName == "prettyref") {
1120                         if (!inscmd.getOptions().empty()
1121                             || !inscmd.getContents().empty()) {
1122                                 inset = new InsetRef(inscmd, *this);
1123                         }
1124                 } else if (cmdName == "tableofcontents") {
1125                         inset = new InsetTOC(inscmd);
1126                 } else if (cmdName == "listofalgorithms") {
1127                         inset = new InsetFloatList("algorithm");
1128                 } else if (cmdName == "listoffigures") {
1129                         inset = new InsetFloatList("figure");
1130                 } else if (cmdName == "listoftables") {
1131                         inset = new InsetFloatList("table");
1132                 } else if (cmdName == "printindex") {
1133                         inset = new InsetPrintIndex(inscmd);
1134                 } else if (cmdName == "lyxparent") {
1135                         inset = new InsetParent(inscmd, *this);
1136                 }
1137         } else {
1138                 bool alreadyread = false;
1139                 if (tmptok == "Quotes") {
1140                         inset = new InsetQuotes;
1141                 } else if (tmptok == "External") {
1142                         inset = new InsetExternal;
1143                 } else if (tmptok == "FormulaMacro") {
1144                         inset = new InsetFormulaMacro;
1145                 } else if (tmptok == "Formula") {
1146                         inset = new InsetFormula;
1147                 } else if (tmptok == "Figure") { // Backward compatibility
1148 //                      inset = new InsetFig(100, 100, *this);
1149                         inset = new InsetGraphics;
1150                 } else if (tmptok == "Graphics") {
1151                         inset = new InsetGraphics;
1152                 } else if (tmptok == "Info") {// backwards compatibility
1153                         inset = new InsetNote(this,
1154                                               lex.getLongString("\\end_inset"),
1155                                               true);
1156                         alreadyread = true;
1157                 } else if (tmptok == "Note") {
1158                         inset = new InsetNote(params);
1159                 } else if (tmptok == "Include") {
1160                         InsetCommandParams p("Include");
1161                         inset = new InsetInclude(p, *this);
1162                 } else if (tmptok == "ERT") {
1163                         inset = new InsetERT(params);
1164                 } else if (tmptok == "Tabular") {
1165                         inset = new InsetTabular(*this);
1166                 } else if (tmptok == "Text") {
1167                         inset = new InsetText(params);
1168                 } else if (tmptok == "Foot") {
1169                         inset = new InsetFoot(params);
1170                 } else if (tmptok == "Marginal") {
1171                         inset = new InsetMarginal(params);
1172                 } else if (tmptok == "OptArg") {
1173                         inset = new InsetOptArg(params);
1174                 } else if (tmptok == "Minipage") {
1175                         inset = new InsetMinipage(params);
1176                 } else if (tmptok == "Float") {
1177                         lex.next();
1178                         string tmptok = lex.getString();
1179                         inset = new InsetFloat(params, tmptok);
1180                 } else if (tmptok == "Wrap") {
1181                         lex.next();
1182                         string tmptok = lex.getString();
1183                         inset = new InsetWrap(params, tmptok);
1184 #if 0
1185                 } else if (tmptok == "List") {
1186                         inset = new InsetList;
1187                 } else if (tmptok == "Theorem") {
1188                         inset = new InsetList;
1189 #endif
1190                 } else if (tmptok == "Caption") {
1191                         inset = new InsetCaption(params);
1192                 } else if (tmptok == "FloatList") {
1193                         inset = new InsetFloatList;
1194                 }
1195
1196                 if (inset && !alreadyread) inset->read(this, lex);
1197         }
1198
1199         if (inset) {
1200                 par->insertInset(pos, inset, font, current_change);
1201                 ++pos;
1202         }
1203 }
1204
1205
1206 bool Buffer::readFile(LyXLex & lex, string const & filename, Paragraph * par)
1207 {
1208         if (lex.isOK()) {
1209                 lex.next();
1210                 string const token(lex.getString());
1211                 if (token == "\\lyxformat") { // the first token _must_ be...
1212                         lex.eatLine();
1213                         string tmp_format = lex.getString();
1214                         //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
1215                         // if present remove ".," from string.
1216                         string::size_type dot = tmp_format.find_first_of(".,");
1217                         //lyxerr << "           dot found at " << dot << endl;
1218                         if (dot != string::npos)
1219                                 tmp_format.erase(dot, 1);
1220                         file_format = strToInt(tmp_format);
1221                         //lyxerr << "format: " << file_format << endl;
1222                         if (file_format == LYX_FORMAT) {
1223                                 // current format
1224                         } else if (file_format > LYX_FORMAT) {
1225                                 // future format
1226                                 Alert::alert(_("Warning!"),
1227                                         _("The file was created with a newer version of "
1228                                         "LyX. This is likely to cause problems."));
1229
1230                         } else if (file_format < LYX_FORMAT) {
1231                                 // old formats
1232                                 if (file_format < 200) {
1233                                         Alert::alert(_("ERROR!"),
1234                                                    _("Old LyX file format found. "
1235                                                      "Use LyX 0.10.x to read this!"));
1236                                         return false;
1237                                 } else if (!filename.empty()) {
1238                                         string command =
1239                                                 LibFileSearch("lyx2lyx", "lyx2lyx");
1240                                         if (command.empty()) {
1241                                                 Alert::alert(_("ERROR!"),
1242                                                              _("Can't find conversion script."));
1243                                                 return false;
1244                                         }
1245                                         command += " -t"
1246                                                 +tostr(LYX_FORMAT) + ' '
1247                                                 + QuoteName(filename);
1248                                         lyxerr[Debug::INFO] << "Running '"
1249                                                             << command << '\''
1250                                                             << endl;
1251                                         cmd_ret const ret = RunCommand(command);
1252                                         if (ret.first) {
1253                                                 Alert::alert(_("ERROR!"),
1254                                                              _("An error occured while "
1255                                                                "running the conversion script."));
1256                                                 return false;
1257                                         }
1258                                         istringstream is(STRCONV(ret.second));
1259                                         LyXLex tmplex(0, 0);
1260                                         tmplex.setStream(is);
1261                                         return readFile(tmplex, string(), par);
1262                                 } else {
1263                                         // This code is reached if lyx2lyx failed (for
1264                                         // some reason) to change the file format of
1265                                         // the file.
1266                                         lyx::Assert(false);
1267                                         return false;
1268                                 }
1269                         }
1270                         bool the_end = readLyXformat2(lex, par);
1271                         params.setPaperStuff();
1272
1273                         if (!the_end) {
1274                                 Alert::alert(_("Warning!"),
1275                                            _("Reading of document is not complete"),
1276                                            _("Maybe the document is truncated"));
1277                         }
1278                         return true;
1279                 } else { // "\\lyxformat" not found
1280                         Alert::alert(_("ERROR!"), _("Not a LyX file!"));
1281                 }
1282         } else
1283                 Alert::alert(_("ERROR!"), _("Unable to read file!"));
1284         return false;
1285 }
1286
1287
1288 // Should probably be moved to somewhere else: BufferView? LyXView?
1289 bool Buffer::save() const
1290 {
1291         // We don't need autosaves in the immediate future. (Asger)
1292         resetAutosaveTimers();
1293
1294         // make a backup
1295         string s;
1296         if (lyxrc.make_backup) {
1297                 s = fileName() + '~';
1298                 if (!lyxrc.backupdir_path.empty())
1299                         s = AddName(lyxrc.backupdir_path,
1300                                     subst(os::slashify_path(s),'/','!'));
1301
1302                 // Rename is the wrong way of making a backup,
1303                 // this is the correct way.
1304                 /* truss cp fil fil2:
1305                    lstat("LyXVC3.lyx", 0xEFFFF898)                 Err#2 ENOENT
1306                    stat("LyXVC.lyx", 0xEFFFF688)                   = 0
1307                    open("LyXVC.lyx", O_RDONLY)                     = 3
1308                    open("LyXVC3.lyx", O_WRONLY|O_CREAT|O_TRUNC, 0600) = 4
1309                    fstat(4, 0xEFFFF508)                            = 0
1310                    fstat(3, 0xEFFFF508)                            = 0
1311                    read(3, " # T h i s   f i l e   w".., 8192)     = 5579
1312                    write(4, " # T h i s   f i l e   w".., 5579)    = 5579
1313                    read(3, 0xEFFFD4A0, 8192)                       = 0
1314                    close(4)                                        = 0
1315                    close(3)                                        = 0
1316                    chmod("LyXVC3.lyx", 0100644)                    = 0
1317                    lseek(0, 0, SEEK_CUR)                           = 46440
1318                    _exit(0)
1319                 */
1320
1321                 // Should probably have some more error checking here.
1322                 // Doing it this way, also makes the inodes stay the same.
1323                 // This is still not a very good solution, in particular we
1324                 // might loose the owner of the backup.
1325                 FileInfo finfo(fileName());
1326                 if (finfo.exist()) {
1327                         mode_t fmode = finfo.getMode();
1328                         struct utimbuf times = {
1329                                 finfo.getAccessTime(),
1330                                 finfo.getModificationTime() };
1331
1332                         ifstream ifs(fileName().c_str());
1333                         ofstream ofs(s.c_str(), ios::out|ios::trunc);
1334                         if (ifs && ofs) {
1335                                 ofs << ifs.rdbuf();
1336                                 ifs.close();
1337                                 ofs.close();
1338                                 ::chmod(s.c_str(), fmode);
1339
1340                                 if (::utime(s.c_str(), &times)) {
1341                                         lyxerr << "utime error." << endl;
1342                                 }
1343                         } else {
1344                                 lyxerr << "LyX was not able to make "
1345                                         "backup copy. Beware." << endl;
1346                         }
1347                 }
1348         }
1349
1350         if (writeFile(fileName())) {
1351                 markClean();
1352                 removeAutosaveFile(fileName());
1353         } else {
1354                 // Saving failed, so backup is not backup
1355                 if (lyxrc.make_backup) {
1356                         lyx::rename(s, fileName());
1357                 }
1358                 return false;
1359         }
1360         return true;
1361 }
1362
1363
1364 bool Buffer::writeFile(string const & fname) const
1365 {
1366         if (read_only && (fname == fileName())) {
1367                 return false;
1368         }
1369
1370         FileInfo finfo(fname);
1371         if (finfo.exist() && !finfo.writable()) {
1372                 return false;
1373         }
1374
1375         ofstream ofs(fname.c_str());
1376         if (!ofs) {
1377                 return false;
1378         }
1379
1380 #ifdef HAVE_LOCALE
1381         // Use the standard "C" locale for file output.
1382         ofs.imbue(std::locale::classic());
1383 #endif
1384
1385         // The top of the file should not be written by params.
1386
1387         // write out a comment in the top of the file
1388         ofs << '#' << lyx_docversion
1389             << " created this file. For more info see http://www.lyx.org/\n"
1390             << "\\lyxformat " << LYX_FORMAT << "\n";
1391
1392         // now write out the buffer paramters.
1393         params.writeFile(ofs);
1394
1395         // if we're tracking, list all possible authors
1396         if (params.tracking_changes) {
1397                 AuthorList::Authors::const_iterator it = authorlist.begin();
1398                 AuthorList::Authors::const_iterator end = authorlist.end();
1399                 for (; it != end; ++it) {
1400                         ofs << "\\author " << it->second << "\n";
1401                 }
1402         }
1403
1404         Paragraph::depth_type depth = 0;
1405
1406         // this will write out all the paragraphs
1407         // using recursive descent.
1408         ParagraphList::iterator pit = paragraphs.begin();
1409         ParagraphList::iterator pend = paragraphs.end();
1410         for (; pit != pend; ++pit)
1411                 pit->write(this, ofs, params, depth);
1412
1413         // Write marker that shows file is complete
1414         ofs << "\n\\the_end" << endl;
1415
1416         ofs.close();
1417
1418         // how to check if close went ok?
1419         // Following is an attempt... (BE 20001011)
1420
1421         // good() returns false if any error occured, including some
1422         //        formatting error.
1423         // bad()  returns true if something bad happened in the buffer,
1424         //        which should include file system full errors.
1425
1426         bool status = true;
1427         if (!ofs.good()) {
1428                 status = false;
1429 #if 0
1430                 if (ofs.bad()) {
1431                         lyxerr << "Buffer::writeFile: BAD ERROR!" << endl;
1432                 } else {
1433                         lyxerr << "Buffer::writeFile: NOT SO BAD ERROR!"
1434                                << endl;
1435                 }
1436 #endif
1437         }
1438
1439         return status;
1440 }
1441
1442
1443 namespace {
1444
1445 pair<int, string> const addDepth(int depth, int ldepth)
1446 {
1447         int d = depth * 2;
1448         if (ldepth > depth)
1449                 d += (ldepth - depth) * 2;
1450         return make_pair(d, string(d, ' '));
1451 }
1452
1453 }
1454
1455
1456 string const Buffer::asciiParagraph(Paragraph const & par,
1457                                     unsigned int linelen,
1458                                     bool noparbreak) const
1459 {
1460         ostringstream buffer;
1461         Paragraph::depth_type depth = 0;
1462         int ltype = 0;
1463         Paragraph::depth_type ltype_depth = 0;
1464         bool ref_printed = false;
1465 //      if (!par->previous()) {
1466 #if 0
1467         // begins or ends a deeper area ?
1468         if (depth != par->params().depth()) {
1469                 if (par->params().depth() > depth) {
1470                         while (par->params().depth() > depth) {
1471                                 ++depth;
1472                         }
1473                 } else {
1474                         while (par->params().depth() < depth) {
1475                                 --depth;
1476                         }
1477                 }
1478         }
1479 #else
1480         depth = par.params().depth();
1481 #endif
1482
1483         // First write the layout
1484         string const & tmp = par.layout()->name();
1485         if (compare_no_case(tmp, "itemize") == 0) {
1486                 ltype = 1;
1487                 ltype_depth = depth + 1;
1488         } else if (compare_ascii_no_case(tmp, "enumerate") == 0) {
1489                 ltype = 2;
1490                 ltype_depth = depth + 1;
1491         } else if (contains(ascii_lowercase(tmp), "ection")) {
1492                 ltype = 3;
1493                 ltype_depth = depth + 1;
1494         } else if (contains(ascii_lowercase(tmp), "aragraph")) {
1495                 ltype = 4;
1496                 ltype_depth = depth + 1;
1497         } else if (compare_ascii_no_case(tmp, "description") == 0) {
1498                 ltype = 5;
1499                 ltype_depth = depth + 1;
1500         } else if (compare_ascii_no_case(tmp, "abstract") == 0) {
1501                 ltype = 6;
1502                 ltype_depth = 0;
1503         } else if (compare_ascii_no_case(tmp, "bibliography") == 0) {
1504                 ltype = 7;
1505                 ltype_depth = 0;
1506         } else {
1507                 ltype = 0;
1508                 ltype_depth = 0;
1509         }
1510
1511         /* maybe some vertical spaces */
1512
1513         /* the labelwidthstring used in lists */
1514
1515         /* some lines? */
1516
1517         /* some pagebreaks? */
1518
1519         /* noindent ? */
1520
1521         /* what about the alignment */
1522 //      } else {
1523 //              lyxerr << "Should this ever happen?" << endl;
1524 //      }
1525
1526         // linelen <= 0 is special and means we don't have paragraph breaks
1527
1528         string::size_type currlinelen = 0;
1529
1530         if (!noparbreak) {
1531                 if (linelen > 0)
1532                         buffer << "\n\n";
1533
1534                 buffer << string(depth * 2, ' ');
1535                 currlinelen += depth * 2;
1536
1537                 //--
1538                 // we should probably change to the paragraph language in the
1539                 // gettext here (if possible) so that strings are outputted in
1540                 // the correct language! (20012712 Jug)
1541                 //--
1542                 switch (ltype) {
1543                 case 0: // Standard
1544                 case 4: // (Sub)Paragraph
1545                 case 5: // Description
1546                         break;
1547                 case 6: // Abstract
1548                         if (linelen > 0) {
1549                                 buffer << _("Abstract") << "\n\n";
1550                                 currlinelen = 0;
1551                         } else {
1552                                 string const abst = _("Abstract: ");
1553                                 buffer << abst;
1554                                 currlinelen += abst.length();
1555                         }
1556                         break;
1557                 case 7: // Bibliography
1558                         if (!ref_printed) {
1559                                 if (linelen > 0) {
1560                                         buffer << _("References") << "\n\n";
1561                                         currlinelen = 0;
1562                                 } else {
1563                                         string const refs = _("References: ");
1564                                         buffer << refs;
1565                                         currlinelen += refs.length();
1566                                 }
1567
1568                                 ref_printed = true;
1569                         }
1570                         break;
1571                 default:
1572                 {
1573                         string const parlab = par.params().labelString();
1574                         buffer << parlab << ' ';
1575                         currlinelen += parlab.length() + 1;
1576                 }
1577                 break;
1578
1579                 }
1580         }
1581
1582         if (!currlinelen) {
1583                 pair<int, string> p = addDepth(depth, ltype_depth);
1584                 buffer << p.second;
1585                 currlinelen += p.first;
1586         }
1587
1588         // this is to change the linebreak to do it by word a bit more
1589         // intelligent hopefully! (only in the case where we have a
1590         // max linelenght!) (Jug)
1591
1592         string word;
1593
1594         for (pos_type i = 0; i < par.size(); ++i) {
1595                 char c = par.getUChar(params, i);
1596                 switch (c) {
1597                 case Paragraph::META_INSET:
1598                 {
1599                         Inset const * inset = par.getInset(i);
1600                         if (inset) {
1601                                 if (linelen > 0) {
1602                                         buffer << word;
1603                                         currlinelen += word.length();
1604                                         word.erase();
1605                                 }
1606                                 if (inset->ascii(this, buffer, linelen)) {
1607                                         // to be sure it breaks paragraph
1608                                         currlinelen += linelen;
1609                                 }
1610                         }
1611                 }
1612                 break;
1613
1614                 case Paragraph::META_NEWLINE:
1615                         if (linelen > 0) {
1616                                 buffer << word << "\n";
1617                                 word.erase();
1618
1619                                 pair<int, string> p = addDepth(depth,
1620                                                                ltype_depth);
1621                                 buffer << p.second;
1622                                 currlinelen = p.first;
1623                         }
1624                         break;
1625
1626                 case Paragraph::META_HFILL:
1627                         buffer << word << "\t";
1628                         currlinelen += word.length() + 1;
1629                         word.erase();
1630                         break;
1631
1632                 default:
1633                         if (c == ' ') {
1634                                 if (linelen > 0 &&
1635                                     currlinelen + word.length() > linelen - 10) {
1636                                         buffer << "\n";
1637                                         pair<int, string> p =
1638                                                 addDepth(depth, ltype_depth);
1639                                         buffer << p.second;
1640                                         currlinelen = p.first;
1641                                 }
1642
1643                                 buffer << word << ' ';
1644                                 currlinelen += word.length() + 1;
1645                                 word.erase();
1646
1647                         } else {
1648                                 if (c != '\0') {
1649                                         word += c;
1650                                 } else {
1651                                         lyxerr[Debug::INFO] <<
1652                                                 "writeAsciiFile: NULL char in structure." << endl;
1653                                 }
1654                                 if ((linelen > 0) &&
1655                                         (currlinelen + word.length()) > linelen)
1656                                 {
1657                                         buffer << "\n";
1658
1659                                         pair<int, string> p =
1660                                                 addDepth(depth, ltype_depth);
1661                                         buffer << p.second;
1662                                         currlinelen = p.first;
1663                                 }
1664                         }
1665                         break;
1666                 }
1667         }
1668         buffer << word;
1669         return STRCONV(buffer.str());
1670 }
1671
1672
1673 void Buffer::writeFileAscii(string const & fname, int linelen)
1674 {
1675         ofstream ofs(fname.c_str());
1676         if (!ofs) {
1677                 Alert::err_alert(_("Error: Cannot write file:"), fname);
1678                 return;
1679         }
1680         writeFileAscii(ofs, linelen);
1681 }
1682
1683
1684 void Buffer::writeFileAscii(ostream & os, int linelen)
1685 {
1686         ParagraphList::iterator beg = paragraphs.begin();
1687         ParagraphList::iterator end = paragraphs.end();
1688         ParagraphList::iterator it = beg;
1689         for (; it != end; ++it) {
1690                 os << asciiParagraph(*it, linelen, it == beg);
1691         }
1692         os << "\n";
1693 }
1694
1695
1696 bool use_babel;
1697
1698
1699 void Buffer::makeLaTeXFile(string const & fname,
1700                            string const & original_path,
1701                            bool nice, bool only_body, bool only_preamble)
1702 {
1703         lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
1704
1705         ofstream ofs(fname.c_str());
1706         if (!ofs) {
1707                 Alert::err_alert(_("Error: Cannot open file: "), fname);
1708                 return;
1709         }
1710
1711         makeLaTeXFile(ofs, original_path, nice, only_body, only_preamble);
1712
1713         ofs.close();
1714         if (ofs.fail()) {
1715                 lyxerr << "File was not closed properly." << endl;
1716         }
1717 }
1718
1719
1720 void Buffer::makeLaTeXFile(ostream & os,
1721                            string const & original_path,
1722                            bool nice, bool only_body, bool only_preamble)
1723 {
1724         niceFile = nice; // this will be used by Insetincludes.
1725
1726         // validate the buffer.
1727         lyxerr[Debug::LATEX] << "  Validating buffer..." << endl;
1728         LaTeXFeatures features(params);
1729         validate(features);
1730         lyxerr[Debug::LATEX] << "  Buffer validation done." << endl;
1731
1732         texrow.reset();
1733         // The starting paragraph of the coming rows is the
1734         // first paragraph of the document. (Asger)
1735         texrow.start(&*(paragraphs.begin()), 0);
1736
1737         if (!only_body && nice) {
1738                 os << "%% " << lyx_docversion << " created this file.  "
1739                         "For more info, see http://www.lyx.org/.\n"
1740                         "%% Do not edit unless you really know what "
1741                         "you are doing.\n";
1742                 texrow.newline();
1743                 texrow.newline();
1744         }
1745         lyxerr[Debug::INFO] << "lyx header finished" << endl;
1746         // There are a few differences between nice LaTeX and usual files:
1747         // usual is \batchmode and has a
1748         // special input@path to allow the including of figures
1749         // with either \input or \includegraphics (what figinsets do).
1750         // input@path is set when the actual parameter
1751         // original_path is set. This is done for usual tex-file, but not
1752         // for nice-latex-file. (Matthias 250696)
1753         if (!only_body) {
1754                 if (!nice) {
1755                         // code for usual, NOT nice-latex-file
1756                         os << "\\batchmode\n"; // changed
1757                         // from \nonstopmode
1758                         texrow.newline();
1759                 }
1760                 if (!original_path.empty()) {
1761                         string inputpath = os::external_path(original_path);
1762                         subst(inputpath, "~", "\\string~");
1763                         os << "\\makeatletter\n"
1764                             << "\\def\\input@path{{"
1765                             << inputpath << "/}}\n"
1766                             << "\\makeatother\n";
1767                         texrow.newline();
1768                         texrow.newline();
1769                         texrow.newline();
1770                 }
1771
1772                 // Write the preamble
1773                 params.writeLaTeX(os, features, texrow);
1774
1775                 if (only_preamble)
1776                         return;
1777
1778                 // make the body.
1779                 os << "\\begin{document}\n";
1780                 texrow.newline();
1781         } // only_body
1782         lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
1783
1784         if (!lyxrc.language_auto_begin) {
1785                 os << subst(lyxrc.language_command_begin, "$$lang",
1786                              params.language->babel())
1787                     << endl;
1788                 texrow.newline();
1789         }
1790
1791         latexParagraphs(os, &*(paragraphs.begin()), 0, texrow);
1792
1793         // add this just in case after all the paragraphs
1794         os << endl;
1795         texrow.newline();
1796
1797         if (!lyxrc.language_auto_end) {
1798                 os << subst(lyxrc.language_command_end, "$$lang",
1799                              params.language->babel())
1800                     << endl;
1801                 texrow.newline();
1802         }
1803
1804         if (!only_body) {
1805                 os << "\\end{document}\n";
1806                 texrow.newline();
1807
1808                 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
1809         } else {
1810                 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
1811                                      << endl;
1812         }
1813
1814         // Just to be sure. (Asger)
1815         texrow.newline();
1816
1817         lyxerr[Debug::INFO] << "Finished making LaTeX file." << endl;
1818         lyxerr[Debug::INFO] << "Row count was " << texrow.rows() - 1
1819                             << '.' << endl;
1820
1821         // we want this to be true outside previews (for insetexternal)
1822         niceFile = true;
1823 }
1824
1825
1826 //
1827 // LaTeX all paragraphs from par to endpar, if endpar == 0 then to the end
1828 //
1829 void Buffer::latexParagraphs(ostream & ofs, Paragraph * par,
1830                              Paragraph * endpar, TexRow & texrow,
1831                              bool moving_arg) const
1832 {
1833         bool was_title = false;
1834         bool already_title = false;
1835         LyXTextClass const & tclass = params.getLyXTextClass();
1836
1837         // if only_body
1838         while (par != endpar) {
1839                 Inset * in = par->inInset();
1840                 // well we have to check if we are in an inset with unlimited
1841                 // length (all in one row) if that is true then we don't allow
1842                 // any special options in the paragraph and also we don't allow
1843                 // any environment other then "Standard" to be valid!
1844                 if ((in == 0) || !in->forceDefaultParagraphs(in)) {
1845                         LyXLayout_ptr const & layout = par->layout();
1846
1847                         if (layout->intitle) {
1848                                 if (already_title) {
1849                                         lyxerr <<"Error in latexParagraphs: You"
1850                                                 " should not mix title layouts"
1851                                                 " with normal ones." << endl;
1852                                 } else if (!was_title) {
1853                                         was_title = true;
1854                                         if (tclass.titletype() == TITLE_ENVIRONMENT) {
1855                                                 ofs << "\\begin{"
1856                                                     << tclass.titlename()
1857                                                     << "}\n";
1858                                                 texrow.newline();
1859                                         }
1860                                 }
1861                         } else if (was_title && !already_title) {
1862                                 if (tclass.titletype() == TITLE_ENVIRONMENT) {
1863                                         ofs << "\\end{" << tclass.titlename()
1864                                             << "}\n";
1865                                 }
1866                                 else {
1867                                         ofs << "\\" << tclass.titlename()
1868                                             << "\n";
1869                                 }
1870                                 texrow.newline();
1871                                 already_title = true;
1872                                 was_title = false;
1873                         }
1874
1875                         if (layout->isEnvironment() ||
1876                                 !par->params().leftIndent().zero())
1877                         {
1878                                 par = par->TeXEnvironment(this, params, ofs, texrow);
1879                         } else {
1880                                 par = par->TeXOnePar(this, params, ofs, texrow, moving_arg);
1881                         }
1882                 } else {
1883                         par = par->TeXOnePar(this, params, ofs, texrow, moving_arg);
1884                 }
1885         }
1886         // It might be that we only have a title in this document
1887         if (was_title && !already_title) {
1888                 if (tclass.titletype() == TITLE_ENVIRONMENT) {
1889                         ofs << "\\end{" << tclass.titlename()
1890                             << "}\n";
1891                 }
1892                 else {
1893                         ofs << "\\" << tclass.titlename()
1894                             << "\n";
1895                                 }
1896                 texrow.newline();
1897         }
1898 }
1899
1900
1901 bool Buffer::isLatex() const
1902 {
1903         return params.getLyXTextClass().outputType() == LATEX;
1904 }
1905
1906
1907 bool Buffer::isLinuxDoc() const
1908 {
1909         return params.getLyXTextClass().outputType() == LINUXDOC;
1910 }
1911
1912
1913 bool Buffer::isLiterate() const
1914 {
1915         return params.getLyXTextClass().outputType() == LITERATE;
1916 }
1917
1918
1919 bool Buffer::isDocBook() const
1920 {
1921         return params.getLyXTextClass().outputType() == DOCBOOK;
1922 }
1923
1924
1925 bool Buffer::isSGML() const
1926 {
1927         LyXTextClass const & tclass = params.getLyXTextClass();
1928
1929         return tclass.outputType() == LINUXDOC ||
1930                tclass.outputType() == DOCBOOK;
1931 }
1932
1933
1934 void Buffer::makeLinuxDocFile(string const & fname, bool nice, bool body_only)
1935 {
1936         ofstream ofs(fname.c_str());
1937
1938         if (!ofs) {
1939                 Alert::alert(_("LYX_ERROR:"), _("Cannot write file"), fname);
1940                 return;
1941         }
1942
1943         niceFile = nice; // this will be used by included files.
1944
1945         LaTeXFeatures features(params);
1946
1947         validate(features);
1948
1949         texrow.reset();
1950
1951         LyXTextClass const & tclass = params.getLyXTextClass();
1952
1953         string top_element = tclass.latexname();
1954
1955         if (!body_only) {
1956                 ofs << "<!doctype linuxdoc system";
1957
1958                 string preamble = params.preamble;
1959                 const string name = nice ? ChangeExtension(filename_, ".sgml")
1960                          : fname;
1961                 preamble += features.getIncludedFiles(name);
1962                 preamble += features.getLyXSGMLEntities();
1963
1964                 if (!preamble.empty()) {
1965                         ofs << " [ " << preamble << " ]";
1966                 }
1967                 ofs << ">\n\n";
1968
1969                 if (params.options.empty())
1970                         sgml::openTag(ofs, 0, false, top_element);
1971                 else {
1972                         string top = top_element;
1973                         top += ' ';
1974                         top += params.options;
1975                         sgml::openTag(ofs, 0, false, top);
1976                 }
1977         }
1978
1979         ofs << "<!-- "  << lyx_docversion
1980             << " created this file. For more info see http://www.lyx.org/"
1981             << " -->\n";
1982
1983         Paragraph::depth_type depth = 0; // paragraph depth
1984         Paragraph * par = &*(paragraphs.begin());
1985         string item_name;
1986         vector<string> environment_stack(5);
1987
1988         while (par) {
1989                 LyXLayout_ptr const & style = par->layout();
1990                 // treat <toc> as a special case for compatibility with old code
1991                 if (par->isInset(0)) {
1992                         Inset * inset = par->getInset(0);
1993                         Inset::Code lyx_code = inset->lyxCode();
1994                         if (lyx_code == Inset::TOC_CODE) {
1995                                 string const temp = "toc";
1996                                 sgml::openTag(ofs, depth, false, temp);
1997
1998                                 par = par->next();
1999                                 continue;
2000                         }
2001                 }
2002
2003                 // environment tag closing
2004                 for (; depth > par->params().depth(); --depth) {
2005                         sgml::closeTag(ofs, depth, false, environment_stack[depth]);
2006                         environment_stack[depth].erase();
2007                 }
2008
2009                 // write opening SGML tags
2010                 switch (style->latextype) {
2011                 case LATEX_PARAGRAPH:
2012                         if (depth == par->params().depth()
2013                            && !environment_stack[depth].empty()) {
2014                                 sgml::closeTag(ofs, depth, false, environment_stack[depth]);
2015                                 environment_stack[depth].erase();
2016                                 if (depth)
2017                                         --depth;
2018                                 else
2019                                         ofs << "</p>";
2020                         }
2021                         sgml::openTag(ofs, depth, false, style->latexname());
2022                         break;
2023
2024                 case LATEX_COMMAND:
2025                         if (depth!= 0)
2026                                 sgmlError(par, 0,
2027                                           _("Error: Wrong depth for LatexType Command.\n"));
2028
2029                         if (!environment_stack[depth].empty()) {
2030                                 sgml::closeTag(ofs, depth, false, environment_stack[depth]);
2031                                 ofs << "</p>";
2032                         }
2033
2034                         environment_stack[depth].erase();
2035                         sgml::openTag(ofs, depth, false, style->latexname());
2036                         break;
2037
2038                 case LATEX_ENVIRONMENT:
2039                 case LATEX_ITEM_ENVIRONMENT:
2040                 {
2041                         string const & latexname = style->latexname();
2042
2043                         if (depth == par->params().depth()
2044                             && environment_stack[depth] != latexname) {
2045                                 sgml::closeTag(ofs, depth, false,
2046                                              environment_stack[depth]);
2047                                 environment_stack[depth].erase();
2048                         }
2049                         if (depth < par->params().depth()) {
2050                                depth = par->params().depth();
2051                                environment_stack[depth].erase();
2052                         }
2053                         if (environment_stack[depth] != latexname) {
2054                                 if (depth == 0) {
2055                                         sgml::openTag(ofs, depth, false, "p");
2056                                 }
2057                                 sgml::openTag(ofs, depth, false, latexname);
2058
2059                                 if (environment_stack.size() == depth + 1)
2060                                         environment_stack.push_back("!-- --");
2061                                 environment_stack[depth] = latexname;
2062                         }
2063
2064                         if (style->latexparam() == "CDATA")
2065                                 ofs << "<![CDATA[";
2066
2067                         if (style->latextype == LATEX_ENVIRONMENT) break;
2068
2069                         if (style->labeltype == LABEL_MANUAL)
2070                                 item_name = "tag";
2071                         else
2072                                 item_name = "item";
2073
2074                         sgml::openTag(ofs, depth + 1, false, item_name);
2075                 }
2076                 break;
2077
2078                 default:
2079                         sgml::openTag(ofs, depth, false, style->latexname());
2080                         break;
2081                 }
2082
2083                 simpleLinuxDocOnePar(ofs, par, depth);
2084
2085                 par = par->next();
2086
2087                 ofs << "\n";
2088                 // write closing SGML tags
2089                 switch (style->latextype) {
2090                 case LATEX_COMMAND:
2091                         break;
2092                 case LATEX_ENVIRONMENT:
2093                 case LATEX_ITEM_ENVIRONMENT:
2094                         if (style->latexparam() == "CDATA")
2095                                 ofs << "]]>";
2096                         break;
2097                 default:
2098                         sgml::closeTag(ofs, depth, false, style->latexname());
2099                         break;
2100                 }
2101         }
2102
2103         // Close open tags
2104         for (int i = depth; i >= 0; --i)
2105                 sgml::closeTag(ofs, depth, false, environment_stack[i]);
2106
2107         if (!body_only) {
2108                 ofs << "\n\n";
2109                 sgml::closeTag(ofs, 0, false, top_element);
2110         }
2111
2112         ofs.close();
2113         // How to check for successful close
2114
2115         // we want this to be true outside previews (for insetexternal)
2116         niceFile = true;
2117 }
2118
2119
2120 // checks, if newcol chars should be put into this line
2121 // writes newline, if necessary.
2122 namespace {
2123
2124 void sgmlLineBreak(ostream & os, string::size_type & colcount,
2125                           string::size_type newcol)
2126 {
2127         colcount += newcol;
2128         if (colcount > lyxrc.ascii_linelen) {
2129                 os << "\n";
2130                 colcount = newcol; // assume write after this call
2131         }
2132 }
2133
2134 enum PAR_TAG {
2135         NONE=0,
2136         TT = 1,
2137         SF = 2,
2138         BF = 4,
2139         IT = 8,
2140         SL = 16,
2141         EM = 32
2142 };
2143
2144
2145 string tag_name(PAR_TAG const & pt) {
2146         switch (pt) {
2147         case NONE: return "!-- --";
2148         case TT: return "tt";
2149         case SF: return "sf";
2150         case BF: return "bf";
2151         case IT: return "it";
2152         case SL: return "sl";
2153         case EM: return "em";
2154         }
2155         return "";
2156 }
2157
2158
2159 inline
2160 void operator|=(PAR_TAG & p1, PAR_TAG const & p2)
2161 {
2162         p1 = static_cast<PAR_TAG>(p1 | p2);
2163 }
2164
2165
2166 inline
2167 void reset(PAR_TAG & p1, PAR_TAG const & p2)
2168 {
2169         p1 = static_cast<PAR_TAG>(p1 & ~p2);
2170 }
2171
2172 } // anon
2173
2174
2175 // Handle internal paragraph parsing -- layout already processed.
2176 void Buffer::simpleLinuxDocOnePar(ostream & os,
2177         Paragraph * par,
2178         Paragraph::depth_type /*depth*/)
2179 {
2180         LyXLayout_ptr const & style = par->layout();
2181
2182         string::size_type char_line_count = 5;     // Heuristic choice ;-)
2183
2184         // gets paragraph main font
2185         LyXFont font_old;
2186         bool desc_on;
2187         if (style->labeltype == LABEL_MANUAL) {
2188                 font_old = style->labelfont;
2189                 desc_on = true;
2190         } else {
2191                 font_old = style->font;
2192                 desc_on = false;
2193         }
2194
2195         LyXFont::FONT_FAMILY family_type = LyXFont::ROMAN_FAMILY;
2196         LyXFont::FONT_SERIES series_type = LyXFont::MEDIUM_SERIES;
2197         LyXFont::FONT_SHAPE  shape_type  = LyXFont::UP_SHAPE;
2198         bool is_em = false;
2199
2200         stack<PAR_TAG> tag_state;
2201         // parsing main loop
2202         for (pos_type i = 0; i < par->size(); ++i) {
2203
2204                 PAR_TAG tag_close = NONE;
2205                 list < PAR_TAG > tag_open;
2206
2207                 LyXFont const font = par->getFont(params, i);
2208
2209                 if (font_old.family() != font.family()) {
2210                         switch (family_type) {
2211                         case LyXFont::SANS_FAMILY:
2212                                 tag_close |= SF;
2213                                 break;
2214                         case LyXFont::TYPEWRITER_FAMILY:
2215                                 tag_close |= TT;
2216                                 break;
2217                         default:
2218                                 break;
2219                         }
2220
2221                         family_type = font.family();
2222
2223                         switch (family_type) {
2224                         case LyXFont::SANS_FAMILY:
2225                                 tag_open.push_back(SF);
2226                                 break;
2227                         case LyXFont::TYPEWRITER_FAMILY:
2228                                 tag_open.push_back(TT);
2229                                 break;
2230                         default:
2231                                 break;
2232                         }
2233                 }
2234
2235                 if (font_old.series() != font.series()) {
2236                         switch (series_type) {
2237                         case LyXFont::BOLD_SERIES:
2238                                 tag_close |= BF;
2239                                 break;
2240                         default:
2241                                 break;
2242                         }
2243
2244                         series_type = font.series();
2245
2246                         switch (series_type) {
2247                         case LyXFont::BOLD_SERIES:
2248                                 tag_open.push_back(BF);
2249                                 break;
2250                         default:
2251                                 break;
2252                         }
2253
2254                 }
2255
2256                 if (font_old.shape() != font.shape()) {
2257                         switch (shape_type) {
2258                         case LyXFont::ITALIC_SHAPE:
2259                                 tag_close |= IT;
2260                                 break;
2261                         case LyXFont::SLANTED_SHAPE:
2262                                 tag_close |= SL;
2263                                 break;
2264                         default:
2265                                 break;
2266                         }
2267
2268                         shape_type = font.shape();
2269
2270                         switch (shape_type) {
2271                         case LyXFont::ITALIC_SHAPE:
2272                                 tag_open.push_back(IT);
2273                                 break;
2274                         case LyXFont::SLANTED_SHAPE:
2275                                 tag_open.push_back(SL);
2276                                 break;
2277                         default:
2278                                 break;
2279                         }
2280                 }
2281                 // handle <em> tag
2282                 if (font_old.emph() != font.emph()) {
2283                         if (font.emph() == LyXFont::ON) {
2284                                 tag_open.push_back(EM);
2285                                 is_em = true;
2286                         }
2287                         else if (is_em) {
2288                                 tag_close |= EM;
2289                                 is_em = false;
2290                         }
2291                 }
2292
2293                 list < PAR_TAG > temp;
2294                 while (!tag_state.empty() && tag_close) {
2295                         PAR_TAG k =  tag_state.top();
2296                         tag_state.pop();
2297                         os << "</" << tag_name(k) << '>';
2298                         if (tag_close & k)
2299                                 reset(tag_close,k);
2300                         else
2301                                 temp.push_back(k);
2302                 }
2303
2304                 for(list< PAR_TAG >::const_iterator j = temp.begin();
2305                     j != temp.end(); ++j) {
2306                         tag_state.push(*j);
2307                         os << '<' << tag_name(*j) << '>';
2308                 }
2309
2310                 for(list< PAR_TAG >::const_iterator j = tag_open.begin();
2311                     j != tag_open.end(); ++j) {
2312                         tag_state.push(*j);
2313                         os << '<' << tag_name(*j) << '>';
2314                 }
2315
2316                 char c = par->getChar(i);
2317
2318                 if (c == Paragraph::META_INSET) {
2319                         Inset * inset = par->getInset(i);
2320                         inset->linuxdoc(this, os);
2321                         font_old = font;
2322                         continue;
2323                 }
2324
2325                 if (style->latexparam() == "CDATA") {
2326                         // "TeX"-Mode on == > SGML-Mode on.
2327                         if (c != '\0')
2328                                 os << c;
2329                         ++char_line_count;
2330                 } else {
2331                         bool ws;
2332                         string str;
2333                         boost::tie(ws, str) = sgml::escapeChar(c);
2334                         if (ws && !style->free_spacing && !par->isFreeSpacing()) {
2335                                 // in freespacing mode, spaces are
2336                                 // non-breaking characters
2337                                 if (desc_on) {// if char is ' ' then...
2338
2339                                         ++char_line_count;
2340                                         sgmlLineBreak(os, char_line_count, 6);
2341                                         os << "</tag>";
2342                                         desc_on = false;
2343                                 } else  {
2344                                         sgmlLineBreak(os, char_line_count, 1);
2345                                         os << c;
2346                                 }
2347                         } else {
2348                                 os << str;
2349                                 char_line_count += str.length();
2350                         }
2351                 }
2352                 font_old = font;
2353         }
2354
2355         while (!tag_state.empty()) {
2356                 os << "</" << tag_name(tag_state.top()) << '>';
2357                 tag_state.pop();
2358         }
2359
2360         // resets description flag correctly
2361         if (desc_on) {
2362                 // <tag> not closed...
2363                 sgmlLineBreak(os, char_line_count, 6);
2364                 os << "</tag>";
2365         }
2366 }
2367
2368
2369 // Print an error message.
2370 void Buffer::sgmlError(Paragraph * /*par*/, int /*pos*/,
2371         string const & /*message*/) const
2372 {
2373 #ifdef WITH_WARNINGS
2374 #warning This is wrong we cannot insert an inset like this!!!
2375         // I guess this was Jose' so I explain you more or less why this
2376         // is wrong. This way you insert something in the paragraph and
2377         // don't tell it to LyXText (row rebreaking and undo handling!!!)
2378         // I deactivate this code, have a look at BufferView::insertErrors
2379         // how you should do this correctly! (Jug 20020315)
2380 #endif
2381 #if 0
2382         // insert an error marker in text
2383         InsetError * new_inset = new InsetError(message);
2384         par->insertInset(pos, new_inset, LyXFont(LyXFont::ALL_INHERIT,
2385                          params.language));
2386 #endif
2387 }
2388
2389
2390 void Buffer::makeDocBookFile(string const & fname, bool nice, bool only_body)
2391 {
2392         ofstream ofs(fname.c_str());
2393         if (!ofs) {
2394                 Alert::alert(_("LYX_ERROR:"), _("Cannot write file"), fname);
2395                 return;
2396         }
2397
2398         Paragraph * par = &*(paragraphs.begin());
2399
2400         niceFile = nice; // this will be used by Insetincludes.
2401
2402         LaTeXFeatures features(params);
2403         validate(features);
2404
2405         texrow.reset();
2406
2407         LyXTextClass const & tclass = params.getLyXTextClass();
2408         string top_element = tclass.latexname();
2409
2410         if (!only_body) {
2411                 ofs << "<!DOCTYPE " << top_element
2412                     << "  PUBLIC \"-//OASIS//DTD DocBook V4.1//EN\"";
2413
2414                 string preamble = params.preamble;
2415                 const string name = nice ? ChangeExtension(filename_, ".sgml")
2416                          : fname;
2417                 preamble += features.getIncludedFiles(name);
2418                 preamble += features.getLyXSGMLEntities();
2419
2420                 if (!preamble.empty()) {
2421                         ofs << "\n [ " << preamble << " ]";
2422                 }
2423                 ofs << ">\n\n";
2424         }
2425
2426         string top = top_element;
2427         top += " lang=\"";
2428         top += params.language->code();
2429         top += '"';
2430
2431         if (!params.options.empty()) {
2432                 top += ' ';
2433                 top += params.options;
2434         }
2435         sgml::openTag(ofs, 0, false, top);
2436
2437         ofs << "<!-- DocBook file was created by " << lyx_docversion
2438             << "\n  See http://www.lyx.org/ for more information -->\n";
2439
2440         vector<string> environment_stack(10);
2441         vector<string> environment_inner(10);
2442         vector<string> command_stack(10);
2443
2444         bool command_flag = false;
2445         Paragraph::depth_type command_depth = 0;
2446         Paragraph::depth_type command_base = 0;
2447         Paragraph::depth_type cmd_depth = 0;
2448         Paragraph::depth_type depth = 0; // paragraph depth
2449
2450         string item_name;
2451         string command_name;
2452
2453         while (par) {
2454                 string sgmlparam;
2455                 string c_depth;
2456                 string c_params;
2457                 int desc_on = 0; // description mode
2458
2459                 LyXLayout_ptr const & style = par->layout();
2460
2461                 // environment tag closing
2462                 for (; depth > par->params().depth(); --depth) {
2463                         if (environment_inner[depth] != "!-- --") {
2464                                 item_name = "listitem";
2465                                 sgml::closeTag(ofs, command_depth + depth, false, item_name);
2466                                 if (environment_inner[depth] == "varlistentry")
2467                                         sgml::closeTag(ofs, depth+command_depth, false, environment_inner[depth]);
2468                         }
2469                         sgml::closeTag(ofs, depth + command_depth, false, environment_stack[depth]);
2470                         environment_stack[depth].erase();
2471                         environment_inner[depth].erase();
2472                 }
2473
2474                 if (depth == par->params().depth()
2475                    && environment_stack[depth] != style->latexname()
2476                    && !environment_stack[depth].empty()) {
2477                         if (environment_inner[depth] != "!-- --") {
2478                                 item_name= "listitem";
2479                                 sgml::closeTag(ofs, command_depth+depth, false, item_name);
2480                                 if (environment_inner[depth] == "varlistentry")
2481                                         sgml::closeTag(ofs, depth + command_depth, false, environment_inner[depth]);
2482                         }
2483
2484                         sgml::closeTag(ofs, depth + command_depth, false, environment_stack[depth]);
2485
2486                         environment_stack[depth].erase();
2487                         environment_inner[depth].erase();
2488                 }
2489
2490                 // Write opening SGML tags.
2491                 switch (style->latextype) {
2492                 case LATEX_PARAGRAPH:
2493                         sgml::openTag(ofs, depth + command_depth,
2494                                     false, style->latexname());
2495                         break;
2496
2497                 case LATEX_COMMAND:
2498                         if (depth != 0)
2499                                 sgmlError(par, 0,
2500                                           _("Error: Wrong depth for LatexType Command.\n"));
2501
2502                         command_name = style->latexname();
2503
2504                         sgmlparam = style->latexparam();
2505                         c_params = split(sgmlparam, c_depth,'|');
2506
2507                         cmd_depth = lyx::atoi(c_depth);
2508
2509                         if (command_flag) {
2510                                 if (cmd_depth < command_base) {
2511                                         for (Paragraph::depth_type j = command_depth;
2512                                              j >= command_base; --j) {
2513                                                 sgml::closeTag(ofs, j, false, command_stack[j]);
2514                                                 ofs << endl;
2515                                         }
2516                                         command_depth = command_base = cmd_depth;
2517                                 } else if (cmd_depth <= command_depth) {
2518                                         for (int j = command_depth;
2519                                              j >= int(cmd_depth); --j) {
2520                                                 sgml::closeTag(ofs, j, false, command_stack[j]);
2521                                                 ofs << endl;
2522                                         }
2523                                         command_depth = cmd_depth;
2524                                 } else
2525                                         command_depth = cmd_depth;
2526                         } else {
2527                                 command_depth = command_base = cmd_depth;
2528                                 command_flag = true;
2529                         }
2530                         if (command_stack.size() == command_depth + 1)
2531                                 command_stack.push_back(string());
2532                         command_stack[command_depth] = command_name;
2533
2534                         // treat label as a special case for
2535                         // more WYSIWYM handling.
2536                         // This is a hack while paragraphs can't have
2537                         // attributes, like id in this case.
2538                         if (par->isInset(0)) {
2539                                 Inset * inset = par->getInset(0);
2540                                 Inset::Code lyx_code = inset->lyxCode();
2541                                 if (lyx_code == Inset::LABEL_CODE) {
2542                                         command_name += " id=\"";
2543                                         command_name += (static_cast<InsetCommand *>(inset))->getContents();
2544                                         command_name += '"';
2545                                         desc_on = 3;
2546                                 }
2547                         }
2548
2549                         sgml::openTag(ofs, depth + command_depth, false, command_name);
2550
2551                         item_name = c_params.empty() ? "title" : c_params;
2552                         sgml::openTag(ofs, depth + 1 + command_depth, false, item_name);
2553                         break;
2554
2555                 case LATEX_ENVIRONMENT:
2556                 case LATEX_ITEM_ENVIRONMENT:
2557                         if (depth < par->params().depth()) {
2558                                 depth = par->params().depth();
2559                                 environment_stack[depth].erase();
2560                         }
2561
2562                         if (environment_stack[depth] != style->latexname()) {
2563                                 if (environment_stack.size() == depth + 1) {
2564                                         environment_stack.push_back("!-- --");
2565                                         environment_inner.push_back("!-- --");
2566                                 }
2567                                 environment_stack[depth] = style->latexname();
2568                                 environment_inner[depth] = "!-- --";
2569                                 sgml::openTag(ofs, depth + command_depth, false, environment_stack[depth]);
2570                         } else {
2571                                 if (environment_inner[depth] != "!-- --") {
2572                                         item_name= "listitem";
2573                                         sgml::closeTag(ofs, command_depth + depth, false, item_name);
2574                                         if (environment_inner[depth] == "varlistentry")
2575                                                 sgml::closeTag(ofs, depth + command_depth, false, environment_inner[depth]);
2576                                 }
2577                         }
2578
2579                         if (style->latextype == LATEX_ENVIRONMENT) {
2580                                 if (!style->latexparam().empty()) {
2581                                         if (style->latexparam() == "CDATA")
2582                                                 ofs << "<![CDATA[";
2583                                         else
2584                                                 sgml::openTag(ofs, depth + command_depth, false, style->latexparam());
2585                                 }
2586                                 break;
2587                         }
2588
2589                         desc_on = (style->labeltype == LABEL_MANUAL);
2590
2591                         environment_inner[depth] = desc_on ? "varlistentry" : "listitem";
2592                         sgml::openTag(ofs, depth + 1 + command_depth,
2593                                     false, environment_inner[depth]);
2594
2595                         item_name = desc_on ? "term" : "para";
2596                         sgml::openTag(ofs, depth + 1 + command_depth,
2597                                     false, item_name);
2598                         break;
2599                 default:
2600                         sgml::openTag(ofs, depth + command_depth,
2601                                     false, style->latexname());
2602                         break;
2603                 }
2604
2605                 simpleDocBookOnePar(ofs, par, desc_on,
2606                                     depth + 1 + command_depth);
2607                 par = par->next();
2608
2609                 string end_tag;
2610                 // write closing SGML tags
2611                 switch (style->latextype) {
2612                 case LATEX_COMMAND:
2613                         end_tag = c_params.empty() ? "title" : c_params;
2614                         sgml::closeTag(ofs, depth + command_depth,
2615                                      false, end_tag);
2616                         break;
2617                 case LATEX_ENVIRONMENT:
2618                         if (!style->latexparam().empty()) {
2619                                 if (style->latexparam() == "CDATA")
2620                                         ofs << "]]>";
2621                                 else
2622                                         sgml::closeTag(ofs, depth + command_depth, false, style->latexparam());
2623                         }
2624                         break;
2625                 case LATEX_ITEM_ENVIRONMENT:
2626                         if (desc_on == 1) break;
2627                         end_tag = "para";
2628                         sgml::closeTag(ofs, depth + 1 + command_depth, false, end_tag);
2629                         break;
2630                 case LATEX_PARAGRAPH:
2631                         sgml::closeTag(ofs, depth + command_depth, false, style->latexname());
2632                         break;
2633                 default:
2634                         sgml::closeTag(ofs, depth + command_depth, false, style->latexname());
2635                         break;
2636                 }
2637         }
2638
2639         // Close open tags
2640         for (int d = depth; d >= 0; --d) {
2641                 if (!environment_stack[depth].empty()) {
2642                         if (environment_inner[depth] != "!-- --") {
2643                                 item_name = "listitem";
2644                                 sgml::closeTag(ofs, command_depth + depth, false, item_name);
2645                                if (environment_inner[depth] == "varlistentry")
2646                                        sgml::closeTag(ofs, depth + command_depth, false, environment_inner[depth]);
2647                         }
2648
2649                         sgml::closeTag(ofs, depth + command_depth, false, environment_stack[depth]);
2650                 }
2651         }
2652
2653         for (int j = command_depth; j >= 0 ; --j)
2654                 if (!command_stack[j].empty()) {
2655                         sgml::closeTag(ofs, j, false, command_stack[j]);
2656                         ofs << endl;
2657                 }
2658
2659         ofs << "\n\n";
2660         sgml::closeTag(ofs, 0, false, top_element);
2661
2662         ofs.close();
2663         // How to check for successful close
2664
2665         // we want this to be true outside previews (for insetexternal)
2666         niceFile = true;
2667 }
2668
2669
2670 void Buffer::simpleDocBookOnePar(ostream & os,
2671                                  Paragraph * par, int & desc_on,
2672                                  Paragraph::depth_type depth) const
2673 {
2674         bool emph_flag = false;
2675
2676         LyXLayout_ptr const & style = par->layout();
2677
2678         LyXFont font_old = (style->labeltype == LABEL_MANUAL ? style->labelfont : style->font);
2679
2680         int char_line_count = depth;
2681         //if (!style.free_spacing)
2682         //      os << string(depth,' ');
2683
2684         // parsing main loop
2685         for (pos_type i = 0; i < par->size(); ++i) {
2686                 LyXFont font = par->getFont(params, i);
2687
2688                 // handle <emphasis> tag
2689                 if (font_old.emph() != font.emph()) {
2690                         if (font.emph() == LyXFont::ON) {
2691                                 if (style->latexparam() == "CDATA")
2692                                         os << "]]>";
2693                                 os << "<emphasis>";
2694                                 if (style->latexparam() == "CDATA")
2695                                         os << "<![CDATA[";
2696                                 emph_flag = true;
2697                         } else if (i) {
2698                                 if (style->latexparam() == "CDATA")
2699                                         os << "]]>";
2700                                 os << "</emphasis>";
2701                                 if (style->latexparam() == "CDATA")
2702                                         os << "<![CDATA[";
2703                                 emph_flag = false;
2704                         }
2705                 }
2706
2707
2708                 if (par->isInset(i)) {
2709                         Inset * inset = par->getInset(i);
2710                         // don't print the inset in position 0 if desc_on == 3 (label)
2711                         if (i || desc_on != 3) {
2712                                 if (style->latexparam() == "CDATA")
2713                                         os << "]]>";
2714                                 inset->docbook(this, os, false);
2715                                 if (style->latexparam() == "CDATA")
2716                                         os << "<![CDATA[";
2717                         }
2718                 } else {
2719                         char c = par->getChar(i);
2720                         bool ws;
2721                         string str;
2722                         boost::tie(ws, str) = sgml::escapeChar(c);
2723
2724                         if (style->pass_thru) {
2725                                 os << c;
2726                         } else if (style->free_spacing || par->isFreeSpacing() || c != ' ') {
2727                                         os << str;
2728                         } else if (desc_on ==1) {
2729                                 ++char_line_count;
2730                                 os << "\n</term><listitem><para>";
2731                                 desc_on = 2;
2732                         } else {
2733                                 os << ' ';
2734                         }
2735                 }
2736                 font_old = font;
2737         }
2738
2739         if (emph_flag) {
2740                 if (style->latexparam() == "CDATA")
2741                         os << "]]>";
2742                 os << "</emphasis>";
2743                 if (style->latexparam() == "CDATA")
2744                         os << "<![CDATA[";
2745         }
2746
2747         // resets description flag correctly
2748         if (desc_on == 1) {
2749                 // <term> not closed...
2750                 os << "</term>\n<listitem><para>&nbsp;</para>";
2751         }
2752         if (style->free_spacing)
2753                 os << '\n';
2754 }
2755
2756
2757 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2758 // Other flags: -wall -v0 -x
2759 int Buffer::runChktex()
2760 {
2761         if (!users->text) return 0;
2762
2763         users->owner()->busy(true);
2764
2765         // get LaTeX-Filename
2766         string const name = getLatexName();
2767         string path = filePath();
2768
2769         string const org_path = path;
2770         if (lyxrc.use_tempdir || !IsDirWriteable(path)) {
2771                 path = tmppath;
2772         }
2773
2774         Path p(path); // path to LaTeX file
2775         users->owner()->message(_("Running chktex..."));
2776
2777         // Remove all error insets
2778         bool const removedErrorInsets = users->removeAutoInsets();
2779
2780         // Generate the LaTeX file if neccessary
2781         makeLaTeXFile(name, org_path, false);
2782
2783         TeXErrors terr;
2784         Chktex chktex(lyxrc.chktex_command, name, filePath());
2785         int res = chktex.run(terr); // run chktex
2786
2787         if (res == -1) {
2788                 Alert::alert(_("chktex did not work!"),
2789                            _("Could not run with file:"), name);
2790         } else if (res > 0) {
2791                 // Insert all errors as errors boxes
2792                 users->insertErrors(terr);
2793         }
2794
2795         // if we removed error insets before we ran chktex or if we inserted
2796         // error insets after we ran chktex, this must be run:
2797         if (removedErrorInsets || res) {
2798 #warning repaint needed here, or do you mean update() ?
2799                 users->repaint();
2800                 users->fitCursor();
2801         }
2802         users->owner()->busy(false);
2803
2804         return res;
2805 }
2806
2807
2808 void Buffer::validate(LaTeXFeatures & features) const
2809 {
2810         LyXTextClass const & tclass = params.getLyXTextClass();
2811
2812         if (params.tracking_changes) {
2813                 features.require("dvipost");
2814                 features.require("color");
2815         }
2816
2817         // AMS Style is at document level
2818         if (params.use_amsmath || tclass.provides(LyXTextClass::amsmath))
2819                 features.require("amsmath");
2820
2821         for_each(paragraphs.begin(), paragraphs.end(),
2822                  boost::bind(&Paragraph::validate, _1, boost::ref(features)));
2823
2824         // the bullet shapes are buffer level not paragraph level
2825         // so they are tested here
2826         for (int i = 0; i < 4; ++i) {
2827                 if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
2828                         int const font = params.user_defined_bullets[i].getFont();
2829                         if (font == 0) {
2830                                 int const c = params
2831                                         .user_defined_bullets[i]
2832                                         .getCharacter();
2833                                 if (c == 16
2834                                    || c == 17
2835                                    || c == 25
2836                                    || c == 26
2837                                    || c == 31) {
2838                                         features.require("latexsym");
2839                                 }
2840                         } else if (font == 1) {
2841                                 features.require("amssymb");
2842                         } else if ((font >= 2 && font <= 5)) {
2843                                 features.require("pifont");
2844                         }
2845                 }
2846         }
2847
2848         if (lyxerr.debugging(Debug::LATEX)) {
2849                 features.showStruct();
2850         }
2851 }
2852
2853
2854 vector<string> const Buffer::getLabelList() const
2855 {
2856         /// if this is a child document and the parent is already loaded
2857         /// Use the parent's list instead  [ale990407]
2858         if (!params.parentname.empty()
2859             && bufferlist.exists(params.parentname)) {
2860                 Buffer const * tmp = bufferlist.getBuffer(params.parentname);
2861                 if (tmp)
2862                         return tmp->getLabelList();
2863         }
2864
2865         vector<string> label_list;
2866         for (inset_iterator it = inset_const_iterator_begin();
2867              it != inset_const_iterator_end(); ++it) {
2868                 vector<string> const l = it->getLabelList();
2869                 label_list.insert(label_list.end(), l.begin(), l.end());
2870         }
2871         return label_list;
2872 }
2873
2874
2875 // This is also a buffer property (ale)
2876 vector<pair<string, string> > const Buffer::getBibkeyList() const
2877 {
2878         typedef pair<string, string> StringPair;
2879         /// if this is a child document and the parent is already loaded
2880         /// Use the parent's list instead  [ale990412]
2881         if (!params.parentname.empty() && bufferlist.exists(params.parentname)) {
2882                 Buffer const * tmp = bufferlist.getBuffer(params.parentname);
2883                 if (tmp)
2884                         return tmp->getBibkeyList();
2885         }
2886
2887         vector<StringPair> keys;
2888         ParagraphList::iterator pit = paragraphs.begin();
2889         ParagraphList::iterator pend = paragraphs.end();
2890         for (; pit != pend; ++pit) {
2891                 if (pit->bibkey) {
2892                         string const key = pit->bibkey->getContents();
2893                         string const opt = pit->bibkey->getOptions();
2894                         string const ref = pit->asString(this, false);
2895                         string const info = opt + "TheBibliographyRef" + ref;
2896
2897                         keys.push_back(StringPair(key, info));
2898                 }
2899         }
2900
2901         if (!keys.empty())
2902                 return keys;
2903
2904         // Might be either using bibtex or a child has bibliography
2905         for (inset_iterator it = inset_const_iterator_begin();
2906                 it != inset_const_iterator_end(); ++it) {
2907                 // Search for Bibtex or Include inset
2908                 if (it->lyxCode() == Inset::BIBTEX_CODE) {
2909                         vector<StringPair> tmp =
2910                                 static_cast<InsetBibtex &>(*it).getKeys(this);
2911                         keys.insert(keys.end(), tmp.begin(), tmp.end());
2912                 } else if (it->lyxCode() == Inset::INCLUDE_CODE) {
2913                         vector<StringPair> const tmp =
2914                                 static_cast<InsetInclude &>(*it).getKeys();
2915                         keys.insert(keys.end(), tmp.begin(), tmp.end());
2916                 }
2917         }
2918
2919         return keys;
2920 }
2921
2922
2923 bool Buffer::isDepClean(string const & name) const
2924 {
2925         DepClean::const_iterator it = dep_clean_.find(name);
2926         if (it == dep_clean_.end())
2927                 return true;
2928         return it->second;
2929 }
2930
2931
2932 void Buffer::markDepClean(string const & name)
2933 {
2934         dep_clean_[name] = true;
2935 }
2936
2937
2938 bool Buffer::dispatch(string const & command, bool * result)
2939 {
2940         // Split command string into command and argument
2941         string cmd;
2942         string line = ltrim(command);
2943         string const arg = trim(split(line, cmd, ' '));
2944
2945         return dispatch(lyxaction.LookupFunc(cmd), arg, result);
2946 }
2947
2948
2949 bool Buffer::dispatch(int action, string const & argument, bool * result)
2950 {
2951         bool dispatched = true;
2952
2953         switch (action) {
2954                 case LFUN_EXPORT: {
2955                         bool const tmp = Exporter::Export(this, argument, false);
2956                         if (result)
2957                                 *result = tmp;
2958                         break;
2959                 }
2960
2961                 default:
2962                         dispatched = false;
2963         }
2964         return dispatched;
2965 }
2966
2967
2968 void Buffer::resizeInsets(BufferView * bv)
2969 {
2970         /// then remove all LyXText in text-insets
2971         for_each(paragraphs.begin(), paragraphs.end(),
2972                  boost::bind(&Paragraph::resizeInsetsLyXText, _1, bv));
2973 }
2974
2975
2976 void Buffer::redraw()
2977 {
2978 #warning repaint needed here, or do you mean update() ?
2979         users->repaint();
2980         users->fitCursor();
2981 }
2982
2983
2984 void Buffer::changeLanguage(Language const * from, Language const * to)
2985 {
2986
2987         ParIterator end = par_iterator_end();
2988         for (ParIterator it = par_iterator_begin(); it != end; ++it)
2989                 (*it)->changeLanguage(params, from, to);
2990 }
2991
2992
2993 bool Buffer::isMultiLingual()
2994 {
2995         ParIterator end = par_iterator_end();
2996         for (ParIterator it = par_iterator_begin(); it != end; ++it)
2997                 if ((*it)->isMultiLingual(params))
2998                         return true;
2999
3000         return false;
3001 }
3002
3003
3004 void Buffer::inset_iterator::setParagraph()
3005 {
3006         while (pit != pend) {
3007                 it = pit->insetlist.begin();
3008                 if (it != pit->insetlist.end())
3009                         return;
3010                 ++pit;
3011         }
3012 }
3013
3014
3015 Inset * Buffer::getInsetFromID(int id_arg) const
3016 {
3017         for (inset_iterator it = inset_const_iterator_begin();
3018                  it != inset_const_iterator_end(); ++it)
3019         {
3020                 if (it->id() == id_arg)
3021                         return &(*it);
3022                 Inset * in = it->getInsetFromID(id_arg);
3023                 if (in)
3024                         return in;
3025         }
3026         return 0;
3027 }
3028
3029
3030 Paragraph * Buffer::getParFromID(int id) const
3031 {
3032         if (id < 0)
3033                 return 0;
3034
3035         // why should we allow < 0 ??
3036         //lyx::Assert(id >= 0);
3037
3038         ParConstIterator it(par_iterator_begin());
3039         ParConstIterator end(par_iterator_end());
3040
3041         for (; it != end; ++it) {
3042                 // go on then, show me how to remove
3043                 // the cast
3044                 if ((*it)->id() == id) {
3045                         return const_cast<Paragraph*>(*it);
3046                 }
3047         }
3048
3049         return 0;
3050 }
3051
3052
3053 ParIterator Buffer::par_iterator_begin()
3054 {
3055         return ParIterator(&*(paragraphs.begin()));
3056 }
3057
3058
3059 ParIterator Buffer::par_iterator_end()
3060 {
3061         return ParIterator();
3062 }
3063
3064 ParConstIterator Buffer::par_iterator_begin() const
3065 {
3066         return ParConstIterator(&*(paragraphs.begin()));
3067 }
3068
3069
3070 ParConstIterator Buffer::par_iterator_end() const
3071 {
3072         return ParConstIterator();
3073 }
3074
3075
3076
3077 void Buffer::addUser(BufferView * u)
3078 {
3079         users = u;
3080 }
3081
3082
3083 void Buffer::delUser(BufferView *)
3084 {
3085         users = 0;
3086 }
3087
3088
3089 Language const * Buffer::getLanguage() const
3090 {
3091         return params.language;
3092 }
3093
3094
3095 bool Buffer::isClean() const
3096 {
3097         return lyx_clean;
3098 }
3099
3100
3101 bool Buffer::isBakClean() const
3102 {
3103         return bak_clean;
3104 }
3105
3106
3107 void Buffer::markClean() const
3108 {
3109         if (!lyx_clean) {
3110                 lyx_clean = true;
3111                 updateTitles();
3112         }
3113         // if the .lyx file has been saved, we don't need an
3114         // autosave
3115         bak_clean = true;
3116 }
3117
3118
3119 void Buffer::markBakClean()
3120 {
3121         bak_clean = true;
3122 }
3123
3124
3125 void Buffer::setUnnamed(bool flag)
3126 {
3127         unnamed = flag;
3128 }
3129
3130
3131 bool Buffer::isUnnamed()
3132 {
3133         return unnamed;
3134 }
3135
3136
3137 void Buffer::markDirty()
3138 {
3139         if (lyx_clean) {
3140                 lyx_clean = false;
3141                 updateTitles();
3142         }
3143         bak_clean = false;
3144
3145         DepClean::iterator it = dep_clean_.begin();
3146         DepClean::const_iterator const end = dep_clean_.end();
3147
3148         for (; it != end; ++it) {
3149                 it->second = false;
3150         }
3151 }
3152
3153
3154 string const & Buffer::fileName() const
3155 {
3156         return filename_;
3157 }
3158
3159
3160 string const & Buffer::filePath() const
3161 {
3162         return filepath_;
3163 }
3164
3165
3166 bool Buffer::isReadonly() const
3167 {
3168         return read_only;
3169 }
3170
3171
3172 BufferView * Buffer::getUser() const
3173 {
3174         return users;
3175 }
3176
3177
3178 void Buffer::setParentName(string const & name)
3179 {
3180         params.parentname = name;
3181 }
3182
3183
3184 Buffer::inset_iterator::inset_iterator()
3185         : pit(0), pend(0)
3186 {}
3187
3188
3189 Buffer::inset_iterator::inset_iterator(base_type p, base_type e)
3190         : pit(p), pend(e)
3191 {
3192         setParagraph();
3193 }
3194
3195
3196 Buffer::inset_iterator & Buffer::inset_iterator::operator++()
3197 {
3198         if (pit != pend) {
3199                 ++it;
3200                 if (it == pit->insetlist.end()) {
3201                         ++pit;
3202                         setParagraph();
3203                 }
3204         }
3205         return *this;
3206 }
3207
3208
3209 Buffer::inset_iterator Buffer::inset_iterator::operator++(int)
3210 {
3211         inset_iterator tmp = *this;
3212         ++*this;
3213         return tmp;
3214 }
3215
3216
3217 Buffer::inset_iterator::reference Buffer::inset_iterator::operator*()
3218 {
3219         return *it.getInset();
3220 }
3221
3222
3223 Buffer::inset_iterator::pointer Buffer::inset_iterator::operator->()
3224 {
3225         return it.getInset();
3226 }
3227
3228
3229 Paragraph * Buffer::inset_iterator::getPar()
3230 {
3231         return &(*pit);
3232 }
3233
3234
3235 lyx::pos_type Buffer::inset_iterator::getPos() const
3236 {
3237         return it.getPos();
3238 }
3239
3240
3241 bool operator==(Buffer::inset_iterator const & iter1,
3242                 Buffer::inset_iterator const & iter2)
3243 {
3244         return iter1.pit == iter2.pit
3245                 && (iter1.pit == iter1.pend || iter1.it == iter2.it);
3246 }
3247
3248
3249 bool operator!=(Buffer::inset_iterator const & iter1,
3250                 Buffer::inset_iterator const & iter2)
3251 {
3252         return !(iter1 == iter2);
3253 }