src/buffer.C

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