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