src/buffer.C

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