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