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 const command = "lyx2lyx "
1175                                                 + QuoteName(filename_);
1176                                         cmd_ret const ret = RunCommand(command);
1177                                         if (ret.first) {
1178                                                 Alert::alert(_("ERROR!"),
1179                                                      _("An error occured while "
1180                                                        "running the conversion script."));
1181                                                 return false;
1182                                         }
1183                                         istringstream is(ret.second);
1184                                         LyXLex tmplex(0, 0);
1185                                         tmplex.setStream(is);
1186                                         return readFile(tmplex);
1187                                 }
1188                         }
1189                         bool the_end = readLyXformat2(lex, par);
1190                         params.setPaperStuff();
1191
1192 #if 0
1193                         // the_end was added in 213
1194                         if (file_format < 213)
1195                                 the_end = true;
1196 #endif
1197
1198                         if (!the_end) {
1199                                 Alert::alert(_("Warning!"),
1200                                            _("Reading of document is not complete"),
1201                                            _("Maybe the document is truncated"));
1202                         }
1203                         return true;
1204                 } else { // "\\lyxformat" not found
1205                         Alert::alert(_("ERROR!"), _("Not a LyX file!"));
1206                 }
1207         } else
1208                 Alert::alert(_("ERROR!"), _("Unable to read file!"));
1209         return false;
1210 }
1211
1212
1213 // Should probably be moved to somewhere else: BufferView? LyXView?
1214 bool Buffer::save() const
1215 {
1216         // We don't need autosaves in the immediate future. (Asger)
1217         resetAutosaveTimers();
1218
1219         // make a backup
1220         string s;
1221         if (lyxrc.make_backup) {
1222                 s = fileName() + '~';
1223                 if (!lyxrc.backupdir_path.empty())
1224                         s = AddName(lyxrc.backupdir_path,
1225                                     subst(os::slashify_path(s),'/','!'));
1226
1227                 // Rename is the wrong way of making a backup,
1228                 // this is the correct way.
1229                 /* truss cp fil fil2:
1230                    lstat("LyXVC3.lyx", 0xEFFFF898)                 Err#2 ENOENT
1231                    stat("LyXVC.lyx", 0xEFFFF688)                   = 0
1232                    open("LyXVC.lyx", O_RDONLY)                     = 3
1233                    open("LyXVC3.lyx", O_WRONLY|O_CREAT|O_TRUNC, 0600) = 4
1234                    fstat(4, 0xEFFFF508)                            = 0
1235                    fstat(3, 0xEFFFF508)                            = 0
1236                    read(3, " # T h i s   f i l e   w".., 8192)     = 5579
1237                    write(4, " # T h i s   f i l e   w".., 5579)    = 5579
1238                    read(3, 0xEFFFD4A0, 8192)                       = 0
1239                    close(4)                                        = 0
1240                    close(3)                                        = 0
1241                    chmod("LyXVC3.lyx", 0100644)                    = 0
1242                    lseek(0, 0, SEEK_CUR)                           = 46440
1243                    _exit(0)
1244                 */
1245
1246                 // Should probably have some more error checking here.
1247                 // Doing it this way, also makes the inodes stay the same.
1248                 // This is still not a very good solution, in particular we
1249                 // might loose the owner of the backup.
1250                 FileInfo finfo(fileName());
1251                 if (finfo.exist()) {
1252                         mode_t fmode = finfo.getMode();
1253                         struct utimbuf times = {
1254                                 finfo.getAccessTime(),
1255                                 finfo.getModificationTime() };
1256
1257                         ifstream ifs(fileName().c_str());
1258                         ofstream ofs(s.c_str(), ios::out|ios::trunc);
1259                         if (ifs && ofs) {
1260                                 ofs << ifs.rdbuf();
1261                                 ifs.close();
1262                                 ofs.close();
1263                                 ::chmod(s.c_str(), fmode);
1264
1265                                 if (::utime(s.c_str(), &times)) {
1266                                         lyxerr << "utime error." << endl;
1267                                 }
1268                         } else {
1269                                 lyxerr << "LyX was not able to make "
1270                                         "backup copy. Beware." << endl;
1271                         }
1272                 }
1273         }
1274
1275         if (writeFile(fileName())) {
1276                 markClean();
1277                 removeAutosaveFile(fileName());
1278         } else {
1279                 // Saving failed, so backup is not backup
1280                 if (lyxrc.make_backup) {
1281                         lyx::rename(s, fileName());
1282                 }
1283                 return false;
1284         }
1285         return true;
1286 }
1287
1288
1289 bool Buffer::writeFile(string const & fname) const
1290 {
1291         if (read_only && (fname == fileName())) {
1292                 return false;
1293         }
1294
1295         FileInfo finfo(fname);
1296         if (finfo.exist() && !finfo.writable()) {
1297                 return false;
1298         }
1299
1300         ofstream ofs(fname.c_str());
1301         if (!ofs) {
1302                 return false;
1303         }
1304
1305 #ifdef HAVE_LOCALE
1306         // Use the standard "C" locale for file output.
1307         ofs.imbue(std::locale::classic());
1308 #endif
1309
1310         // The top of the file should not be written by params.
1311
1312         // write out a comment in the top of the file
1313         ofs << '#' << lyx_docversion
1314             << " created this file. For more info see http://www.lyx.org/\n"
1315             << "\\lyxformat " << LYX_FORMAT << "\n";
1316
1317         // now write out the buffer paramters.
1318         params.writeFile(ofs);
1319
1320         Paragraph::depth_type depth = 0;
1321
1322         // this will write out all the paragraphs
1323         // using recursive descent.
1324         ParagraphList::iterator pit = paragraphs.begin();
1325         ParagraphList::iterator pend = paragraphs.end();
1326         for (; pit != pend; ++pit)
1327                 pit->write(this, ofs, params, depth);
1328
1329         // Write marker that shows file is complete
1330         ofs << "\n\\the_end" << endl;
1331
1332         ofs.close();
1333
1334         // how to check if close went ok?
1335         // Following is an attempt... (BE 20001011)
1336
1337         // good() returns false if any error occured, including some
1338         //        formatting error.
1339         // bad()  returns true if something bad happened in the buffer,
1340         //        which should include file system full errors.
1341
1342         bool status = true;
1343         if (!ofs.good()) {
1344                 status = false;
1345 #if 0
1346                 if (ofs.bad()) {
1347                         lyxerr << "Buffer::writeFile: BAD ERROR!" << endl;
1348                 } else {
1349                         lyxerr << "Buffer::writeFile: NOT SO BAD ERROR!"
1350                                << endl;
1351                 }
1352 #endif
1353         }
1354
1355         return status;
1356 }
1357
1358
1359 namespace {
1360
1361 pair<int, string> const addDepth(int depth, int ldepth)
1362 {
1363         int d = depth * 2;
1364         if (ldepth > depth)
1365                 d += (ldepth - depth) * 2;
1366         return make_pair(d, string(d, ' '));
1367 }
1368
1369 }
1370
1371
1372 string const Buffer::asciiParagraph(Paragraph const & par,
1373                                     unsigned int linelen,
1374                                     bool noparbreak) const
1375 {
1376         ostringstream buffer;
1377         Paragraph::depth_type depth = 0;
1378         int ltype = 0;
1379         Paragraph::depth_type ltype_depth = 0;
1380         bool ref_printed = false;
1381 //      if (!par->previous()) {
1382 #if 0
1383         // begins or ends a deeper area ?
1384         if (depth != par->params().depth()) {
1385                 if (par->params().depth() > depth) {
1386                         while (par->params().depth() > depth) {
1387                                 ++depth;
1388                         }
1389                 } else {
1390                         while (par->params().depth() < depth) {
1391                                 --depth;
1392                         }
1393                 }
1394         }
1395 #else
1396         depth = par.params().depth();
1397 #endif
1398
1399         // First write the layout
1400         string const & tmp = par.layout()->name();
1401         if (compare_no_case(tmp, "itemize") == 0) {
1402                 ltype = 1;
1403                 ltype_depth = depth + 1;
1404         } else if (compare_ascii_no_case(tmp, "enumerate") == 0) {
1405                 ltype = 2;
1406                 ltype_depth = depth + 1;
1407         } else if (contains(ascii_lowercase(tmp), "ection")) {
1408                 ltype = 3;
1409                 ltype_depth = depth + 1;
1410         } else if (contains(ascii_lowercase(tmp), "aragraph")) {
1411                 ltype = 4;
1412                 ltype_depth = depth + 1;
1413         } else if (compare_ascii_no_case(tmp, "description") == 0) {
1414                 ltype = 5;
1415                 ltype_depth = depth + 1;
1416         } else if (compare_ascii_no_case(tmp, "abstract") == 0) {
1417                 ltype = 6;
1418                 ltype_depth = 0;
1419         } else if (compare_ascii_no_case(tmp, "bibliography") == 0) {
1420                 ltype = 7;
1421                 ltype_depth = 0;
1422         } else {
1423                 ltype = 0;
1424                 ltype_depth = 0;
1425         }
1426
1427         /* maybe some vertical spaces */
1428
1429         /* the labelwidthstring used in lists */
1430
1431         /* some lines? */
1432
1433         /* some pagebreaks? */
1434
1435         /* noindent ? */
1436
1437         /* what about the alignment */
1438 //      } else {
1439 //              lyxerr << "Should this ever happen?" << endl;
1440 //      }
1441
1442         // linelen <= 0 is special and means we don't have paragraph breaks
1443
1444         string::size_type currlinelen = 0;
1445
1446         if (!noparbreak) {
1447                 if (linelen > 0)
1448                         buffer << "\n\n";
1449
1450                 buffer << string(depth * 2, ' ');
1451                 currlinelen += depth * 2;
1452
1453                 //--
1454                 // we should probably change to the paragraph language in the
1455                 // gettext here (if possible) so that strings are outputted in
1456                 // the correct language! (20012712 Jug)
1457                 //--
1458                 switch (ltype) {
1459                 case 0: // Standard
1460                 case 4: // (Sub)Paragraph
1461                 case 5: // Description
1462                         break;
1463                 case 6: // Abstract
1464                         if (linelen > 0) {
1465                                 buffer << _("Abstract") << "\n\n";
1466                                 currlinelen = 0;
1467                         } else {
1468                                 string const abst = _("Abstract: ");
1469                                 buffer << abst;
1470                                 currlinelen += abst.length();
1471                         }
1472                         break;
1473                 case 7: // Bibliography
1474                         if (!ref_printed) {
1475                                 if (linelen > 0) {
1476                                         buffer << _("References") << "\n\n";
1477                                         currlinelen = 0;
1478                                 } else {
1479                                         string const refs = _("References: ");
1480                                         buffer << refs;
1481                                         currlinelen += refs.length();
1482                                 }
1483
1484                                 ref_printed = true;
1485                         }
1486                         break;
1487                 default:
1488                 {
1489                         string const parlab = par.params().labelString();
1490                         buffer << parlab << " ";
1491                         currlinelen += parlab.length() + 1;
1492                 }
1493                 break;
1494
1495                 }
1496         }
1497
1498         if (!currlinelen) {
1499                 pair<int, string> p = addDepth(depth, ltype_depth);
1500                 buffer << p.second;
1501                 currlinelen += p.first;
1502         }
1503
1504         // this is to change the linebreak to do it by word a bit more
1505         // intelligent hopefully! (only in the case where we have a
1506         // max linelenght!) (Jug)
1507
1508         string word;
1509
1510         for (pos_type i = 0; i < par.size(); ++i) {
1511                 char c = par.getUChar(params, i);
1512                 switch (c) {
1513                 case Paragraph::META_INSET:
1514                 {
1515                         Inset const * inset = par.getInset(i);
1516                         if (inset) {
1517                                 if (linelen > 0) {
1518                                         buffer << word;
1519                                         currlinelen += word.length();
1520                                         word.erase();
1521                                 }
1522                                 if (inset->ascii(this, buffer, linelen)) {
1523                                         // to be sure it breaks paragraph
1524                                         currlinelen += linelen;
1525                                 }
1526                         }
1527                 }
1528                 break;
1529
1530                 case Paragraph::META_NEWLINE:
1531                         if (linelen > 0) {
1532                                 buffer << word << "\n";
1533                                 word.erase();
1534
1535                                 pair<int, string> p = addDepth(depth,
1536                                                                ltype_depth);
1537                                 buffer << p.second;
1538                                 currlinelen = p.first;
1539                         }
1540                         break;
1541
1542                 case Paragraph::META_HFILL:
1543                         buffer << word << "\t";
1544                         currlinelen += word.length() + 1;
1545                         word.erase();
1546                         break;
1547
1548                 default:
1549                         if (c == ' ') {
1550                                 if (linelen > 0 &&
1551                                     currlinelen + word.length() > linelen - 10) {
1552                                         buffer << "\n";
1553                                         pair<int, string> p =
1554                                                 addDepth(depth, ltype_depth);
1555                                         buffer << p.second;
1556                                         currlinelen = p.first;
1557                                 }
1558
1559                                 buffer << word << ' ';
1560                                 currlinelen += word.length() + 1;
1561                                 word.erase();
1562
1563                         } else {
1564                                 if (c != '\0') {
1565                                         word += c;
1566                                 } else {
1567                                         lyxerr[Debug::INFO] <<
1568                                                 "writeAsciiFile: NULL char in structure." << endl;
1569                                 }
1570                                 if ((linelen > 0) &&
1571                                         (currlinelen + word.length()) > linelen)
1572                                 {
1573                                         buffer << "\n";
1574
1575                                         pair<int, string> p =
1576                                                 addDepth(depth, ltype_depth);
1577                                         buffer << p.second;
1578                                         currlinelen = p.first;
1579                                 }
1580                         }
1581                         break;
1582                 }
1583         }
1584         buffer << word;
1585         return buffer.str().c_str();
1586 }
1587
1588
1589 void Buffer::writeFileAscii(string const & fname, int linelen)
1590 {
1591         ofstream ofs(fname.c_str());
1592         if (!ofs) {
1593                 Alert::err_alert(_("Error: Cannot write file:"), fname);
1594                 return;
1595         }
1596         writeFileAscii(ofs, linelen);
1597 }
1598
1599
1600 void Buffer::writeFileAscii(ostream & os, int linelen)
1601 {
1602         ParagraphList::iterator beg = paragraphs.begin();
1603         ParagraphList::iterator end = paragraphs.end();
1604         ParagraphList::iterator it = beg;
1605         for (; it != end; ++it) {
1606                 os << asciiParagraph(*it, linelen, it == beg);
1607         }
1608         os << "\n";
1609 }
1610
1611
1612 bool use_babel;
1613
1614
1615 void Buffer::makeLaTeXFile(string const & fname,
1616                            string const & original_path,
1617                            bool nice, bool only_body, bool only_preamble)
1618 {
1619         lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
1620
1621         ofstream ofs(fname.c_str());
1622         if (!ofs) {
1623                 Alert::err_alert(_("Error: Cannot open file: "), fname);
1624                 return;
1625         }
1626
1627         makeLaTeXFile(ofs, original_path, nice, only_body, only_preamble);
1628
1629         ofs.close();
1630         if (ofs.fail()) {
1631                 lyxerr << "File was not closed properly." << endl;
1632         }
1633 }
1634
1635
1636 void Buffer::makeLaTeXFile(ostream & os,
1637                            string const & original_path,
1638                            bool nice, bool only_body, bool only_preamble)
1639 {
1640         niceFile = nice; // this will be used by Insetincludes.
1641
1642         // validate the buffer.
1643         lyxerr[Debug::LATEX] << "  Validating buffer..." << endl;
1644         LaTeXFeatures features(params);
1645         validate(features);
1646         lyxerr[Debug::LATEX] << "  Buffer validation done." << endl;
1647
1648         texrow.reset();
1649         // The starting paragraph of the coming rows is the
1650         // first paragraph of the document. (Asger)
1651         texrow.start(&*(paragraphs.begin()), 0);
1652
1653         if (!only_body && nice) {
1654                 os << "%% " << lyx_docversion << " created this file.  "
1655                         "For more info, see http://www.lyx.org/.\n"
1656                         "%% Do not edit unless you really know what "
1657                         "you are doing.\n";
1658                 texrow.newline();
1659                 texrow.newline();
1660         }
1661         lyxerr[Debug::INFO] << "lyx header finished" << endl;
1662         // There are a few differences between nice LaTeX and usual files:
1663         // usual is \batchmode and has a
1664         // special input@path to allow the including of figures
1665         // with either \input or \includegraphics (what figinsets do).
1666         // input@path is set when the actual parameter
1667         // original_path is set. This is done for usual tex-file, but not
1668         // for nice-latex-file. (Matthias 250696)
1669         if (!only_body) {
1670                 if (!nice) {
1671                         // code for usual, NOT nice-latex-file
1672                         os << "\\batchmode\n"; // changed
1673                         // from \nonstopmode
1674                         texrow.newline();
1675                 }
1676                 if (!original_path.empty()) {
1677                         string inputpath = os::external_path(original_path);
1678                         subst(inputpath, "~", "\\string~");
1679                         os << "\\makeatletter\n"
1680                             << "\\def\\input@path{{"
1681                             << inputpath << "/}}\n"
1682                             << "\\makeatother\n";
1683                         texrow.newline();
1684                         texrow.newline();
1685                         texrow.newline();
1686                 }
1687
1688                 os << "\\documentclass";
1689
1690                 LyXTextClass const & tclass = params.getLyXTextClass();
1691
1692                 ostringstream options; // the document class options.
1693
1694                 if (tokenPos(tclass.opt_fontsize(),
1695                              '|', params.fontsize) >= 0) {
1696                         // only write if existing in list (and not default)
1697                         options << params.fontsize << "pt,";
1698                 }
1699
1700
1701                 if (!params.use_geometry &&
1702                     (params.paperpackage == BufferParams::PACKAGE_NONE)) {
1703                         switch (params.papersize) {
1704                         case BufferParams::PAPER_A4PAPER:
1705                                 options << "a4paper,";
1706                                 break;
1707                         case BufferParams::PAPER_USLETTER:
1708                                 options << "letterpaper,";
1709                                 break;
1710                         case BufferParams::PAPER_A5PAPER:
1711                                 options << "a5paper,";
1712                                 break;
1713                         case BufferParams::PAPER_B5PAPER:
1714                                 options << "b5paper,";
1715                                 break;
1716                         case BufferParams::PAPER_EXECUTIVEPAPER:
1717                                 options << "executivepaper,";
1718                                 break;
1719                         case BufferParams::PAPER_LEGALPAPER:
1720                                 options << "legalpaper,";
1721                                 break;
1722                         }
1723                 }
1724
1725                 // if needed
1726                 if (params.sides != tclass.sides()) {
1727                         switch (params.sides) {
1728                         case LyXTextClass::OneSide:
1729                                 options << "oneside,";
1730                                 break;
1731                         case LyXTextClass::TwoSides:
1732                                 options << "twoside,";
1733                                 break;
1734                         }
1735                 }
1736
1737                 // if needed
1738                 if (params.columns != tclass.columns()) {
1739                         if (params.columns == 2)
1740                                 options << "twocolumn,";
1741                         else
1742                                 options << "onecolumn,";
1743                 }
1744
1745                 if (!params.use_geometry
1746                     && params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
1747                         options << "landscape,";
1748
1749                 // language should be a parameter to \documentclass
1750                 use_babel = false;
1751                 ostringstream language_options;
1752                 if (params.language->babel() == "hebrew"
1753                     && default_language->babel() != "hebrew")
1754                          // This seems necessary
1755                         features.useLanguage(default_language);
1756
1757                 if (lyxrc.language_use_babel ||
1758                     params.language->lang() != lyxrc.default_language ||
1759                     features.hasLanguages()) {
1760                         use_babel = true;
1761                         language_options << features.getLanguages();
1762                         language_options << params.language->babel();
1763                         if (lyxrc.language_global_options)
1764                                 options << language_options.str() << ',';
1765                 }
1766
1767                 // the user-defined options
1768                 if (!params.options.empty()) {
1769                         options << params.options << ',';
1770                 }
1771
1772                 string strOptions(options.str().c_str());
1773                 if (!strOptions.empty()) {
1774                         strOptions = rtrim(strOptions, ",");
1775                         os << '[' << strOptions << ']';
1776                 }
1777
1778                 os << '{' << tclass.latexname() << "}\n";
1779                 texrow.newline();
1780                 // end of \documentclass defs
1781
1782                 // font selection must be done before loading fontenc.sty
1783                 // The ae package is not needed when using OT1 font encoding.
1784                 if (params.fonts != "default" &&
1785                     (params.fonts != "ae" || lyxrc.fontenc != "default")) {
1786                         os << "\\usepackage{" << params.fonts << "}\n";
1787                         texrow.newline();
1788                         if (params.fonts == "ae") {
1789                                 os << "\\usepackage{aecompl}\n";
1790                                 texrow.newline();
1791                         }
1792                 }
1793                 // this one is not per buffer
1794                 if (lyxrc.fontenc != "default") {
1795                         os << "\\usepackage[" << lyxrc.fontenc
1796                             << "]{fontenc}\n";
1797                         texrow.newline();
1798                 }
1799
1800                 if (params.inputenc == "auto") {
1801                         string const doc_encoding =
1802                                 params.language->encoding()->LatexName();
1803
1804                         // Create a list with all the input encodings used
1805                         // in the document
1806                         set<string> encodings = features.getEncodingSet(doc_encoding);
1807
1808                         os << "\\usepackage[";
1809                         std::copy(encodings.begin(), encodings.end(),
1810                                   std::ostream_iterator<string>(os, ","));
1811                         os << doc_encoding << "]{inputenc}\n";
1812                         texrow.newline();
1813                 } else if (params.inputenc != "default") {
1814                         os << "\\usepackage[" << params.inputenc
1815                             << "]{inputenc}\n";
1816                         texrow.newline();
1817                 }
1818
1819                 // At the very beginning the text parameters.
1820                 if (params.paperpackage != BufferParams::PACKAGE_NONE) {
1821                         switch (params.paperpackage) {
1822                         case BufferParams::PACKAGE_A4:
1823                                 os << "\\usepackage{a4}\n";
1824                                 texrow.newline();
1825                                 break;
1826                         case BufferParams::PACKAGE_A4WIDE:
1827                                 os << "\\usepackage{a4wide}\n";
1828                                 texrow.newline();
1829                                 break;
1830                         case BufferParams::PACKAGE_WIDEMARGINSA4:
1831                                 os << "\\usepackage[widemargins]{a4}\n";
1832                                 texrow.newline();
1833                                 break;
1834                         }
1835                 }
1836                 if (params.use_geometry) {
1837                         os << "\\usepackage{geometry}\n";
1838                         texrow.newline();
1839                         os << "\\geometry{verbose";
1840                         if (params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
1841                                 os << ",landscape";
1842                         switch (params.papersize2) {
1843                         case BufferParams::VM_PAPER_CUSTOM:
1844                                 if (!params.paperwidth.empty())
1845                                         os << ",paperwidth="
1846                                             << params.paperwidth;
1847                                 if (!params.paperheight.empty())
1848                                         os << ",paperheight="
1849                                             << params.paperheight;
1850                                 break;
1851                         case BufferParams::VM_PAPER_USLETTER:
1852                                 os << ",letterpaper";
1853                                 break;
1854                         case BufferParams::VM_PAPER_USLEGAL:
1855                                 os << ",legalpaper";
1856                                 break;
1857                         case BufferParams::VM_PAPER_USEXECUTIVE:
1858                                 os << ",executivepaper";
1859                                 break;
1860                         case BufferParams::VM_PAPER_A3:
1861                                 os << ",a3paper";
1862                                 break;
1863                         case BufferParams::VM_PAPER_A4:
1864                                 os << ",a4paper";
1865                                 break;
1866                         case BufferParams::VM_PAPER_A5:
1867                                 os << ",a5paper";
1868                                 break;
1869                         case BufferParams::VM_PAPER_B3:
1870                                 os << ",b3paper";
1871                                 break;
1872                         case BufferParams::VM_PAPER_B4:
1873                                 os << ",b4paper";
1874                                 break;
1875                         case BufferParams::VM_PAPER_B5:
1876                                 os << ",b5paper";
1877                                 break;
1878                         default:
1879                                 // default papersize ie BufferParams::VM_PAPER_DEFAULT
1880                                 switch (lyxrc.default_papersize) {
1881                                 case BufferParams::PAPER_DEFAULT: // keep compiler happy
1882                                 case BufferParams::PAPER_USLETTER:
1883                                         os << ",letterpaper";
1884                                         break;
1885                                 case BufferParams::PAPER_LEGALPAPER:
1886                                         os << ",legalpaper";
1887                                         break;
1888                                 case BufferParams::PAPER_EXECUTIVEPAPER:
1889                                         os << ",executivepaper";
1890                                         break;
1891                                 case BufferParams::PAPER_A3PAPER:
1892                                         os << ",a3paper";
1893                                         break;
1894                                 case BufferParams::PAPER_A4PAPER:
1895                                         os << ",a4paper";
1896                                         break;
1897                                 case BufferParams::PAPER_A5PAPER:
1898                                         os << ",a5paper";
1899                                         break;
1900                                 case BufferParams::PAPER_B5PAPER:
1901                                         os << ",b5paper";
1902                                         break;
1903                                 }
1904                         }
1905                         if (!params.topmargin.empty())
1906                                 os << ",tmargin=" << params.topmargin;
1907                         if (!params.bottommargin.empty())
1908                                 os << ",bmargin=" << params.bottommargin;
1909                         if (!params.leftmargin.empty())
1910                                 os << ",lmargin=" << params.leftmargin;
1911                         if (!params.rightmargin.empty())
1912                                 os << ",rmargin=" << params.rightmargin;
1913                         if (!params.headheight.empty())
1914                                 os << ",headheight=" << params.headheight;
1915                         if (!params.headsep.empty())
1916                                 os << ",headsep=" << params.headsep;
1917                         if (!params.footskip.empty())
1918                                 os << ",footskip=" << params.footskip;
1919                         os << "}\n";
1920                         texrow.newline();
1921                 }
1922
1923                 if (tokenPos(tclass.opt_pagestyle(),
1924                              '|', params.pagestyle) >= 0) {
1925                         if (params.pagestyle == "fancy") {
1926                                 os << "\\usepackage{fancyhdr}\n";
1927                                 texrow.newline();
1928                         }
1929                         os << "\\pagestyle{" << params.pagestyle << "}\n";
1930                         texrow.newline();
1931                 }
1932
1933                 if (params.secnumdepth != tclass.secnumdepth()) {
1934                         os << "\\setcounter{secnumdepth}{"
1935                             << params.secnumdepth
1936                             << "}\n";
1937                         texrow.newline();
1938                 }
1939                 if (params.tocdepth != tclass.tocdepth()) {
1940                         os << "\\setcounter{tocdepth}{"
1941                             << params.tocdepth
1942                             << "}\n";
1943                         texrow.newline();
1944                 }
1945
1946                 if (params.paragraph_separation) {
1947                         switch (params.defskip.kind()) {
1948                         case VSpace::SMALLSKIP:
1949                                 os << "\\setlength\\parskip{\\smallskipamount}\n";
1950                                 break;
1951                         case VSpace::MEDSKIP:
1952                                 os << "\\setlength\\parskip{\\medskipamount}\n";
1953                                 break;
1954                         case VSpace::BIGSKIP:
1955                                 os << "\\setlength\\parskip{\\bigskipamount}\n";
1956                                 break;
1957                         case VSpace::LENGTH:
1958                                 os << "\\setlength\\parskip{"
1959                                     << params.defskip.length().asLatexString()
1960                                     << "}\n";
1961                                 break;
1962                         default: // should never happen // Then delete it.
1963                                 os << "\\setlength\\parskip{\\medskipamount}\n";
1964                                 break;
1965                         }
1966                         texrow.newline();
1967
1968                         os << "\\setlength\\parindent{0pt}\n";
1969                         texrow.newline();
1970                 }
1971
1972                 // Now insert the LyX specific LaTeX commands...
1973
1974                 // The optional packages;
1975                 string preamble(features.getPackages());
1976
1977                 // this might be useful...
1978                 preamble += "\n\\makeatletter\n";
1979
1980                 // Some macros LyX will need
1981                 string tmppreamble(features.getMacros());
1982
1983                 if (!tmppreamble.empty()) {
1984                         preamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1985                                 "LyX specific LaTeX commands.\n"
1986                                 + tmppreamble + '\n';
1987                 }
1988
1989                 // the text class specific preamble
1990                 tmppreamble = features.getTClassPreamble();
1991                 if (!tmppreamble.empty()) {
1992                         preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1993                                 "Textclass specific LaTeX commands.\n"
1994                                 + tmppreamble + '\n';
1995                 }
1996
1997                 /* the user-defined preamble */
1998                 if (!params.preamble.empty()) {
1999                         preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2000                                 "User specified LaTeX commands.\n"
2001                                 + params.preamble + '\n';
2002                 }
2003
2004                 // Itemize bullet settings need to be last in case the user
2005                 // defines their own bullets that use a package included
2006                 // in the user-defined preamble -- ARRae
2007                 // Actually it has to be done much later than that
2008                 // since some packages like frenchb make modifications
2009                 // at \begin{document} time -- JMarc
2010                 string bullets_def;
2011                 for (int i = 0; i < 4; ++i) {
2012                         if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
2013                                 if (bullets_def.empty())
2014                                         bullets_def="\\AtBeginDocument{\n";
2015                                 bullets_def += "  \\renewcommand{\\labelitemi";
2016                                 switch (i) {
2017                                 // `i' is one less than the item to modify
2018                                 case 0:
2019                                         break;
2020                                 case 1:
2021                                         bullets_def += 'i';
2022                                         break;
2023                                 case 2:
2024                                         bullets_def += "ii";
2025                                         break;
2026                                 case 3:
2027                                         bullets_def += 'v';
2028                                         break;
2029                                 }
2030                                 bullets_def += "}{" +
2031                                   params.user_defined_bullets[i].getText()
2032                                   + "}\n";
2033                         }
2034                 }
2035
2036                 if (!bullets_def.empty())
2037                   preamble += bullets_def + "}\n\n";
2038
2039                 int const nlines =
2040                         int(lyx::count(preamble.begin(), preamble.end(), '\n'));
2041                 for (int j = 0; j != nlines; ++j) {
2042                         texrow.newline();
2043                 }
2044
2045                 // We try to load babel late, in case it interferes
2046                 // with other packages.
2047                 if (use_babel) {
2048                         string tmp = lyxrc.language_package;
2049                         if (!lyxrc.language_global_options
2050                             && tmp == "\\usepackage{babel}")
2051                                 tmp = string("\\usepackage[") +
2052                                         language_options.str().c_str() +
2053                                         "]{babel}";
2054                         preamble += tmp + "\n";
2055                         preamble += features.getBabelOptions();
2056                 }
2057
2058                 preamble += "\\makeatother\n";
2059
2060                 os << preamble;
2061
2062                 if (only_preamble)
2063                         return;
2064
2065                 // make the body.
2066                 os << "\\begin{document}\n";
2067                 texrow.newline();
2068         } // only_body
2069         lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
2070
2071         if (!lyxrc.language_auto_begin) {
2072                 os << subst(lyxrc.language_command_begin, "$$lang",
2073                              params.language->babel())
2074                     << endl;
2075                 texrow.newline();
2076         }
2077
2078         latexParagraphs(os, &*(paragraphs.begin()), 0, texrow);
2079
2080         // add this just in case after all the paragraphs
2081         os << endl;
2082         texrow.newline();
2083
2084         if (!lyxrc.language_auto_end) {
2085                 os << subst(lyxrc.language_command_end, "$$lang",
2086                              params.language->babel())
2087                     << endl;
2088                 texrow.newline();
2089         }
2090
2091         if (!only_body) {
2092                 os << "\\end{document}\n";
2093                 texrow.newline();
2094
2095                 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
2096         } else {
2097                 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
2098                                      << endl;
2099         }
2100
2101         // Just to be sure. (Asger)
2102         texrow.newline();
2103
2104         lyxerr[Debug::INFO] << "Finished making latex file." << endl;
2105         lyxerr[Debug::INFO] << "Row count was " << texrow.rows()-1 << "." << endl;
2106
2107         // we want this to be true outside previews (for insetexternal)
2108         niceFile = true;
2109 }
2110
2111
2112 //
2113 // LaTeX all paragraphs from par to endpar, if endpar == 0 then to the end
2114 //
2115 void Buffer::latexParagraphs(ostream & ofs, Paragraph * par,
2116                              Paragraph * endpar, TexRow & texrow,
2117                              bool moving_arg) const
2118 {
2119         bool was_title = false;
2120         bool already_title = false;
2121
2122         // if only_body
2123         while (par != endpar) {
2124                 Inset * in = par->inInset();
2125                 // well we have to check if we are in an inset with unlimited
2126                 // length (all in one row) if that is true then we don't allow
2127                 // any special options in the paragraph and also we don't allow
2128                 // any environment other then "Standard" to be valid!
2129                 if ((in == 0) || !in->forceDefaultParagraphs(in)) {
2130                         LyXLayout_ptr const & layout = par->layout();
2131
2132                         if (layout->intitle) {
2133                                 if (already_title) {
2134                                         lyxerr <<"Error in latexParagraphs: You"
2135                                                 " should not mix title layouts"
2136                                                 " with normal ones." << endl;
2137                                 } else
2138                                         was_title = true;
2139                         } else if (was_title && !already_title) {
2140                                 ofs << "\\maketitle\n";
2141                                 texrow.newline();
2142                                 already_title = true;
2143                                 was_title = false;
2144                         }
2145
2146                         if (layout->isEnvironment() ||
2147                                 !par->params().leftIndent().zero())
2148                         {
2149                                 par = par->TeXEnvironment(this, params, ofs, texrow);
2150                         } else {
2151                                 par = par->TeXOnePar(this, params, ofs, texrow, moving_arg);
2152                         }
2153                 } else {
2154                         par = par->TeXOnePar(this, params, ofs, texrow, moving_arg);
2155                 }
2156         }
2157         // It might be that we only have a title in this document
2158         if (was_title && !already_title) {
2159                 ofs << "\\maketitle\n";
2160                 texrow.newline();
2161         }
2162 }
2163
2164
2165 bool Buffer::isLatex() const
2166 {
2167         return params.getLyXTextClass().outputType() == LATEX;
2168 }
2169
2170
2171 bool Buffer::isLinuxDoc() const
2172 {
2173         return params.getLyXTextClass().outputType() == LINUXDOC;
2174 }
2175
2176
2177 bool Buffer::isLiterate() const
2178 {
2179         return params.getLyXTextClass().outputType() == LITERATE;
2180 }
2181
2182
2183 bool Buffer::isDocBook() const
2184 {
2185         return params.getLyXTextClass().outputType() == DOCBOOK;
2186 }
2187
2188
2189 bool Buffer::isSGML() const
2190 {
2191         LyXTextClass const & tclass = params.getLyXTextClass();
2192
2193         return tclass.outputType() == LINUXDOC ||
2194                tclass.outputType() == DOCBOOK;
2195 }
2196
2197
2198 int Buffer::sgmlOpenTag(ostream & os, Paragraph::depth_type depth, bool mixcont,
2199                          string const & latexname) const
2200 {
2201         if (!latexname.empty() && latexname != "!-- --") {
2202                 if (!mixcont)
2203                         os << string(" ",depth);
2204                 os << "<" << latexname << ">";
2205         }
2206
2207         if (!mixcont)
2208                 os << endl;
2209
2210         return mixcont?0:1;
2211 }
2212
2213
2214 int Buffer::sgmlCloseTag(ostream & os, Paragraph::depth_type depth, bool mixcont,
2215                           string const & latexname) const
2216 {
2217         if (!latexname.empty() && latexname != "!-- --") {
2218                 if (!mixcont)
2219                         os << endl << string(" ",depth);
2220                 os << "</" << latexname << ">";
2221         }
2222
2223         if (!mixcont)
2224                 os << endl;
2225
2226         return mixcont?0:1;
2227 }
2228
2229
2230 void Buffer::makeLinuxDocFile(string const & fname, bool nice, bool body_only)
2231 {
2232         ofstream ofs(fname.c_str());
2233
2234         if (!ofs) {
2235                 Alert::alert(_("LYX_ERROR:"), _("Cannot write file"), fname);
2236                 return;
2237         }
2238
2239         niceFile = nice; // this will be used by included files.
2240
2241         LaTeXFeatures features(params);
2242
2243         validate(features);
2244
2245         texrow.reset();
2246
2247         LyXTextClass const & tclass = params.getLyXTextClass();
2248
2249         string top_element = tclass.latexname();
2250
2251         if (!body_only) {
2252                 ofs << "<!doctype linuxdoc system";
2253
2254                 string preamble = params.preamble;
2255                 const string name = nice ? ChangeExtension(filename_, ".sgml")
2256                          : fname;
2257                 preamble += features.getIncludedFiles(name);
2258                 preamble += features.getLyXSGMLEntities();
2259
2260                 if (!preamble.empty()) {
2261                         ofs << " [ " << preamble << " ]";
2262                 }
2263                 ofs << ">\n\n";
2264
2265                 if (params.options.empty())
2266                         sgmlOpenTag(ofs, 0, false, top_element);
2267                 else {
2268                         string top = top_element;
2269                         top += " ";
2270                         top += params.options;
2271                         sgmlOpenTag(ofs, 0, false, top);
2272                 }
2273         }
2274
2275         ofs << "<!-- "  << lyx_docversion
2276             << " created this file. For more info see http://www.lyx.org/"
2277             << " -->\n";
2278
2279         Paragraph::depth_type depth = 0; // paragraph depth
2280         Paragraph * par = &*(paragraphs.begin());
2281         string item_name;
2282         vector<string> environment_stack(5);
2283
2284         while (par) {
2285                 LyXLayout_ptr const & style = par->layout();
2286                 // treat <toc> as a special case for compatibility with old code
2287                 if (par->isInset(0)) {
2288                         Inset * inset = par->getInset(0);
2289                         Inset::Code lyx_code = inset->lyxCode();
2290                         if (lyx_code == Inset::TOC_CODE) {
2291                                 string const temp = "toc";
2292                                 sgmlOpenTag(ofs, depth, false, temp);
2293
2294                                 par = par->next();
2295                                 continue;
2296                         }
2297                 }
2298
2299                 // environment tag closing
2300                 for (; depth > par->params().depth(); --depth) {
2301                         sgmlCloseTag(ofs, depth, false, environment_stack[depth]);
2302                         environment_stack[depth].erase();
2303                 }
2304
2305                 // write opening SGML tags
2306                 switch (style->latextype) {
2307                 case LATEX_PARAGRAPH:
2308                         if (depth == par->params().depth()
2309                            && !environment_stack[depth].empty()) {
2310                                 sgmlCloseTag(ofs, depth, false, environment_stack[depth]);
2311                                 environment_stack[depth].erase();
2312                                 if (depth)
2313                                         --depth;
2314                                 else
2315                                         ofs << "</p>";
2316                         }
2317                         sgmlOpenTag(ofs, depth, false, style->latexname());
2318                         break;
2319
2320                 case LATEX_COMMAND:
2321                         if (depth!= 0)
2322                                 sgmlError(par, 0,
2323                                           _("Error : Wrong depth for"
2324                                             " LatexType Command.\n"));
2325
2326                         if (!environment_stack[depth].empty()) {
2327                                 sgmlCloseTag(ofs, depth, false, environment_stack[depth]);
2328                                 ofs << "</p>";
2329                         }
2330
2331                         environment_stack[depth].erase();
2332                         sgmlOpenTag(ofs, depth, false, style->latexname());
2333                         break;
2334
2335                 case LATEX_ENVIRONMENT:
2336                 case LATEX_ITEM_ENVIRONMENT:
2337                 {
2338                         string const & latexname = style->latexname();
2339
2340                         if (depth == par->params().depth()
2341                             && environment_stack[depth] != latexname) {
2342                                 sgmlCloseTag(ofs, depth, false,
2343                                              environment_stack[depth]);
2344                                 environment_stack[depth].erase();
2345                         }
2346                         if (depth < par->params().depth()) {
2347                                depth = par->params().depth();
2348                                environment_stack[depth].erase();
2349                         }
2350                         if (environment_stack[depth] != latexname) {
2351                                 if (depth == 0) {
2352                                         sgmlOpenTag(ofs, depth, false, "p");
2353                                 }
2354                                 sgmlOpenTag(ofs, depth, false, latexname);
2355
2356                                 if (environment_stack.size() == depth + 1)
2357                                         environment_stack.push_back("!-- --");
2358                                 environment_stack[depth] = latexname;
2359                         }
2360
2361                         if (style->latexparam() == "CDATA")
2362                                 ofs << "<![CDATA[";
2363
2364                         if (style->latextype == LATEX_ENVIRONMENT) break;
2365
2366                         if (style->labeltype == LABEL_MANUAL)
2367                                 item_name = "tag";
2368                         else
2369                                 item_name = "item";
2370
2371                         sgmlOpenTag(ofs, depth + 1, false, item_name);
2372                 }
2373                 break;
2374
2375                 default:
2376                         sgmlOpenTag(ofs, depth, false, style->latexname());
2377                         break;
2378                 }
2379
2380                 simpleLinuxDocOnePar(ofs, par, depth);
2381
2382                 par = par->next();
2383
2384                 ofs << "\n";
2385                 // write closing SGML tags
2386                 switch (style->latextype) {
2387                 case LATEX_COMMAND:
2388                         break;
2389                 case LATEX_ENVIRONMENT:
2390                 case LATEX_ITEM_ENVIRONMENT:
2391                         if (style->latexparam() == "CDATA")
2392                                 ofs << "]]>";
2393                         break;
2394                 default:
2395                         sgmlCloseTag(ofs, depth, false, style->latexname());
2396                         break;
2397                 }
2398         }
2399
2400         // Close open tags
2401         for (int i = depth; i >= 0; --i)
2402                 sgmlCloseTag(ofs, depth, false, environment_stack[i]);
2403
2404         if (!body_only) {
2405                 ofs << "\n\n";
2406                 sgmlCloseTag(ofs, 0, false, top_element);
2407         }
2408
2409         ofs.close();
2410         // How to check for successful close
2411
2412         // we want this to be true outside previews (for insetexternal)
2413         niceFile = true;
2414 }
2415
2416
2417 // checks, if newcol chars should be put into this line
2418 // writes newline, if necessary.
2419 namespace {
2420
2421 void sgmlLineBreak(ostream & os, string::size_type & colcount,
2422                           string::size_type newcol)
2423 {
2424         colcount += newcol;
2425         if (colcount > lyxrc.ascii_linelen) {
2426                 os << "\n";
2427                 colcount = newcol; // assume write after this call
2428         }
2429 }
2430
2431 enum PAR_TAG {
2432         NONE=0,
2433         TT = 1,
2434         SF = 2,
2435         BF = 4,
2436         IT = 8,
2437         SL = 16,
2438         EM = 32
2439 };
2440
2441
2442 string tag_name(PAR_TAG const & pt) {
2443         switch (pt) {
2444         case NONE: return "!-- --";
2445         case TT: return "tt";
2446         case SF: return "sf";
2447         case BF: return "bf";
2448         case IT: return "it";
2449         case SL: return "sl";
2450         case EM: return "em";
2451         }
2452         return "";
2453 }
2454
2455
2456 inline
2457 void operator|=(PAR_TAG & p1, PAR_TAG const & p2)
2458 {
2459         p1 = static_cast<PAR_TAG>(p1 | p2);
2460 }
2461
2462
2463 inline
2464 void reset(PAR_TAG & p1, PAR_TAG const & p2)
2465 {
2466         p1 = static_cast<PAR_TAG>(p1 & ~p2);
2467 }
2468
2469 } // anon
2470
2471
2472 // Handle internal paragraph parsing -- layout already processed.
2473 void Buffer::simpleLinuxDocOnePar(ostream & os,
2474         Paragraph * par,
2475         Paragraph::depth_type /*depth*/)
2476 {
2477         LyXLayout_ptr const & style = par->layout();
2478
2479         string::size_type char_line_count = 5;     // Heuristic choice ;-)
2480
2481         // gets paragraph main font
2482         LyXFont font_old;
2483         bool desc_on;
2484         if (style->labeltype == LABEL_MANUAL) {
2485                 font_old = style->labelfont;
2486                 desc_on = true;
2487         } else {
2488                 font_old = style->font;
2489                 desc_on = false;
2490         }
2491
2492         LyXFont::FONT_FAMILY family_type = LyXFont::ROMAN_FAMILY;
2493         LyXFont::FONT_SERIES series_type = LyXFont::MEDIUM_SERIES;
2494         LyXFont::FONT_SHAPE  shape_type  = LyXFont::UP_SHAPE;
2495         bool is_em = false;
2496
2497         stack<PAR_TAG> tag_state;
2498         // parsing main loop
2499         for (pos_type i = 0; i < par->size(); ++i) {
2500
2501                 PAR_TAG tag_close = NONE;
2502                 list < PAR_TAG > tag_open;
2503
2504                 LyXFont const font = par->getFont(params, i);
2505
2506                 if (font_old.family() != font.family()) {
2507                         switch (family_type) {
2508                         case LyXFont::SANS_FAMILY:
2509                                 tag_close |= SF;
2510                                 break;
2511                         case LyXFont::TYPEWRITER_FAMILY:
2512                                 tag_close |= TT;
2513                                 break;
2514                         default:
2515                                 break;
2516                         }
2517
2518                         family_type = font.family();
2519
2520                         switch (family_type) {
2521                         case LyXFont::SANS_FAMILY:
2522                                 tag_open.push_back(SF);
2523                                 break;
2524                         case LyXFont::TYPEWRITER_FAMILY:
2525                                 tag_open.push_back(TT);
2526                                 break;
2527                         default:
2528                                 break;
2529                         }
2530                 }
2531
2532                 if (font_old.series() != font.series()) {
2533                         switch (series_type) {
2534                         case LyXFont::BOLD_SERIES:
2535                                 tag_close |= BF;
2536                                 break;
2537                         default:
2538                                 break;
2539                         }
2540
2541                         series_type = font.series();
2542
2543                         switch (series_type) {
2544                         case LyXFont::BOLD_SERIES:
2545                                 tag_open.push_back(BF);
2546                                 break;
2547                         default:
2548                                 break;
2549                         }
2550
2551                 }
2552
2553                 if (font_old.shape() != font.shape()) {
2554                         switch (shape_type) {
2555                         case LyXFont::ITALIC_SHAPE:
2556                                 tag_close |= IT;
2557                                 break;
2558                         case LyXFont::SLANTED_SHAPE:
2559                                 tag_close |= SL;
2560                                 break;
2561                         default:
2562                                 break;
2563                         }
2564
2565                         shape_type = font.shape();
2566
2567                         switch (shape_type) {
2568                         case LyXFont::ITALIC_SHAPE:
2569                                 tag_open.push_back(IT);
2570                                 break;
2571                         case LyXFont::SLANTED_SHAPE:
2572                                 tag_open.push_back(SL);
2573                                 break;
2574                         default:
2575                                 break;
2576                         }
2577                 }
2578                 // handle <em> tag
2579                 if (font_old.emph() != font.emph()) {
2580                         if (font.emph() == LyXFont::ON) {
2581                                 tag_open.push_back(EM);
2582                                 is_em = true;
2583                         }
2584                         else if (is_em) {
2585                                 tag_close |= EM;
2586                                 is_em = false;
2587                         }
2588                 }
2589
2590                 list < PAR_TAG > temp;
2591                 while (!tag_state.empty() && tag_close) {
2592                         PAR_TAG k =  tag_state.top();
2593                         tag_state.pop();
2594                         os << "</" << tag_name(k) << ">";
2595                         if (tag_close & k)
2596                                 reset(tag_close,k);
2597                         else
2598                                 temp.push_back(k);
2599                 }
2600
2601                 for(list< PAR_TAG >::const_iterator j = temp.begin();
2602                     j != temp.end(); ++j) {
2603                         tag_state.push(*j);
2604                         os << "<" << tag_name(*j) << ">";
2605                 }
2606
2607                 for(list< PAR_TAG >::const_iterator j = tag_open.begin();
2608                     j != tag_open.end(); ++j) {
2609                         tag_state.push(*j);
2610                         os << "<" << tag_name(*j) << ">";
2611                 }
2612
2613                 char c = par->getChar(i);
2614
2615                 if (c == Paragraph::META_INSET) {
2616                         Inset * inset = par->getInset(i);
2617                         inset->linuxdoc(this, os);
2618                         font_old = font;
2619                         continue;
2620                 }
2621
2622                 if (style->latexparam() == "CDATA") {
2623                         // "TeX"-Mode on == > SGML-Mode on.
2624                         if (c != '\0')
2625                                 os << c;
2626                         ++char_line_count;
2627                 } else {
2628                         bool ws;
2629                         string str;
2630                         boost::tie(ws, str) = sgml::escapeChar(c);
2631                         if (ws && !style->free_spacing && !par->isFreeSpacing()) {
2632                                 // in freespacing mode, spaces are
2633                                 // non-breaking characters
2634                                 if (desc_on) {// if char is ' ' then...
2635
2636                                         ++char_line_count;
2637                                         sgmlLineBreak(os, char_line_count, 6);
2638                                         os << "</tag>";
2639                                         desc_on = false;
2640                                 } else  {
2641                                         sgmlLineBreak(os, char_line_count, 1);
2642                                         os << c;
2643                                 }
2644                         } else {
2645                                 os << str;
2646                                 char_line_count += str.length();
2647                         }
2648                 }
2649                 font_old = font;
2650         }
2651
2652         while (!tag_state.empty()) {
2653                 os << "</" << tag_name(tag_state.top()) << ">";
2654                 tag_state.pop();
2655         }
2656
2657         // resets description flag correctly
2658         if (desc_on) {
2659                 // <tag> not closed...
2660                 sgmlLineBreak(os, char_line_count, 6);
2661                 os << "</tag>";
2662         }
2663 }
2664
2665
2666 // Print an error message.
2667 void Buffer::sgmlError(Paragraph * /*par*/, int /*pos*/,
2668         string const & /*message*/) const
2669 {
2670 #ifdef WITH_WARNINGS
2671 #warning This is wrong we cannot insert an inset like this!!!
2672         // I guess this was Jose' so I explain you more or less why this
2673         // is wrong. This way you insert something in the paragraph and
2674         // don't tell it to LyXText (row rebreaking and undo handling!!!)
2675         // I deactivate this code, have a look at BufferView::insertErrors
2676         // how you should do this correctly! (Jug 20020315)
2677 #endif
2678 #if 0
2679         // insert an error marker in text
2680         InsetError * new_inset = new InsetError(message);
2681         par->insertInset(pos, new_inset, LyXFont(LyXFont::ALL_INHERIT,
2682                          params.language));
2683 #endif
2684 }
2685
2686
2687 void Buffer::makeDocBookFile(string const & fname, bool nice, bool only_body)
2688 {
2689         ofstream ofs(fname.c_str());
2690         if (!ofs) {
2691                 Alert::alert(_("LYX_ERROR:"), _("Cannot write file"), fname);
2692                 return;
2693         }
2694
2695         Paragraph * par = &*(paragraphs.begin());
2696
2697         niceFile = nice; // this will be used by Insetincludes.
2698
2699         LaTeXFeatures features(params);
2700         validate(features);
2701
2702         texrow.reset();
2703
2704         LyXTextClass const & tclass = params.getLyXTextClass();
2705         string top_element = tclass.latexname();
2706
2707         if (!only_body) {
2708                 ofs << "<!DOCTYPE " << top_element
2709                     << "  PUBLIC \"-//OASIS//DTD DocBook V4.1//EN\"";
2710
2711                 string preamble = params.preamble;
2712                 const string name = nice ? ChangeExtension(filename_, ".sgml")
2713                          : fname;
2714                 preamble += features.getIncludedFiles(name);
2715                 preamble += features.getLyXSGMLEntities();
2716
2717                 if (!preamble.empty()) {
2718                         ofs << "\n [ " << preamble << " ]";
2719                 }
2720                 ofs << ">\n\n";
2721         }
2722
2723         string top = top_element;
2724         top += " lang=\"";
2725         top += params.language->code();
2726         top += "\"";
2727
2728         if (!params.options.empty()) {
2729                 top += " ";
2730                 top += params.options;
2731         }
2732         sgmlOpenTag(ofs, 0, false, top);
2733
2734         ofs << "<!-- DocBook file was created by " << lyx_docversion
2735             << "\n  See http://www.lyx.org/ for more information -->\n";
2736
2737         vector<string> environment_stack(10);
2738         vector<string> environment_inner(10);
2739         vector<string> command_stack(10);
2740
2741         bool command_flag = false;
2742         Paragraph::depth_type command_depth = 0;
2743         Paragraph::depth_type command_base = 0;
2744         Paragraph::depth_type cmd_depth = 0;
2745         Paragraph::depth_type depth = 0; // paragraph depth
2746
2747         string item_name;
2748         string command_name;
2749
2750         while (par) {
2751                 string sgmlparam;
2752                 string c_depth;
2753                 string c_params;
2754                 int desc_on = 0; // description mode
2755
2756                 LyXLayout_ptr const & style = par->layout();
2757
2758                 // environment tag closing
2759                 for (; depth > par->params().depth(); --depth) {
2760                         if (environment_inner[depth] != "!-- --") {
2761                                 item_name = "listitem";
2762                                 sgmlCloseTag(ofs, command_depth + depth, false, item_name);
2763                                 if (environment_inner[depth] == "varlistentry")
2764                                         sgmlCloseTag(ofs, depth+command_depth, false, environment_inner[depth]);
2765                         }
2766                         sgmlCloseTag(ofs, depth + command_depth, false, environment_stack[depth]);
2767                         environment_stack[depth].erase();
2768                         environment_inner[depth].erase();
2769                 }
2770
2771                 if (depth == par->params().depth()
2772                    && environment_stack[depth] != style->latexname()
2773                    && !environment_stack[depth].empty()) {
2774                         if (environment_inner[depth] != "!-- --") {
2775                                 item_name= "listitem";
2776                                 sgmlCloseTag(ofs, command_depth+depth, false, item_name);
2777                                 if (environment_inner[depth] == "varlistentry")
2778                                         sgmlCloseTag(ofs, depth + command_depth, false, environment_inner[depth]);
2779                         }
2780
2781                         sgmlCloseTag(ofs, depth + command_depth, false, environment_stack[depth]);
2782
2783                         environment_stack[depth].erase();
2784                         environment_inner[depth].erase();
2785                 }
2786
2787                 // Write opening SGML tags.
2788                 switch (style->latextype) {
2789                 case LATEX_PARAGRAPH:
2790                         sgmlOpenTag(ofs, depth + command_depth,
2791                                     false, style->latexname());
2792                         break;
2793
2794                 case LATEX_COMMAND:
2795                         if (depth != 0)
2796                                 sgmlError(par, 0,
2797                                           _("Error : Wrong depth for "
2798                                             "LatexType Command.\n"));
2799
2800                         command_name = style->latexname();
2801
2802                         sgmlparam = style->latexparam();
2803                         c_params = split(sgmlparam, c_depth,'|');
2804
2805                         cmd_depth = lyx::atoi(c_depth);
2806
2807                         if (command_flag) {
2808                                 if (cmd_depth < command_base) {
2809                                         for (Paragraph::depth_type j = command_depth;
2810                                              j >= command_base; --j) {
2811                                                 sgmlCloseTag(ofs, j, false, command_stack[j]);
2812                                                 ofs << endl;
2813                                         }
2814                                         command_depth = command_base = cmd_depth;
2815                                 } else if (cmd_depth <= command_depth) {
2816                                         for (int j = command_depth;
2817                                              j >= int(cmd_depth); --j) {
2818                                                 sgmlCloseTag(ofs, j, false, command_stack[j]);
2819                                                 ofs << endl;
2820                                         }
2821                                         command_depth = cmd_depth;
2822                                 } else
2823                                         command_depth = cmd_depth;
2824                         } else {
2825                                 command_depth = command_base = cmd_depth;
2826                                 command_flag = true;
2827                         }
2828                         if (command_stack.size() == command_depth + 1)
2829                                 command_stack.push_back(string());
2830                         command_stack[command_depth] = command_name;
2831
2832                         // treat label as a special case for
2833                         // more WYSIWYM handling.
2834                         // This is a hack while paragraphs can't have
2835                         // attributes, like id in this case.
2836                         if (par->isInset(0)) {
2837                                 Inset * inset = par->getInset(0);
2838                                 Inset::Code lyx_code = inset->lyxCode();
2839                                 if (lyx_code == Inset::LABEL_CODE) {
2840                                         command_name += " id=\"";
2841                                         command_name += (static_cast<InsetCommand *>(inset))->getContents();
2842                                         command_name += "\"";
2843                                         desc_on = 3;
2844                                 }
2845                         }
2846
2847                         sgmlOpenTag(ofs, depth + command_depth, false, command_name);
2848
2849                         item_name = c_params.empty()?"title":c_params;
2850                         sgmlOpenTag(ofs, depth + 1 + command_depth, false, item_name);
2851                         break;
2852
2853                 case LATEX_ENVIRONMENT:
2854                 case LATEX_ITEM_ENVIRONMENT:
2855                         if (depth < par->params().depth()) {
2856                                 depth = par->params().depth();
2857                                 environment_stack[depth].erase();
2858                         }
2859
2860                         if (environment_stack[depth] != style->latexname()) {
2861                                 if (environment_stack.size() == depth + 1) {
2862                                         environment_stack.push_back("!-- --");
2863                                         environment_inner.push_back("!-- --");
2864                                 }
2865                                 environment_stack[depth] = style->latexname();
2866                                 environment_inner[depth] = "!-- --";
2867                                 sgmlOpenTag(ofs, depth + command_depth, false, environment_stack[depth]);
2868                         } else {
2869                                 if (environment_inner[depth] != "!-- --") {
2870                                         item_name= "listitem";
2871                                         sgmlCloseTag(ofs, command_depth + depth, false, item_name);
2872                                         if (environment_inner[depth] == "varlistentry")
2873                                                 sgmlCloseTag(ofs, depth + command_depth, false, environment_inner[depth]);
2874                                 }
2875                         }
2876
2877                         if (style->latextype == LATEX_ENVIRONMENT) {
2878                                 if (!style->latexparam().empty()) {
2879                                         if (style->latexparam() == "CDATA")
2880                                                 ofs << "<![CDATA[";
2881                                         else
2882                                                 sgmlOpenTag(ofs, depth + command_depth, false, style->latexparam());
2883                                 }
2884                                 break;
2885                         }
2886
2887                         desc_on = (style->labeltype == LABEL_MANUAL);
2888
2889                         environment_inner[depth] = desc_on ? "varlistentry" : "listitem";
2890                         sgmlOpenTag(ofs, depth + 1 + command_depth,
2891                                     false, environment_inner[depth]);
2892
2893                         item_name = desc_on ? "term" : "para";
2894                         sgmlOpenTag(ofs, depth + 1 + command_depth,
2895                                     false, item_name);
2896                         break;
2897                 default:
2898                         sgmlOpenTag(ofs, depth + command_depth,
2899                                     false, style->latexname());
2900                         break;
2901                 }
2902
2903                 simpleDocBookOnePar(ofs, par, desc_on,
2904                                     depth + 1 + command_depth);
2905                 par = par->next();
2906
2907                 string end_tag;
2908                 // write closing SGML tags
2909                 switch (style->latextype) {
2910                 case LATEX_COMMAND:
2911                         end_tag = c_params.empty() ? "title" : c_params;
2912                         sgmlCloseTag(ofs, depth + command_depth,
2913                                      false, end_tag);
2914                         break;
2915                 case LATEX_ENVIRONMENT:
2916                         if (!style->latexparam().empty()) {
2917                                 if (style->latexparam() == "CDATA")
2918                                         ofs << "]]>";
2919                                 else
2920                                         sgmlCloseTag(ofs, depth + command_depth, false, style->latexparam());
2921                         }
2922                         break;
2923                 case LATEX_ITEM_ENVIRONMENT:
2924                         if (desc_on == 1) break;
2925                         end_tag= "para";
2926                         sgmlCloseTag(ofs, depth + 1 + command_depth, false, end_tag);
2927                         break;
2928                 case LATEX_PARAGRAPH:
2929                         sgmlCloseTag(ofs, depth + command_depth, false, style->latexname());
2930                         break;
2931                 default:
2932                         sgmlCloseTag(ofs, depth + command_depth, false, style->latexname());
2933                         break;
2934                 }
2935         }
2936
2937         // Close open tags
2938         for (int d = depth; d >= 0; --d) {
2939                 if (!environment_stack[depth].empty()) {
2940                         if (environment_inner[depth] != "!-- --") {
2941                                 item_name = "listitem";
2942                                 sgmlCloseTag(ofs, command_depth + depth, false, item_name);
2943                                if (environment_inner[depth] == "varlistentry")
2944                                        sgmlCloseTag(ofs, depth + command_depth, false, environment_inner[depth]);
2945                         }
2946
2947                         sgmlCloseTag(ofs, depth + command_depth, false, environment_stack[depth]);
2948                 }
2949         }
2950
2951         for (int j = command_depth; j >= 0 ; --j)
2952                 if (!command_stack[j].empty()) {
2953                         sgmlCloseTag(ofs, j, false, command_stack[j]);
2954                         ofs << endl;
2955                 }
2956
2957         ofs << "\n\n";
2958         sgmlCloseTag(ofs, 0, false, top_element);
2959
2960         ofs.close();
2961         // How to check for successful close
2962
2963         // we want this to be true outside previews (for insetexternal)
2964         niceFile = true;
2965 }
2966
2967
2968 void Buffer::simpleDocBookOnePar(ostream & os,
2969                                  Paragraph * par, int & desc_on,
2970                                  Paragraph::depth_type depth) const
2971 {
2972         bool emph_flag = false;
2973
2974         LyXLayout_ptr const & style = par->layout();
2975
2976         LyXFont font_old = (style->labeltype == LABEL_MANUAL ? style->labelfont : style->font);
2977
2978         int char_line_count = depth;
2979         //if (!style.free_spacing)
2980         //      os << string(depth,' ');
2981
2982         // parsing main loop
2983         for (pos_type i = 0; i < par->size(); ++i) {
2984                 LyXFont font = par->getFont(params, i);
2985
2986                 // handle <emphasis> tag
2987                 if (font_old.emph() != font.emph()) {
2988                         if (font.emph() == LyXFont::ON) {
2989                                 if (style->latexparam() == "CDATA")
2990                                         os << "]]>";
2991                                 os << "<emphasis>";
2992                                 if (style->latexparam() == "CDATA")
2993                                         os << "<![CDATA[";
2994                                 emph_flag = true;
2995                         } else if (i) {
2996                                 if (style->latexparam() == "CDATA")
2997                                         os << "]]>";
2998                                 os << "</emphasis>";
2999                                 if (style->latexparam() == "CDATA")
3000                                         os << "<![CDATA[";
3001                                 emph_flag = false;
3002                         }
3003                 }
3004
3005
3006                 if (par->isInset(i)) {
3007                         Inset * inset = par->getInset(i);
3008                         // don't print the inset in position 0 if desc_on == 3 (label)
3009                         if (i || desc_on != 3) {
3010                                 if (style->latexparam() == "CDATA")
3011                                         os << "]]>";
3012                                 inset->docbook(this, os, false);
3013                                 if (style->latexparam() == "CDATA")
3014                                         os << "<![CDATA[";
3015                         }
3016                 } else {
3017                         char c = par->getChar(i);
3018                         bool ws;
3019                         string str;
3020                         boost::tie(ws, str) = sgml::escapeChar(c);
3021
3022                         if (style->pass_thru) {
3023                                 os << c;
3024                         } else if (style->free_spacing || par->isFreeSpacing() || c != ' ') {
3025                                         os << str;
3026                         } else if (desc_on ==1) {
3027                                 ++char_line_count;
3028                                 os << "\n</term><listitem><para>";
3029                                 desc_on = 2;
3030                         } else {
3031                                 os << ' ';
3032                         }
3033                 }
3034                 font_old = font;
3035         }
3036
3037         if (emph_flag) {
3038                 if (style->latexparam() == "CDATA")
3039                         os << "]]>";
3040                 os << "</emphasis>";
3041                 if (style->latexparam() == "CDATA")
3042                         os << "<![CDATA[";
3043         }
3044
3045         // resets description flag correctly
3046         if (desc_on == 1) {
3047                 // <term> not closed...
3048                 os << "</term>\n<listitem><para>&nbsp;</para>";
3049         }
3050         if (style->free_spacing)
3051                 os << '\n';
3052 }
3053
3054
3055 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
3056 // Other flags: -wall -v0 -x
3057 int Buffer::runChktex()
3058 {
3059         if (!users->text) return 0;
3060
3061         users->owner()->prohibitInput();
3062
3063         // get LaTeX-Filename
3064         string const name = getLatexName();
3065         string path = filePath();
3066
3067         string const org_path = path;
3068         if (lyxrc.use_tempdir || !IsDirWriteable(path)) {
3069                 path = tmppath;
3070         }
3071
3072         Path p(path); // path to LaTeX file
3073         users->owner()->message(_("Running chktex..."));
3074
3075         // Remove all error insets
3076         bool const removedErrorInsets = users->removeAutoInsets();
3077
3078         // Generate the LaTeX file if neccessary
3079         makeLaTeXFile(name, org_path, false);
3080
3081         TeXErrors terr;
3082         Chktex chktex(lyxrc.chktex_command, name, filePath());
3083         int res = chktex.run(terr); // run chktex
3084
3085         if (res == -1) {
3086                 Alert::alert(_("chktex did not work!"),
3087                            _("Could not run with file:"), name);
3088         } else if (res > 0) {
3089                 // Insert all errors as errors boxes
3090                 users->insertErrors(terr);
3091         }
3092
3093         // if we removed error insets before we ran chktex or if we inserted
3094         // error insets after we ran chktex, this must be run:
3095         if (removedErrorInsets || res) {
3096 #warning repaint needed here, or do you mean update() ?
3097                 users->repaint();
3098                 users->fitCursor();
3099         }
3100         users->owner()->allowInput();
3101
3102         return res;
3103 }
3104
3105
3106 void Buffer::validate(LaTeXFeatures & features) const
3107 {
3108         LyXTextClass const & tclass = params.getLyXTextClass();
3109
3110         // AMS Style is at document level
3111         if (params.use_amsmath || tclass.provides(LyXTextClass::amsmath))
3112                 features.require("amsmath");
3113
3114         for_each(paragraphs.begin(), paragraphs.end(),
3115                  boost::bind(&Paragraph::validate, _1, boost::ref(features)));
3116
3117         // the bullet shapes are buffer level not paragraph level
3118         // so they are tested here
3119         for (int i = 0; i < 4; ++i) {
3120                 if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
3121                         int const font = params.user_defined_bullets[i].getFont();
3122                         if (font == 0) {
3123                                 int const c = params
3124                                         .user_defined_bullets[i]
3125                                         .getCharacter();
3126                                 if (c == 16
3127                                    || c == 17
3128                                    || c == 25
3129                                    || c == 26
3130                                    || c == 31) {
3131                                         features.require("latexsym");
3132                                 }
3133                         } else if (font == 1) {
3134                                 features.require("amssymb");
3135                         } else if ((font >= 2 && font <= 5)) {
3136                                 features.require("pifont");
3137                         }
3138                 }
3139         }
3140
3141         if (lyxerr.debugging(Debug::LATEX)) {
3142                 features.showStruct();
3143         }
3144 }
3145
3146
3147 // This function should be in Buffer because it's a buffer's property (ale)
3148 string const Buffer::getIncludeonlyList(char delim)
3149 {
3150         string lst;
3151         for (inset_iterator it = inset_iterator_begin();
3152             it != inset_iterator_end(); ++it) {
3153                 if (it->lyxCode() == Inset::INCLUDE_CODE) {
3154                         InsetInclude & inc = static_cast<InsetInclude &>(*it);
3155                         if (inc.isIncludeOnly()) {
3156                                 if (!lst.empty())
3157                                         lst += delim;
3158                                 lst += inc.getRelFileBaseName();
3159                         }
3160                 }
3161         }
3162         lyxerr[Debug::INFO] << "Includeonly(" << lst << ')' << endl;
3163         return lst;
3164 }
3165
3166
3167 vector<string> const Buffer::getLabelList() const
3168 {
3169         /// if this is a child document and the parent is already loaded
3170         /// Use the parent's list instead  [ale990407]
3171         if (!params.parentname.empty()
3172             && bufferlist.exists(params.parentname)) {
3173                 Buffer const * tmp = bufferlist.getBuffer(params.parentname);
3174                 if (tmp)
3175                         return tmp->getLabelList();
3176         }
3177
3178         vector<string> label_list;
3179         for (inset_iterator it = inset_const_iterator_begin();
3180              it != inset_const_iterator_end(); ++it) {
3181                 vector<string> const l = it->getLabelList();
3182                 label_list.insert(label_list.end(), l.begin(), l.end());
3183         }
3184         return label_list;
3185 }
3186
3187
3188 // This is also a buffer property (ale)
3189 vector<pair<string, string> > const Buffer::getBibkeyList() const
3190 {
3191         typedef pair<string, string> StringPair;
3192         /// if this is a child document and the parent is already loaded
3193         /// Use the parent's list instead  [ale990412]
3194         if (!params.parentname.empty() && bufferlist.exists(params.parentname)) {
3195                 Buffer const * tmp = bufferlist.getBuffer(params.parentname);
3196                 if (tmp)
3197                         return tmp->getBibkeyList();
3198         }
3199
3200         vector<StringPair> keys;
3201         ParagraphList::iterator pit = paragraphs.begin();
3202         ParagraphList::iterator pend = paragraphs.end();
3203         for (; pit != pend; ++pit) {
3204                 if (pit->bibkey) {
3205                         string const key = pit->bibkey->getContents();
3206                         string const opt = pit->bibkey->getOptions();
3207                         string const ref = pit->asString(this, false);
3208                         string const info = opt + "TheBibliographyRef" + ref;
3209
3210                         keys.push_back(StringPair(key, info));
3211                 }
3212         }
3213
3214         if (!keys.empty())
3215                 return keys;
3216
3217         // Might be either using bibtex or a child has bibliography
3218         for (inset_iterator it = inset_const_iterator_begin();
3219                 it != inset_const_iterator_end(); ++it) {
3220                 // Search for Bibtex or Include inset
3221                 if (it->lyxCode() == Inset::BIBTEX_CODE) {
3222                         vector<StringPair> tmp =
3223                                 static_cast<InsetBibtex &>(*it).getKeys(this);
3224                         keys.insert(keys.end(), tmp.begin(), tmp.end());
3225                 } else if (it->lyxCode() == Inset::INCLUDE_CODE) {
3226                         vector<StringPair> const tmp =
3227                                 static_cast<InsetInclude &>(*it).getKeys();
3228                         keys.insert(keys.end(), tmp.begin(), tmp.end());
3229                 }
3230         }
3231
3232         return keys;
3233 }
3234
3235
3236 bool Buffer::isDepClean(string const & name) const
3237 {
3238         DEPCLEAN * item = dep_clean;
3239         while (item && item->master != name)
3240                 item = item->next;
3241         if (!item) return true;
3242         return item->clean;
3243 }
3244
3245
3246 void Buffer::markDepClean(string const & name)
3247 {
3248         if (!dep_clean) {
3249                 dep_clean = new DEPCLEAN;
3250                 dep_clean->clean = true;
3251                 dep_clean->master = name;
3252                 dep_clean->next = 0;
3253         } else {
3254                 DEPCLEAN * item = dep_clean;
3255                 while (item && item->master != name)
3256                         item = item->next;
3257                 if (item) {
3258                         item->clean = true;
3259                 } else {
3260                         item = new DEPCLEAN;
3261                         item->clean = true;
3262                         item->master = name;
3263                         item->next = 0;
3264                 }
3265         }
3266 }
3267
3268
3269 bool Buffer::dispatch(string const & command, bool * result)
3270 {
3271         // Split command string into command and argument
3272         string cmd;
3273         string line = ltrim(command);
3274         string const arg = trim(split(line, cmd, ' '));
3275
3276         return dispatch(lyxaction.LookupFunc(cmd), arg, result);
3277 }
3278
3279
3280 bool Buffer::dispatch(int action, string const & argument, bool * result)
3281 {
3282         bool dispatched = true;
3283
3284         switch (action) {
3285                 case LFUN_EXPORT: {
3286                         bool const tmp = Exporter::Export(this, argument, false);
3287                         if (result)
3288                                 *result = tmp;
3289                         break;
3290                 }
3291
3292                 default:
3293                         dispatched = false;
3294         }
3295         return dispatched;
3296 }
3297
3298
3299 void Buffer::resizeInsets(BufferView * bv)
3300 {
3301         /// then remove all LyXText in text-insets
3302         for_each(paragraphs.begin(), paragraphs.end(),
3303                  boost::bind(&Paragraph::resizeInsetsLyXText, _1, bv));
3304 }
3305
3306
3307 void Buffer::redraw()
3308 {
3309 #warning repaint needed here, or do you mean update() ?
3310         users->repaint();
3311         users->fitCursor();
3312 }
3313
3314
3315 void Buffer::changeLanguage(Language const * from, Language const * to)
3316 {
3317
3318         ParIterator end = par_iterator_end();
3319         for (ParIterator it = par_iterator_begin(); it != end; ++it)
3320                 (*it)->changeLanguage(params, from, to);
3321 }
3322
3323
3324 bool Buffer::isMultiLingual()
3325 {
3326         ParIterator end = par_iterator_end();
3327         for (ParIterator it = par_iterator_begin(); it != end; ++it)
3328                 if ((*it)->isMultiLingual(params))
3329                         return true;
3330
3331         return false;
3332 }
3333
3334
3335 Counters & Buffer::counters() const
3336 {
3337         return *ctrs.get();
3338 }
3339
3340
3341 void Buffer::inset_iterator::setParagraph()
3342 {
3343         while (pit != pend) {
3344                 it = pit->insetlist.begin();
3345                 if (it != pit->insetlist.end())
3346                         return;
3347                 ++pit;
3348         }
3349 }
3350
3351
3352 Inset * Buffer::getInsetFromID(int id_arg) const
3353 {
3354         for (inset_iterator it = inset_const_iterator_begin();
3355                  it != inset_const_iterator_end(); ++it)
3356         {
3357                 if (it->id() == id_arg)
3358                         return &(*it);
3359                 Inset * in = it->getInsetFromID(id_arg);
3360                 if (in)
3361                         return in;
3362         }
3363         return 0;
3364 }
3365
3366
3367 Paragraph * Buffer::getParFromID(int id) const
3368 {
3369         if (id < 0)
3370                 return 0;
3371
3372         ParagraphList::iterator it = paragraphs.begin();
3373         ParagraphList::iterator end = paragraphs.end();
3374         for (; it != end; ++it) {
3375                 if (it->id() == id) {
3376                         return &*it;
3377                 }
3378                 Paragraph * tmp = it->getParFromID(id);
3379                 if (tmp) {
3380                         return tmp;
3381                 }
3382         }
3383         return 0;
3384 }
3385
3386
3387 ParIterator Buffer::par_iterator_begin()
3388 {
3389         return ParIterator(&*(paragraphs.begin()));
3390 }
3391
3392
3393 ParIterator Buffer::par_iterator_end()
3394 {
3395         return ParIterator();
3396 }
3397
3398
3399 void Buffer::addUser(BufferView * u)
3400 {
3401         users = u;
3402 }
3403
3404
3405 void Buffer::delUser(BufferView *)
3406 {
3407         users = 0;
3408 }
3409
3410
3411 Language const * Buffer::getLanguage() const
3412 {
3413         return params.language;
3414 }
3415
3416
3417 bool Buffer::isClean() const
3418 {
3419         return lyx_clean;
3420 }
3421
3422
3423 bool Buffer::isBakClean() const
3424 {
3425         return bak_clean;
3426 }
3427
3428
3429 void Buffer::markClean() const
3430 {
3431         if (!lyx_clean) {
3432                 lyx_clean = true;
3433                 updateTitles();
3434         }
3435         // if the .lyx file has been saved, we don't need an
3436         // autosave
3437         bak_clean = true;
3438 }
3439
3440
3441 void Buffer::markBakClean()
3442 {
3443         bak_clean = true;
3444 }
3445
3446
3447 void Buffer::setUnnamed(bool flag)
3448 {
3449         unnamed = flag;
3450 }
3451
3452
3453 bool Buffer::isUnnamed()
3454 {
3455         return unnamed;
3456 }
3457
3458
3459 void Buffer::markDirty()
3460 {
3461         if (lyx_clean) {
3462                 lyx_clean = false;
3463                 updateTitles();
3464         }
3465         bak_clean = false;
3466         DEPCLEAN * tmp = dep_clean;
3467         while (tmp) {
3468                 tmp->clean = false;
3469                 tmp = tmp->next;
3470         }
3471 }
3472
3473
3474 string const & Buffer::fileName() const
3475 {
3476         return filename_;
3477 }
3478
3479
3480 string const & Buffer::filePath() const
3481 {
3482         return filepath_;
3483 }
3484
3485
3486 bool Buffer::isReadonly() const
3487 {
3488         return read_only;
3489 }
3490
3491
3492 BufferView * Buffer::getUser() const
3493 {
3494         return users;
3495 }
3496
3497
3498 void Buffer::setParentName(string const & name)
3499 {
3500         params.parentname = name;
3501 }
3502
3503
3504 Buffer::inset_iterator::inset_iterator()
3505         : pit(0), pend(0)
3506 {}
3507
3508
3509 Buffer::inset_iterator::inset_iterator(base_type p, base_type e)
3510         : pit(p), pend(e)
3511 {
3512         setParagraph();
3513 }
3514
3515
3516 Buffer::inset_iterator & Buffer::inset_iterator::operator++()
3517 {
3518         if (pit != pend) {
3519                 ++it;
3520                 if (it == pit->insetlist.end()) {
3521                         ++pit;
3522                         setParagraph();
3523                 }
3524         }
3525         return *this;
3526 }
3527
3528
3529 Buffer::inset_iterator Buffer::inset_iterator::operator++(int)
3530 {
3531         inset_iterator tmp = *this;
3532         ++*this;
3533         return tmp;
3534 }
3535
3536
3537 Buffer::inset_iterator::reference Buffer::inset_iterator::operator*()
3538 {
3539         return *it.getInset();
3540 }
3541
3542
3543 Buffer::inset_iterator::pointer Buffer::inset_iterator::operator->()
3544 {
3545         return it.getInset();
3546 }
3547
3548
3549 Paragraph * Buffer::inset_iterator::getPar()
3550 {
3551         return &(*pit);
3552 }
3553
3554
3555 lyx::pos_type Buffer::inset_iterator::getPos() const
3556 {
3557         return it.getPos();
3558 }
3559
3560
3561 bool operator==(Buffer::inset_iterator const & iter1,
3562                 Buffer::inset_iterator const & iter2)
3563 {
3564         return iter1.pit == iter2.pit
3565                 && (iter1.pit == iter1.pend || iter1.it == iter2.it);
3566 }
3567
3568
3569 bool operator!=(Buffer::inset_iterator const & iter1,
3570                 Buffer::inset_iterator const & iter2)
3571 {
3572         return !(iter1 == iter2);
3573 }