src/buffer.C

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