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 = rtrim(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 = rtrim(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 = rtrim(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 = rtrim(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                                         string const command = "lyx2lyx "
1712                                                 + QuoteName(filename_);
1713                                         cmd_ret const ret = RunCommand(command);
1714                                         if (ret.first) {
1715                                                 Alert::alert(_("ERROR!"),
1716                                                      _("An error occured while "
1717                                                        "running the conversion script."));
1718                                                 return false;
1719                                         }
1720                                         istringstream is(ret.second);
1721                                         LyXLex tmplex(0, 0);
1722                                         tmplex.setStream(is);
1723                                         return readFile(tmplex);
1724                                 }
1725                         }
1726                         bool the_end = readLyXformat2(lex, par);
1727                         params.setPaperStuff();
1728
1729 #if 0
1730                         // the_end was added in 213
1731                         if (file_format < 213)
1732                                 the_end = true;
1733 #endif
1734
1735                         if (!the_end) {
1736                                 Alert::alert(_("Warning!"),
1737                                            _("Reading of document is not complete"),
1738                                            _("Maybe the document is truncated"));
1739                         }
1740                         return true;
1741                 } else { // "\\lyxformat" not found
1742                         Alert::alert(_("ERROR!"), _("Not a LyX file!"));
1743                 }
1744         } else
1745                 Alert::alert(_("ERROR!"), _("Unable to read file!"));
1746         return false;
1747 }
1748
1749
1750 // Should probably be moved to somewhere else: BufferView? LyXView?
1751 bool Buffer::save() const
1752 {
1753         // We don't need autosaves in the immediate future. (Asger)
1754         resetAutosaveTimers();
1755
1756         // make a backup
1757         string s;
1758         if (lyxrc.make_backup) {
1759                 s = fileName() + '~';
1760                 if (!lyxrc.backupdir_path.empty())
1761                         s = AddName(lyxrc.backupdir_path,
1762                                     subst(os::slashify_path(s),'/','!'));
1763
1764                 // Rename is the wrong way of making a backup,
1765                 // this is the correct way.
1766                 /* truss cp fil fil2:
1767                    lstat("LyXVC3.lyx", 0xEFFFF898)                 Err#2 ENOENT
1768                    stat("LyXVC.lyx", 0xEFFFF688)                   = 0
1769                    open("LyXVC.lyx", O_RDONLY)                     = 3
1770                    open("LyXVC3.lyx", O_WRONLY|O_CREAT|O_TRUNC, 0600) = 4
1771                    fstat(4, 0xEFFFF508)                            = 0
1772                    fstat(3, 0xEFFFF508)                            = 0
1773                    read(3, " # T h i s   f i l e   w".., 8192)     = 5579
1774                    write(4, " # T h i s   f i l e   w".., 5579)    = 5579
1775                    read(3, 0xEFFFD4A0, 8192)                       = 0
1776                    close(4)                                        = 0
1777                    close(3)                                        = 0
1778                    chmod("LyXVC3.lyx", 0100644)                    = 0
1779                    lseek(0, 0, SEEK_CUR)                           = 46440
1780                    _exit(0)
1781                 */
1782
1783                 // Should probably have some more error checking here.
1784                 // Doing it this way, also makes the inodes stay the same.
1785                 // This is still not a very good solution, in particular we
1786                 // might loose the owner of the backup.
1787                 FileInfo finfo(fileName());
1788                 if (finfo.exist()) {
1789                         mode_t fmode = finfo.getMode();
1790                         struct utimbuf times = {
1791                                 finfo.getAccessTime(),
1792                                 finfo.getModificationTime() };
1793
1794                         ifstream ifs(fileName().c_str());
1795                         ofstream ofs(s.c_str(), ios::out|ios::trunc);
1796                         if (ifs && ofs) {
1797                                 ofs << ifs.rdbuf();
1798                                 ifs.close();
1799                                 ofs.close();
1800                                 ::chmod(s.c_str(), fmode);
1801
1802                                 if (::utime(s.c_str(), &times)) {
1803                                         lyxerr << "utime error." << endl;
1804                                 }
1805                         } else {
1806                                 lyxerr << "LyX was not able to make "
1807                                         "backup copy. Beware." << endl;
1808                         }
1809                 }
1810         }
1811
1812         if (writeFile(fileName())) {
1813                 markLyxClean();
1814                 removeAutosaveFile(fileName());
1815         } else {
1816                 // Saving failed, so backup is not backup
1817                 if (lyxrc.make_backup) {
1818                         lyx::rename(s, fileName());
1819                 }
1820                 return false;
1821         }
1822         return true;
1823 }
1824
1825
1826 bool Buffer::writeFile(string const & fname) const
1827 {
1828         if (read_only && (fname == fileName())) {
1829                 return false;
1830         }
1831
1832         FileInfo finfo(fname);
1833         if (finfo.exist() && !finfo.writable()) {
1834                 return false;
1835         }
1836
1837         ofstream ofs(fname.c_str());
1838         if (!ofs) {
1839                 return false;
1840         }
1841
1842 #ifdef HAVE_LOCALE
1843         // Use the standard "C" locale for file output.
1844         ofs.imbue(std::locale::classic());
1845 #endif
1846
1847         // The top of the file should not be written by params.
1848
1849         // write out a comment in the top of the file
1850         ofs << '#' << lyx_docversion
1851             << " created this file. For more info see http://www.lyx.org/\n"
1852             << "\\lyxformat " << LYX_FORMAT << "\n";
1853
1854         // now write out the buffer paramters.
1855         params.writeFile(ofs);
1856
1857         Paragraph::depth_type depth = 0;
1858
1859         // this will write out all the paragraphs
1860         // using recursive descent.
1861         paragraph->writeFile(this, ofs, params, depth);
1862
1863         // Write marker that shows file is complete
1864         ofs << "\n\\the_end" << endl;
1865
1866         ofs.close();
1867
1868         // how to check if close went ok?
1869         // Following is an attempt... (BE 20001011)
1870
1871         // good() returns false if any error occured, including some
1872         //        formatting error.
1873         // bad()  returns true if something bad happened in the buffer,
1874         //        which should include file system full errors.
1875
1876         bool status = true;
1877         if (!ofs.good()) {
1878                 status = false;
1879 #if 0
1880                 if (ofs.bad()) {
1881                         lyxerr << "Buffer::writeFile: BAD ERROR!" << endl;
1882                 } else {
1883                         lyxerr << "Buffer::writeFile: NOT SO BAD ERROR!"
1884                                << endl;
1885                 }
1886 #endif
1887         }
1888
1889         return status;
1890 }
1891
1892
1893 namespace {
1894
1895 pair<int, string> const addDepth(int depth, int ldepth)
1896 {
1897         int d = depth * 2;
1898         if (ldepth > depth)
1899                 d += (ldepth - depth) * 2;
1900         return make_pair(d, string(d, ' '));
1901 }
1902
1903 }
1904
1905
1906 string const Buffer::asciiParagraph(Paragraph const * par,
1907                                     unsigned int linelen,
1908                                     bool noparbreak) const
1909 {
1910         ostringstream buffer;
1911         Paragraph::depth_type depth = 0;
1912         int ltype = 0;
1913         Paragraph::depth_type ltype_depth = 0;
1914         bool ref_printed = false;
1915 //      if (!par->previous()) {
1916 #if 0
1917         // begins or ends a deeper area ?
1918         if (depth != par->params().depth()) {
1919                 if (par->params().depth() > depth) {
1920                         while (par->params().depth() > depth) {
1921                                 ++depth;
1922                         }
1923                 } else {
1924                         while (par->params().depth() < depth) {
1925                                 --depth;
1926                         }
1927                 }
1928         }
1929 #else
1930         depth = par->params().depth();
1931 #endif
1932
1933         // First write the layout
1934         string const & tmp = par->layout()->name();
1935         if (compare_no_case(tmp, "itemize") == 0) {
1936                 ltype = 1;
1937                 ltype_depth = depth + 1;
1938         } else if (compare_ascii_no_case(tmp, "enumerate") == 0) {
1939                 ltype = 2;
1940                 ltype_depth = depth + 1;
1941         } else if (contains(ascii_lowercase(tmp), "ection")) {
1942                 ltype = 3;
1943                 ltype_depth = depth + 1;
1944         } else if (contains(ascii_lowercase(tmp), "aragraph")) {
1945                 ltype = 4;
1946                 ltype_depth = depth + 1;
1947         } else if (compare_ascii_no_case(tmp, "description") == 0) {
1948                 ltype = 5;
1949                 ltype_depth = depth + 1;
1950         } else if (compare_ascii_no_case(tmp, "abstract") == 0) {
1951                 ltype = 6;
1952                 ltype_depth = 0;
1953         } else if (compare_ascii_no_case(tmp, "bibliography") == 0) {
1954                 ltype = 7;
1955                 ltype_depth = 0;
1956         } else {
1957                 ltype = 0;
1958                 ltype_depth = 0;
1959         }
1960
1961         /* maybe some vertical spaces */
1962
1963         /* the labelwidthstring used in lists */
1964
1965         /* some lines? */
1966
1967         /* some pagebreaks? */
1968
1969         /* noindent ? */
1970
1971         /* what about the alignment */
1972 //      } else {
1973 //              lyxerr << "Should this ever happen?" << endl;
1974 //      }
1975
1976         // linelen <= 0 is special and means we don't have pargraph breaks
1977
1978         string::size_type currlinelen = 0;
1979
1980         if (!noparbreak) {
1981                 if (linelen > 0)
1982                         buffer << "\n\n";
1983
1984                 buffer << string(depth * 2, ' ');
1985                 currlinelen += depth * 2;
1986
1987                 //--
1988                 // we should probably change to the paragraph language in the
1989                 // gettext here (if possible) so that strings are outputted in
1990                 // the correct language! (20012712 Jug)
1991                 //--
1992                 switch (ltype) {
1993                 case 0: // Standard
1994                 case 4: // (Sub)Paragraph
1995                 case 5: // Description
1996                         break;
1997                 case 6: // Abstract
1998                         if (linelen > 0) {
1999                                 buffer << _("Abstract") << "\n\n";
2000                                 currlinelen = 0;
2001                         } else {
2002                                 string const abst = _("Abstract: ");
2003                                 buffer << abst;
2004                                 currlinelen += abst.length();
2005                         }
2006                         break;
2007                 case 7: // Bibliography
2008                         if (!ref_printed) {
2009                                 if (linelen > 0) {
2010                                         buffer << _("References") << "\n\n";
2011                                         currlinelen = 0;
2012                                 } else {
2013                                         string const refs = _("References: ");
2014                                         buffer << refs;
2015                                         currlinelen += refs.length();
2016                                 }
2017
2018                                 ref_printed = true;
2019                         }
2020                         break;
2021                 default:
2022                 {
2023                         string const parlab = par->params().labelString();
2024                         buffer << parlab << " ";
2025                         currlinelen += parlab.length() + 1;
2026                 }
2027                 break;
2028
2029                 }
2030         }
2031
2032         if (!currlinelen) {
2033                 pair<int, string> p = addDepth(depth, ltype_depth);
2034                 buffer << p.second;
2035                 currlinelen += p.first;
2036         }
2037
2038         // this is to change the linebreak to do it by word a bit more
2039         // intelligent hopefully! (only in the case where we have a
2040         // max linelenght!) (Jug)
2041
2042         string word;
2043
2044         for (pos_type i = 0; i < par->size(); ++i) {
2045                 char c = par->getUChar(params, i);
2046                 switch (c) {
2047                 case Paragraph::META_INSET:
2048                 {
2049                         Inset const * inset = par->getInset(i);
2050                         if (inset) {
2051                                 if (linelen > 0) {
2052                                         buffer << word;
2053                                         currlinelen += word.length();
2054                                         word.erase();
2055                                 }
2056                                 if (inset->ascii(this, buffer, linelen)) {
2057                                         // to be sure it breaks paragraph
2058                                         currlinelen += linelen;
2059                                 }
2060                         }
2061                 }
2062                 break;
2063
2064                 case Paragraph::META_NEWLINE:
2065                         if (linelen > 0) {
2066                                 buffer << word << "\n";
2067                                 word.erase();
2068
2069                                 pair<int, string> p = addDepth(depth,
2070                                                                ltype_depth);
2071                                 buffer << p.second;
2072                                 currlinelen = p.first;
2073                         }
2074                         break;
2075
2076                 case Paragraph::META_HFILL:
2077                         buffer << word << "\t";
2078                         currlinelen += word.length() + 1;
2079                         word.erase();
2080                         break;
2081
2082                 default:
2083                         if (c == ' ') {
2084                                 if (linelen > 0 &&
2085                                     currlinelen + word.length() > linelen - 10) {
2086                                         buffer << "\n";
2087                                         pair<int, string> p =
2088                                                 addDepth(depth, ltype_depth);
2089                                         buffer << p.second;
2090                                         currlinelen = p.first;
2091                                 }
2092
2093                                 buffer << word << ' ';
2094                                 currlinelen += word.length() + 1;
2095                                 word.erase();
2096
2097                         } else {
2098                                 if (c != '\0') {
2099                                         word += c;
2100                                 } else {
2101                                         lyxerr[Debug::INFO] <<
2102                                                 "writeAsciiFile: NULL char in structure." << endl;
2103                                 }
2104                                 if ((linelen > 0) &&
2105                                         (currlinelen + word.length()) > linelen)
2106                                 {
2107                                         buffer << "\n";
2108
2109                                         pair<int, string> p =
2110                                                 addDepth(depth, ltype_depth);
2111                                         buffer << p.second;
2112                                         currlinelen = p.first;
2113                                 }
2114                         }
2115                         break;
2116                 }
2117         }
2118         buffer << word;
2119         return buffer.str().c_str();
2120 }
2121
2122
2123 void Buffer::writeFileAscii(string const & fname, int linelen)
2124 {
2125         ofstream ofs(fname.c_str());
2126         if (!ofs) {
2127                 Alert::err_alert(_("Error: Cannot write file:"), fname);
2128                 return;
2129         }
2130         writeFileAscii(ofs, linelen);
2131 }
2132
2133
2134 void Buffer::writeFileAscii(ostream & ofs, int linelen)
2135 {
2136         Paragraph * par = paragraph;
2137         while (par) {
2138                 ofs << asciiParagraph(par, linelen, par->previous() == 0);
2139                 par = par->next();
2140         }
2141         ofs << "\n";
2142 }
2143
2144
2145 bool use_babel;
2146
2147
2148 void Buffer::makeLaTeXFile(string const & fname,
2149                            string const & original_path,
2150                            bool nice, bool only_body, bool only_preamble)
2151 {
2152         lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
2153
2154         ofstream ofs(fname.c_str());
2155         if (!ofs) {
2156                 Alert::err_alert(_("Error: Cannot open file: "), fname);
2157                 return;
2158         }
2159
2160         makeLaTeXFile(ofs, original_path, nice, only_body, only_preamble);
2161
2162         ofs.close();
2163         if (ofs.fail()) {
2164                 lyxerr << "File was not closed properly." << endl;
2165         }
2166 }
2167
2168
2169 void Buffer::makeLaTeXFile(ostream & os,
2170                            string const & original_path,
2171                            bool nice, bool only_body, bool only_preamble)
2172 {
2173         niceFile = nice; // this will be used by Insetincludes.
2174
2175         tex_code_break_column = lyxrc.ascii_linelen;
2176
2177         // validate the buffer.
2178         lyxerr[Debug::LATEX] << "  Validating buffer..." << endl;
2179         LaTeXFeatures features(params);
2180         validate(features);
2181         lyxerr[Debug::LATEX] << "  Buffer validation done." << endl;
2182
2183         texrow.reset();
2184         // The starting paragraph of the coming rows is the
2185         // first paragraph of the document. (Asger)
2186         texrow.start(paragraph, 0);
2187
2188         if (!only_body && nice) {
2189                 os << "%% " << lyx_docversion << " created this file.  "
2190                         "For more info, see http://www.lyx.org/.\n"
2191                         "%% Do not edit unless you really know what "
2192                         "you are doing.\n";
2193                 texrow.newline();
2194                 texrow.newline();
2195         }
2196         lyxerr[Debug::INFO] << "lyx header finished" << endl;
2197         // There are a few differences between nice LaTeX and usual files:
2198         // usual is \batchmode and has a
2199         // special input@path to allow the including of figures
2200         // with either \input or \includegraphics (what figinsets do).
2201         // batchmode is not set if there is a tex_code_break_column.
2202         // In this case somebody is interested in the generated LaTeX,
2203         // so this is OK. input@path is set when the actual parameter
2204         // original_path is set. This is done for usual tex-file, but not
2205         // for nice-latex-file. (Matthias 250696)
2206         if (!only_body) {
2207                 if (!nice) {
2208                         // code for usual, NOT nice-latex-file
2209                         os << "\\batchmode\n"; // changed
2210                         // from \nonstopmode
2211                         texrow.newline();
2212                 }
2213                 if (!original_path.empty()) {
2214                         string inputpath = os::external_path(original_path);
2215                         subst(inputpath, "~", "\\string~");
2216                         os << "\\makeatletter\n"
2217                             << "\\def\\input@path{{"
2218                             << inputpath << "/}}\n"
2219                             << "\\makeatother\n";
2220                         texrow.newline();
2221                         texrow.newline();
2222                         texrow.newline();
2223                 }
2224
2225                 os << "\\documentclass";
2226
2227                 LyXTextClass const & tclass = params.getLyXTextClass();
2228
2229                 ostringstream options; // the document class options.
2230
2231                 if (tokenPos(tclass.opt_fontsize(),
2232                              '|', params.fontsize) >= 0) {
2233                         // only write if existing in list (and not default)
2234                         options << params.fontsize << "pt,";
2235                 }
2236
2237
2238                 if (!params.use_geometry &&
2239                     (params.paperpackage == BufferParams::PACKAGE_NONE)) {
2240                         switch (params.papersize) {
2241                         case BufferParams::PAPER_A4PAPER:
2242                                 options << "a4paper,";
2243                                 break;
2244                         case BufferParams::PAPER_USLETTER:
2245                                 options << "letterpaper,";
2246                                 break;
2247                         case BufferParams::PAPER_A5PAPER:
2248                                 options << "a5paper,";
2249                                 break;
2250                         case BufferParams::PAPER_B5PAPER:
2251                                 options << "b5paper,";
2252                                 break;
2253                         case BufferParams::PAPER_EXECUTIVEPAPER:
2254                                 options << "executivepaper,";
2255                                 break;
2256                         case BufferParams::PAPER_LEGALPAPER:
2257                                 options << "legalpaper,";
2258                                 break;
2259                         }
2260                 }
2261
2262                 // if needed
2263                 if (params.sides != tclass.sides()) {
2264                         switch (params.sides) {
2265                         case LyXTextClass::OneSide:
2266                                 options << "oneside,";
2267                                 break;
2268                         case LyXTextClass::TwoSides:
2269                                 options << "twoside,";
2270                                 break;
2271                         }
2272                 }
2273
2274                 // if needed
2275                 if (params.columns != tclass.columns()) {
2276                         if (params.columns == 2)
2277                                 options << "twocolumn,";
2278                         else
2279                                 options << "onecolumn,";
2280                 }
2281
2282                 if (!params.use_geometry
2283                     && params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
2284                         options << "landscape,";
2285
2286                 // language should be a parameter to \documentclass
2287                 use_babel = false;
2288                 ostringstream language_options;
2289                 if (params.language->babel() == "hebrew"
2290                     && default_language->babel() != "hebrew")
2291                          // This seems necessary
2292                         features.useLanguage(default_language);
2293
2294                 if (lyxrc.language_use_babel ||
2295                     params.language->lang() != lyxrc.default_language ||
2296                     features.hasLanguages()) {
2297                         use_babel = true;
2298                         language_options << features.getLanguages();
2299                         language_options << params.language->babel();
2300                         if (lyxrc.language_global_options)
2301                                 options << language_options.str() << ',';
2302                 }
2303
2304                 // the user-defined options
2305                 if (!params.options.empty()) {
2306                         options << params.options << ',';
2307                 }
2308
2309                 string strOptions(options.str().c_str());
2310                 if (!strOptions.empty()) {
2311                         strOptions = rtrim(strOptions, ",");
2312                         os << '[' << strOptions << ']';
2313                 }
2314
2315                 os << '{' << tclass.latexname() << "}\n";
2316                 texrow.newline();
2317                 // end of \documentclass defs
2318
2319                 // font selection must be done before loading fontenc.sty
2320                 // The ae package is not needed when using OT1 font encoding.
2321                 if (params.fonts != "default" &&
2322                     (params.fonts != "ae" || lyxrc.fontenc != "default")) {
2323                         os << "\\usepackage{" << params.fonts << "}\n";
2324                         texrow.newline();
2325                         if (params.fonts == "ae") {
2326                                 os << "\\usepackage{aecompl}\n";
2327                                 texrow.newline();
2328                         }
2329                 }
2330                 // this one is not per buffer
2331                 if (lyxrc.fontenc != "default") {
2332                         os << "\\usepackage[" << lyxrc.fontenc
2333                             << "]{fontenc}\n";
2334                         texrow.newline();
2335                 }
2336
2337                 if (params.inputenc == "auto") {
2338                         string const doc_encoding =
2339                                 params.language->encoding()->LatexName();
2340
2341                         // Create a list with all the input encodings used
2342                         // in the document
2343                         set<string> encodings = features.getEncodingSet(doc_encoding);
2344
2345                         os << "\\usepackage[";
2346                         std::copy(encodings.begin(), encodings.end(),
2347                                   std::ostream_iterator<string>(os, ","));
2348                         os << doc_encoding << "]{inputenc}\n";
2349                         texrow.newline();
2350                 } else if (params.inputenc != "default") {
2351                         os << "\\usepackage[" << params.inputenc
2352                             << "]{inputenc}\n";
2353                         texrow.newline();
2354                 }
2355
2356                 // At the very beginning the text parameters.
2357                 if (params.paperpackage != BufferParams::PACKAGE_NONE) {
2358                         switch (params.paperpackage) {
2359                         case BufferParams::PACKAGE_A4:
2360                                 os << "\\usepackage{a4}\n";
2361                                 texrow.newline();
2362                                 break;
2363                         case BufferParams::PACKAGE_A4WIDE:
2364                                 os << "\\usepackage{a4wide}\n";
2365                                 texrow.newline();
2366                                 break;
2367                         case BufferParams::PACKAGE_WIDEMARGINSA4:
2368                                 os << "\\usepackage[widemargins]{a4}\n";
2369                                 texrow.newline();
2370                                 break;
2371                         }
2372                 }
2373                 if (params.use_geometry) {
2374                         os << "\\usepackage{geometry}\n";
2375                         texrow.newline();
2376                         os << "\\geometry{verbose";
2377                         if (params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
2378                                 os << ",landscape";
2379                         switch (params.papersize2) {
2380                         case BufferParams::VM_PAPER_CUSTOM:
2381                                 if (!params.paperwidth.empty())
2382                                         os << ",paperwidth="
2383                                             << params.paperwidth;
2384                                 if (!params.paperheight.empty())
2385                                         os << ",paperheight="
2386                                             << params.paperheight;
2387                                 break;
2388                         case BufferParams::VM_PAPER_USLETTER:
2389                                 os << ",letterpaper";
2390                                 break;
2391                         case BufferParams::VM_PAPER_USLEGAL:
2392                                 os << ",legalpaper";
2393                                 break;
2394                         case BufferParams::VM_PAPER_USEXECUTIVE:
2395                                 os << ",executivepaper";
2396                                 break;
2397                         case BufferParams::VM_PAPER_A3:
2398                                 os << ",a3paper";
2399                                 break;
2400                         case BufferParams::VM_PAPER_A4:
2401                                 os << ",a4paper";
2402                                 break;
2403                         case BufferParams::VM_PAPER_A5:
2404                                 os << ",a5paper";
2405                                 break;
2406                         case BufferParams::VM_PAPER_B3:
2407                                 os << ",b3paper";
2408                                 break;
2409                         case BufferParams::VM_PAPER_B4:
2410                                 os << ",b4paper";
2411                                 break;
2412                         case BufferParams::VM_PAPER_B5:
2413                                 os << ",b5paper";
2414                                 break;
2415                         default:
2416                                 // default papersize ie BufferParams::VM_PAPER_DEFAULT
2417                                 switch (lyxrc.default_papersize) {
2418                                 case BufferParams::PAPER_DEFAULT: // keep compiler happy
2419                                 case BufferParams::PAPER_USLETTER:
2420                                         os << ",letterpaper";
2421                                         break;
2422                                 case BufferParams::PAPER_LEGALPAPER:
2423                                         os << ",legalpaper";
2424                                         break;
2425                                 case BufferParams::PAPER_EXECUTIVEPAPER:
2426                                         os << ",executivepaper";
2427                                         break;
2428                                 case BufferParams::PAPER_A3PAPER:
2429                                         os << ",a3paper";
2430                                         break;
2431                                 case BufferParams::PAPER_A4PAPER:
2432                                         os << ",a4paper";
2433                                         break;
2434                                 case BufferParams::PAPER_A5PAPER:
2435                                         os << ",a5paper";
2436                                         break;
2437                                 case BufferParams::PAPER_B5PAPER:
2438                                         os << ",b5paper";
2439                                         break;
2440                                 }
2441                         }
2442                         if (!params.topmargin.empty())
2443                                 os << ",tmargin=" << params.topmargin;
2444                         if (!params.bottommargin.empty())
2445                                 os << ",bmargin=" << params.bottommargin;
2446                         if (!params.leftmargin.empty())
2447                                 os << ",lmargin=" << params.leftmargin;
2448                         if (!params.rightmargin.empty())
2449                                 os << ",rmargin=" << params.rightmargin;
2450                         if (!params.headheight.empty())
2451                                 os << ",headheight=" << params.headheight;
2452                         if (!params.headsep.empty())
2453                                 os << ",headsep=" << params.headsep;
2454                         if (!params.footskip.empty())
2455                                 os << ",footskip=" << params.footskip;
2456                         os << "}\n";
2457                         texrow.newline();
2458                 }
2459
2460                 if (tokenPos(tclass.opt_pagestyle(),
2461                              '|', params.pagestyle) >= 0) {
2462                         if (params.pagestyle == "fancy") {
2463                                 os << "\\usepackage{fancyhdr}\n";
2464                                 texrow.newline();
2465                         }
2466                         os << "\\pagestyle{" << params.pagestyle << "}\n";
2467                         texrow.newline();
2468                 }
2469
2470                 if (params.secnumdepth != tclass.secnumdepth()) {
2471                         os << "\\setcounter{secnumdepth}{"
2472                             << params.secnumdepth
2473                             << "}\n";
2474                         texrow.newline();
2475                 }
2476                 if (params.tocdepth != tclass.tocdepth()) {
2477                         os << "\\setcounter{tocdepth}{"
2478                             << params.tocdepth
2479                             << "}\n";
2480                         texrow.newline();
2481                 }
2482
2483                 if (params.paragraph_separation) {
2484                         switch (params.defskip.kind()) {
2485                         case VSpace::SMALLSKIP:
2486                                 os << "\\setlength\\parskip{\\smallskipamount}\n";
2487                                 break;
2488                         case VSpace::MEDSKIP:
2489                                 os << "\\setlength\\parskip{\\medskipamount}\n";
2490                                 break;
2491                         case VSpace::BIGSKIP:
2492                                 os << "\\setlength\\parskip{\\bigskipamount}\n";
2493                                 break;
2494                         case VSpace::LENGTH:
2495                                 os << "\\setlength\\parskip{"
2496                                     << params.defskip.length().asLatexString()
2497                                     << "}\n";
2498                                 break;
2499                         default: // should never happen // Then delete it.
2500                                 os << "\\setlength\\parskip{\\medskipamount}\n";
2501                                 break;
2502                         }
2503                         texrow.newline();
2504
2505                         os << "\\setlength\\parindent{0pt}\n";
2506                         texrow.newline();
2507                 }
2508
2509                 // Now insert the LyX specific LaTeX commands...
2510
2511                 // The optional packages;
2512                 string preamble(features.getPackages());
2513
2514                 // this might be useful...
2515                 preamble += "\n\\makeatletter\n";
2516
2517                 // Some macros LyX will need
2518                 string tmppreamble(features.getMacros());
2519
2520                 if (!tmppreamble.empty()) {
2521                         preamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2522                                 "LyX specific LaTeX commands.\n"
2523                                 + tmppreamble + '\n';
2524                 }
2525
2526                 // the text class specific preamble
2527                 tmppreamble = features.getTClassPreamble();
2528                 if (!tmppreamble.empty()) {
2529                         preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2530                                 "Textclass specific LaTeX commands.\n"
2531                                 + tmppreamble + '\n';
2532                 }
2533
2534                 /* the user-defined preamble */
2535                 if (!params.preamble.empty()) {
2536                         preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2537                                 "User specified LaTeX commands.\n"
2538                                 + params.preamble + '\n';
2539                 }
2540
2541                 // Itemize bullet settings need to be last in case the user
2542                 // defines their own bullets that use a package included
2543                 // in the user-defined preamble -- ARRae
2544                 // Actually it has to be done much later than that
2545                 // since some packages like frenchb make modifications
2546                 // at \begin{document} time -- JMarc
2547                 string bullets_def;
2548                 for (int i = 0; i < 4; ++i) {
2549                         if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
2550                                 if (bullets_def.empty())
2551                                         bullets_def="\\AtBeginDocument{\n";
2552                                 bullets_def += "  \\renewcommand{\\labelitemi";
2553                                 switch (i) {
2554                                 // `i' is one less than the item to modify
2555                                 case 0:
2556                                         break;
2557                                 case 1:
2558                                         bullets_def += 'i';
2559                                         break;
2560                                 case 2:
2561                                         bullets_def += "ii";
2562                                         break;
2563                                 case 3:
2564                                         bullets_def += 'v';
2565                                         break;
2566                                 }
2567                                 bullets_def += "}{" +
2568                                   params.user_defined_bullets[i].getText()
2569                                   + "}\n";
2570                         }
2571                 }
2572
2573                 if (!bullets_def.empty())
2574                   preamble += bullets_def + "}\n\n";
2575
2576                 int const nlines =
2577                         int(lyx::count(preamble.begin(), preamble.end(), '\n'));
2578                 for (int j = 0; j != nlines; ++j) {
2579                         texrow.newline();
2580                 }
2581
2582                 // We try to load babel late, in case it interferes
2583                 // with other packages.
2584                 if (use_babel) {
2585                         string tmp = lyxrc.language_package;
2586                         if (!lyxrc.language_global_options
2587                             && tmp == "\\usepackage{babel}")
2588                                 tmp = string("\\usepackage[") +
2589                                         language_options.str().c_str() +
2590                                         "]{babel}";
2591                         preamble += tmp + "\n";
2592                         preamble += features.getBabelOptions();
2593                 }
2594
2595                 preamble += "\\makeatother\n";
2596
2597                 os << preamble;
2598
2599                 if (only_preamble)
2600                         return;
2601
2602                 // make the body.
2603                 os << "\\begin{document}\n";
2604                 texrow.newline();
2605         } // only_body
2606         lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
2607
2608         if (!lyxrc.language_auto_begin) {
2609                 os << subst(lyxrc.language_command_begin, "$$lang",
2610                              params.language->babel())
2611                     << endl;
2612                 texrow.newline();
2613         }
2614
2615         latexParagraphs(os, paragraph, 0, texrow);
2616
2617         // add this just in case after all the paragraphs
2618         os << endl;
2619         texrow.newline();
2620
2621         if (!lyxrc.language_auto_end) {
2622                 os << subst(lyxrc.language_command_end, "$$lang",
2623                              params.language->babel())
2624                     << endl;
2625                 texrow.newline();
2626         }
2627
2628         if (!only_body) {
2629                 os << "\\end{document}\n";
2630                 texrow.newline();
2631
2632                 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
2633         } else {
2634                 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
2635                                      << endl;
2636         }
2637
2638         // Just to be sure. (Asger)
2639         texrow.newline();
2640
2641         // tex_code_break_column's value is used to decide
2642         // if we are in batchmode or not (within mathed_write()
2643         // in math_write.C) so we must set it to a non-zero
2644         // value when we leave otherwise we save incorrect .lyx files.
2645         tex_code_break_column = lyxrc.ascii_linelen;
2646
2647         lyxerr[Debug::INFO] << "Finished making latex file." << endl;
2648         lyxerr[Debug::INFO] << "Row count was " << texrow.rows()-1 << "." << endl;
2649
2650         // we want this to be true outside previews (for insetexternal)
2651         niceFile = true;
2652 }
2653
2654
2655 //
2656 // LaTeX all paragraphs from par to endpar, if endpar == 0 then to the end
2657 //
2658 void Buffer::latexParagraphs(ostream & ofs, Paragraph * par,
2659                              Paragraph * endpar, TexRow & texrow,
2660                              bool moving_arg) const
2661 {
2662         bool was_title = false;
2663         bool already_title = false;
2664
2665         // if only_body
2666         while (par != endpar) {
2667                 Inset * in = par->inInset();
2668                 // well we have to check if we are in an inset with unlimited
2669                 // lenght (all in one row) if that is true then we don't allow
2670                 // any special options in the paragraph and also we don't allow
2671                 // any environment other then "Standard" to be valid!
2672                 if ((in == 0) || !in->forceDefaultParagraphs(in)) {
2673                         LyXLayout_ptr const & layout = par->layout();
2674
2675                         if (layout->intitle) {
2676                                 if (already_title) {
2677                                         lyxerr <<"Error in latexParagraphs: You"
2678                                                 " should not mix title layouts"
2679                                                 " with normal ones." << endl;
2680                                 } else
2681                                         was_title = true;
2682                         } else if (was_title && !already_title) {
2683                                 ofs << "\\maketitle\n";
2684                                 texrow.newline();
2685                                 already_title = true;
2686                                 was_title = false;
2687                         }
2688
2689                         if (layout->isEnvironment() ||
2690                                 !par->params().leftIndent().zero())
2691                         {
2692                                 par = par->TeXEnvironment(this, params, ofs, texrow);
2693                         } else {
2694                                 par = par->TeXOnePar(this, params, ofs, texrow, moving_arg);
2695                         }
2696                 } else {
2697                         par = par->TeXOnePar(this, params, ofs, texrow, moving_arg);
2698                 }
2699         }
2700         // It might be that we only have a title in this document
2701         if (was_title && !already_title) {
2702                 ofs << "\\maketitle\n";
2703                 texrow.newline();
2704         }
2705 }
2706
2707
2708 bool Buffer::isLatex() const
2709 {
2710         return params.getLyXTextClass().outputType() == LATEX;
2711 }
2712
2713
2714 bool Buffer::isLinuxDoc() const
2715 {
2716         return params.getLyXTextClass().outputType() == LINUXDOC;
2717 }
2718
2719
2720 bool Buffer::isLiterate() const
2721 {
2722         return params.getLyXTextClass().outputType() == LITERATE;
2723 }
2724
2725
2726 bool Buffer::isDocBook() const
2727 {
2728         return params.getLyXTextClass().outputType() == DOCBOOK;
2729 }
2730
2731
2732 bool Buffer::isSGML() const
2733 {
2734         LyXTextClass const & tclass = params.getLyXTextClass();
2735
2736         return tclass.outputType() == LINUXDOC ||
2737                tclass.outputType() == DOCBOOK;
2738 }
2739
2740
2741 int Buffer::sgmlOpenTag(ostream & os, Paragraph::depth_type depth, bool mixcont,
2742                          string const & latexname) const
2743 {
2744         if (!latexname.empty() && latexname != "!-- --") {
2745                 if (!mixcont)
2746                         os << string(" ",depth);
2747                 os << "<" << latexname << ">";
2748         }
2749
2750         if (!mixcont)
2751                 os << endl;
2752
2753         return mixcont?0:1;
2754 }
2755
2756
2757 int Buffer::sgmlCloseTag(ostream & os, Paragraph::depth_type depth, bool mixcont,
2758                           string const & latexname) const
2759 {
2760         if (!latexname.empty() && latexname != "!-- --") {
2761                 if (!mixcont)
2762                         os << endl << string(" ",depth);
2763                 os << "</" << latexname << ">";
2764         }
2765
2766         if (!mixcont)
2767                 os << endl;
2768
2769         return mixcont?0:1;
2770 }
2771
2772
2773 void Buffer::makeLinuxDocFile(string const & fname, bool nice, bool body_only)
2774 {
2775         ofstream ofs(fname.c_str());
2776
2777         if (!ofs) {
2778                 Alert::alert(_("LYX_ERROR:"), _("Cannot write file"), fname);
2779                 return;
2780         }
2781
2782         niceFile = nice; // this will be used by included files.
2783
2784         LaTeXFeatures features(params);
2785
2786         validate(features);
2787
2788         texrow.reset();
2789
2790         LyXTextClass const & tclass = params.getLyXTextClass();
2791
2792         string top_element = tclass.latexname();
2793
2794         if (!body_only) {
2795                 ofs << "<!doctype linuxdoc system";
2796
2797                 string preamble = params.preamble;
2798                 const string name = nice ? ChangeExtension(filename_, ".sgml")
2799                          : fname;
2800                 preamble += features.getIncludedFiles(name);
2801                 preamble += features.getLyXSGMLEntities();
2802
2803                 if (!preamble.empty()) {
2804                         ofs << " [ " << preamble << " ]";
2805                 }
2806                 ofs << ">\n\n";
2807
2808                 if (params.options.empty())
2809                         sgmlOpenTag(ofs, 0, false, top_element);
2810                 else {
2811                         string top = top_element;
2812                         top += " ";
2813                         top += params.options;
2814                         sgmlOpenTag(ofs, 0, false, top);
2815                 }
2816         }
2817
2818         ofs << "<!-- "  << lyx_docversion
2819             << " created this file. For more info see http://www.lyx.org/"
2820             << " -->\n";
2821
2822         Paragraph::depth_type depth = 0; // paragraph depth
2823         Paragraph * par = paragraph;
2824         string item_name;
2825         vector<string> environment_stack(5);
2826
2827         while (par) {
2828                 LyXLayout_ptr const & style = par->layout();
2829                 // treat <toc> as a special case for compatibility with old code
2830                 if (par->isInset(0)) {
2831                         Inset * inset = par->getInset(0);
2832                         Inset::Code lyx_code = inset->lyxCode();
2833                         if (lyx_code == Inset::TOC_CODE) {
2834                                 string const temp = "toc";
2835                                 sgmlOpenTag(ofs, depth, false, temp);
2836
2837                                 par = par->next();
2838                                 continue;
2839                         }
2840                 }
2841
2842                 // environment tag closing
2843                 for (; depth > par->params().depth(); --depth) {
2844                         sgmlCloseTag(ofs, depth, false, environment_stack[depth]);
2845                         environment_stack[depth].erase();
2846                 }
2847
2848                 // write opening SGML tags
2849                 switch (style->latextype) {
2850                 case LATEX_PARAGRAPH:
2851                         if (depth == par->params().depth()
2852                            && !environment_stack[depth].empty()) {
2853                                 sgmlCloseTag(ofs, depth, false, environment_stack[depth]);
2854                                 environment_stack[depth].erase();
2855                                 if (depth)
2856                                         --depth;
2857                                 else
2858                                         ofs << "</p>";
2859                         }
2860                         sgmlOpenTag(ofs, depth, false, style->latexname());
2861                         break;
2862
2863                 case LATEX_COMMAND:
2864                         if (depth!= 0)
2865                                 sgmlError(par, 0,
2866                                           _("Error : Wrong depth for"
2867                                             " LatexType Command.\n"));
2868
2869                         if (!environment_stack[depth].empty()) {
2870                                 sgmlCloseTag(ofs, depth, false, environment_stack[depth]);
2871                                 ofs << "</p>";
2872                         }
2873
2874                         environment_stack[depth].erase();
2875                         sgmlOpenTag(ofs, depth, false, style->latexname());
2876                         break;
2877
2878                 case LATEX_ENVIRONMENT:
2879                 case LATEX_ITEM_ENVIRONMENT:
2880                 {
2881                         string const & latexname = style->latexname();
2882
2883                         if (depth == par->params().depth()
2884                             && environment_stack[depth] != latexname) {
2885                                 sgmlCloseTag(ofs, depth, false,
2886                                              environment_stack[depth]);
2887                                 environment_stack[depth].erase();
2888                         }
2889                         if (depth < par->params().depth()) {
2890                                depth = par->params().depth();
2891                                environment_stack[depth].erase();
2892                         }
2893                         if (environment_stack[depth] != latexname) {
2894                                 if (depth == 0) {
2895                                         sgmlOpenTag(ofs, depth, false, "p");
2896                                 }
2897                                 sgmlOpenTag(ofs, depth, false, latexname);
2898
2899                                 if (environment_stack.size() == depth + 1)
2900                                         environment_stack.push_back("!-- --");
2901                                 environment_stack[depth] = latexname;
2902                         }
2903
2904                         if (style->latexparam() == "CDATA")
2905                                 ofs << "<![CDATA[";
2906
2907                         if (style->latextype == LATEX_ENVIRONMENT) break;
2908
2909                         if (style->labeltype == LABEL_MANUAL)
2910                                 item_name = "tag";
2911                         else
2912                                 item_name = "item";
2913
2914                         sgmlOpenTag(ofs, depth + 1, false, item_name);
2915                 }
2916                 break;
2917
2918                 default:
2919                         sgmlOpenTag(ofs, depth, false, style->latexname());
2920                         break;
2921                 }
2922
2923                 simpleLinuxDocOnePar(ofs, par, depth);
2924
2925                 par = par->next();
2926
2927                 ofs << "\n";
2928                 // write closing SGML tags
2929                 switch (style->latextype) {
2930                 case LATEX_COMMAND:
2931                         break;
2932                 case LATEX_ENVIRONMENT:
2933                 case LATEX_ITEM_ENVIRONMENT:
2934                         if (style->latexparam() == "CDATA")
2935                                 ofs << "]]>";
2936                         break;
2937                 default:
2938                         sgmlCloseTag(ofs, depth, false, style->latexname());
2939                         break;
2940                 }
2941         }
2942
2943         // Close open tags
2944         for (int i = depth; i >= 0; --i)
2945                 sgmlCloseTag(ofs, depth, false, environment_stack[i]);
2946
2947         if (!body_only) {
2948                 ofs << "\n\n";
2949                 sgmlCloseTag(ofs, 0, false, top_element);
2950         }
2951
2952         ofs.close();
2953         // How to check for successful close
2954
2955         // we want this to be true outside previews (for insetexternal)
2956         niceFile = true;
2957 }
2958
2959
2960 // checks, if newcol chars should be put into this line
2961 // writes newline, if necessary.
2962 namespace {
2963
2964 void sgmlLineBreak(ostream & os, string::size_type & colcount,
2965                           string::size_type newcol)
2966 {
2967         colcount += newcol;
2968         if (colcount > lyxrc.ascii_linelen) {
2969                 os << "\n";
2970                 colcount = newcol; // assume write after this call
2971         }
2972 }
2973
2974 enum PAR_TAG {
2975         NONE=0,
2976         TT = 1,
2977         SF = 2,
2978         BF = 4,
2979         IT = 8,
2980         SL = 16,
2981         EM = 32
2982 };
2983
2984
2985 string tag_name(PAR_TAG const & pt) {
2986         switch (pt) {
2987         case NONE: return "!-- --";
2988         case TT: return "tt";
2989         case SF: return "sf";
2990         case BF: return "bf";
2991         case IT: return "it";
2992         case SL: return "sl";
2993         case EM: return "em";
2994         }
2995         return "";
2996 }
2997
2998
2999 inline
3000 void operator|=(PAR_TAG & p1, PAR_TAG const & p2)
3001 {
3002         p1 = static_cast<PAR_TAG>(p1 | p2);
3003 }
3004
3005
3006 inline
3007 void reset(PAR_TAG & p1, PAR_TAG const & p2)
3008 {
3009         p1 = static_cast<PAR_TAG>(p1 & ~p2);
3010 }
3011
3012 } // anon
3013
3014
3015 // Handle internal paragraph parsing -- layout already processed.
3016 void Buffer::simpleLinuxDocOnePar(ostream & os,
3017         Paragraph * par,
3018         Paragraph::depth_type /*depth*/)
3019 {
3020         LyXLayout_ptr const & style = par->layout();
3021
3022         string::size_type char_line_count = 5;     // Heuristic choice ;-)
3023
3024         // gets paragraph main font
3025         LyXFont font_old;
3026         bool desc_on;
3027         if (style->labeltype == LABEL_MANUAL) {
3028                 font_old = style->labelfont;
3029                 desc_on = true;
3030         } else {
3031                 font_old = style->font;
3032                 desc_on = false;
3033         }
3034
3035         LyXFont::FONT_FAMILY family_type = LyXFont::ROMAN_FAMILY;
3036         LyXFont::FONT_SERIES series_type = LyXFont::MEDIUM_SERIES;
3037         LyXFont::FONT_SHAPE  shape_type  = LyXFont::UP_SHAPE;
3038         bool is_em = false;
3039
3040         stack<PAR_TAG> tag_state;
3041         // parsing main loop
3042         for (pos_type i = 0; i < par->size(); ++i) {
3043
3044                 PAR_TAG tag_close = NONE;
3045                 list < PAR_TAG > tag_open;
3046
3047                 LyXFont const font = par->getFont(params, i);
3048
3049                 if (font_old.family() != font.family()) {
3050                         switch (family_type) {
3051                         case LyXFont::SANS_FAMILY:
3052                                 tag_close |= SF;
3053                                 break;
3054                         case LyXFont::TYPEWRITER_FAMILY:
3055                                 tag_close |= TT;
3056                                 break;
3057                         default:
3058                                 break;
3059                         }
3060
3061                         family_type = font.family();
3062
3063                         switch (family_type) {
3064                         case LyXFont::SANS_FAMILY:
3065                                 tag_open.push_back(SF);
3066                                 break;
3067                         case LyXFont::TYPEWRITER_FAMILY:
3068                                 tag_open.push_back(TT);
3069                                 break;
3070                         default:
3071                                 break;
3072                         }
3073                 }
3074
3075                 if (font_old.series() != font.series()) {
3076                         switch (series_type) {
3077                         case LyXFont::BOLD_SERIES:
3078                                 tag_close |= BF;
3079                                 break;
3080                         default:
3081                                 break;
3082                         }
3083
3084                         series_type = font.series();
3085
3086                         switch (series_type) {
3087                         case LyXFont::BOLD_SERIES:
3088                                 tag_open.push_back(BF);
3089                                 break;
3090                         default:
3091                                 break;
3092                         }
3093
3094                 }
3095
3096                 if (font_old.shape() != font.shape()) {
3097                         switch (shape_type) {
3098                         case LyXFont::ITALIC_SHAPE:
3099                                 tag_close |= IT;
3100                                 break;
3101                         case LyXFont::SLANTED_SHAPE:
3102                                 tag_close |= SL;
3103                                 break;
3104                         default:
3105                                 break;
3106                         }
3107
3108                         shape_type = font.shape();
3109
3110                         switch (shape_type) {
3111                         case LyXFont::ITALIC_SHAPE:
3112                                 tag_open.push_back(IT);
3113                                 break;
3114                         case LyXFont::SLANTED_SHAPE:
3115                                 tag_open.push_back(SL);
3116                                 break;
3117                         default:
3118                                 break;
3119                         }
3120                 }
3121                 // handle <em> tag
3122                 if (font_old.emph() != font.emph()) {
3123                         if (font.emph() == LyXFont::ON) {
3124                                 tag_open.push_back(EM);
3125                                 is_em = true;
3126                         }
3127                         else if (is_em) {
3128                                 tag_close |= EM;
3129                                 is_em = false;
3130                         }
3131                 }
3132
3133                 list < PAR_TAG > temp;
3134                 while (!tag_state.empty() && tag_close) {
3135                         PAR_TAG k =  tag_state.top();
3136                         tag_state.pop();
3137                         os << "</" << tag_name(k) << ">";
3138                         if (tag_close & k)
3139                                 reset(tag_close,k);
3140                         else
3141                                 temp.push_back(k);
3142                 }
3143
3144                 for(list< PAR_TAG >::const_iterator j = temp.begin();
3145                     j != temp.end(); ++j) {
3146                         tag_state.push(*j);
3147                         os << "<" << tag_name(*j) << ">";
3148                 }
3149
3150                 for(list< PAR_TAG >::const_iterator j = tag_open.begin();
3151                     j != tag_open.end(); ++j) {
3152                         tag_state.push(*j);
3153                         os << "<" << tag_name(*j) << ">";
3154                 }
3155
3156                 char c = par->getChar(i);
3157
3158                 if (c == Paragraph::META_INSET) {
3159                         Inset * inset = par->getInset(i);
3160                         inset->linuxdoc(this, os);
3161                         font_old = font;
3162                         continue;
3163                 }
3164
3165                 if (style->latexparam() == "CDATA") {
3166                         // "TeX"-Mode on == > SGML-Mode on.
3167                         if (c != '\0')
3168                                 os << c;
3169                         ++char_line_count;
3170                 } else {
3171                         string sgml_string;
3172                         if (par->sgmlConvertChar(c, sgml_string)
3173                             && !style->free_spacing && !par->isFreeSpacing())
3174                         {
3175                                 // in freespacing mode, spaces are
3176                                 // non-breaking characters
3177                                 if (desc_on) {// if char is ' ' then...
3178
3179                                         ++char_line_count;
3180                                         sgmlLineBreak(os, char_line_count, 6);
3181                                         os << "</tag>";
3182                                         desc_on = false;
3183                                 } else  {
3184                                         sgmlLineBreak(os, char_line_count, 1);
3185                                         os << c;
3186                                 }
3187                         } else {
3188                                 os << sgml_string;
3189                                 char_line_count += sgml_string.length();
3190                         }
3191                 }
3192                 font_old = font;
3193         }
3194
3195         while (!tag_state.empty()) {
3196                 os << "</" << tag_name(tag_state.top()) << ">";
3197                 tag_state.pop();
3198         }
3199
3200         // resets description flag correctly
3201         if (desc_on) {
3202                 // <tag> not closed...
3203                 sgmlLineBreak(os, char_line_count, 6);
3204                 os << "</tag>";
3205         }
3206 }
3207
3208
3209 // Print an error message.
3210 void Buffer::sgmlError(Paragraph * /*par*/, int /*pos*/,
3211         string const & /*message*/) const
3212 {
3213 #ifdef WITH_WARNINGS
3214 #warning This is wrong we cannot insert an inset like this!!!
3215         // I guess this was Jose' so I explain you more or less why this
3216         // is wrong. This way you insert something in the paragraph and
3217         // don't tell it to LyXText (row rebreaking and undo handling!!!)
3218         // I deactivate this code, have a look at BufferView::insertErrors
3219         // how you should do this correctly! (Jug 20020315)
3220 #endif
3221 #if 0
3222         // insert an error marker in text
3223         InsetError * new_inset = new InsetError(message);
3224         par->insertInset(pos, new_inset, LyXFont(LyXFont::ALL_INHERIT,
3225                          params.language));
3226 #endif
3227 }
3228
3229
3230 void Buffer::makeDocBookFile(string const & fname, bool nice, bool only_body)
3231 {
3232         ofstream ofs(fname.c_str());
3233         if (!ofs) {
3234                 Alert::alert(_("LYX_ERROR:"), _("Cannot write file"), fname);
3235                 return;
3236         }
3237
3238         Paragraph * par = paragraph;
3239
3240         niceFile = nice; // this will be used by Insetincludes.
3241
3242         LaTeXFeatures features(params);
3243         validate(features);
3244
3245         texrow.reset();
3246
3247         LyXTextClass const & tclass = params.getLyXTextClass();
3248         string top_element = tclass.latexname();
3249
3250         if (!only_body) {
3251                 ofs << "<!DOCTYPE " << top_element
3252                     << "  PUBLIC \"-//OASIS//DTD DocBook V4.1//EN\"";
3253
3254                 string preamble = params.preamble;
3255                 const string name = nice ? ChangeExtension(filename_, ".sgml")
3256                          : fname;
3257                 preamble += features.getIncludedFiles(name);
3258                 preamble += features.getLyXSGMLEntities();
3259
3260                 if (!preamble.empty()) {
3261                         ofs << "\n [ " << preamble << " ]";
3262                 }
3263                 ofs << ">\n\n";
3264         }
3265
3266         string top = top_element;
3267         top += " lang=\"";
3268         top += params.language->code();
3269         top += "\"";
3270
3271         if (!params.options.empty()) {
3272                 top += " ";
3273                 top += params.options;
3274         }
3275         sgmlOpenTag(ofs, 0, false, top);
3276
3277         ofs << "<!-- DocBook file was created by " << lyx_docversion
3278             << "\n  See http://www.lyx.org/ for more information -->\n";
3279
3280         vector<string> environment_stack(10);
3281         vector<string> environment_inner(10);
3282         vector<string> command_stack(10);
3283
3284         bool command_flag = false;
3285         Paragraph::depth_type command_depth = 0;
3286         Paragraph::depth_type command_base = 0;
3287         Paragraph::depth_type cmd_depth = 0;
3288         Paragraph::depth_type depth = 0; // paragraph depth
3289
3290         string item_name;
3291         string command_name;
3292
3293         while (par) {
3294                 string sgmlparam;
3295                 string c_depth;
3296                 string c_params;
3297                 int desc_on = 0; // description mode
3298
3299                 LyXLayout_ptr const & style = par->layout();
3300
3301                 // environment tag closing
3302                 for (; depth > par->params().depth(); --depth) {
3303                         if (environment_inner[depth] != "!-- --") {
3304                                 item_name = "listitem";
3305                                 sgmlCloseTag(ofs, command_depth + depth, false, item_name);
3306                                 if (environment_inner[depth] == "varlistentry")
3307                                         sgmlCloseTag(ofs, depth+command_depth, false, environment_inner[depth]);
3308                         }
3309                         sgmlCloseTag(ofs, depth + command_depth, false, environment_stack[depth]);
3310                         environment_stack[depth].erase();
3311                         environment_inner[depth].erase();
3312                 }
3313
3314                 if (depth == par->params().depth()
3315                    && environment_stack[depth] != style->latexname()
3316                    && !environment_stack[depth].empty()) {
3317                         if (environment_inner[depth] != "!-- --") {
3318                                 item_name= "listitem";
3319                                 sgmlCloseTag(ofs, command_depth+depth, false, item_name);
3320                                 if (environment_inner[depth] == "varlistentry")
3321                                         sgmlCloseTag(ofs, depth + command_depth, false, environment_inner[depth]);
3322                         }
3323
3324                         sgmlCloseTag(ofs, depth + command_depth, false, environment_stack[depth]);
3325
3326                         environment_stack[depth].erase();
3327                         environment_inner[depth].erase();
3328                 }
3329
3330                 // Write opening SGML tags.
3331                 switch (style->latextype) {
3332                 case LATEX_PARAGRAPH:
3333                         sgmlOpenTag(ofs, depth + command_depth,
3334                                     false, style->latexname());
3335                         break;
3336
3337                 case LATEX_COMMAND:
3338                         if (depth != 0)
3339                                 sgmlError(par, 0,
3340                                           _("Error : Wrong depth for "
3341                                             "LatexType Command.\n"));
3342
3343                         command_name = style->latexname();
3344
3345                         sgmlparam = style->latexparam();
3346                         c_params = split(sgmlparam, c_depth,'|');
3347
3348                         cmd_depth = lyx::atoi(c_depth);
3349
3350                         if (command_flag) {
3351                                 if (cmd_depth < command_base) {
3352                                         for (Paragraph::depth_type j = command_depth;
3353                                              j >= command_base; --j) {
3354                                                 sgmlCloseTag(ofs, j, false, command_stack[j]);
3355                                                 ofs << endl;
3356                                         }
3357                                         command_depth = command_base = cmd_depth;
3358                                 } else if (cmd_depth <= command_depth) {
3359                                         for (int j = command_depth;
3360                                              j >= int(cmd_depth); --j) {
3361                                                 sgmlCloseTag(ofs, j, false, command_stack[j]);
3362                                                 ofs << endl;
3363                                         }
3364                                         command_depth = cmd_depth;
3365                                 } else
3366                                         command_depth = cmd_depth;
3367                         } else {
3368                                 command_depth = command_base = cmd_depth;
3369                                 command_flag = true;
3370                         }
3371                         if (command_stack.size() == command_depth + 1)
3372                                 command_stack.push_back(string());
3373                         command_stack[command_depth] = command_name;
3374
3375                         // treat label as a special case for
3376                         // more WYSIWYM handling.
3377                         // This is a hack while paragraphs can't have
3378                         // attributes, like id in this case.
3379                         if (par->isInset(0)) {
3380                                 Inset * inset = par->getInset(0);
3381                                 Inset::Code lyx_code = inset->lyxCode();
3382                                 if (lyx_code == Inset::LABEL_CODE) {
3383                                         command_name += " id=\"";
3384                                         command_name += (static_cast<InsetCommand *>(inset))->getContents();
3385                                         command_name += "\"";
3386                                         desc_on = 3;
3387                                 }
3388                         }
3389
3390                         sgmlOpenTag(ofs, depth + command_depth, false, command_name);
3391
3392                         item_name = c_params.empty()?"title":c_params;
3393                         sgmlOpenTag(ofs, depth + 1 + command_depth, false, item_name);
3394                         break;
3395
3396                 case LATEX_ENVIRONMENT:
3397                 case LATEX_ITEM_ENVIRONMENT:
3398                         if (depth < par->params().depth()) {
3399                                 depth = par->params().depth();
3400                                 environment_stack[depth].erase();
3401                         }
3402
3403                         if (environment_stack[depth] != style->latexname()) {
3404                                 if (environment_stack.size() == depth + 1) {
3405                                         environment_stack.push_back("!-- --");
3406                                         environment_inner.push_back("!-- --");
3407                                 }
3408                                 environment_stack[depth] = style->latexname();
3409                                 environment_inner[depth] = "!-- --";
3410                                 sgmlOpenTag(ofs, depth + command_depth, false, environment_stack[depth]);
3411                         } else {
3412                                 if (environment_inner[depth] != "!-- --") {
3413                                         item_name= "listitem";
3414                                         sgmlCloseTag(ofs, command_depth + depth, false, item_name);
3415                                         if (environment_inner[depth] == "varlistentry")
3416                                                 sgmlCloseTag(ofs, depth + command_depth, false, environment_inner[depth]);
3417                                 }
3418                         }
3419
3420                         if (style->latextype == LATEX_ENVIRONMENT) {
3421                                 if (!style->latexparam().empty()) {
3422                                         if (style->latexparam() == "CDATA")
3423                                                 ofs << "<![CDATA[";
3424                                         else
3425                                                 sgmlOpenTag(ofs, depth + command_depth, false, style->latexparam());
3426                                 }
3427                                 break;
3428                         }
3429
3430                         desc_on = (style->labeltype == LABEL_MANUAL);
3431
3432                         environment_inner[depth] = desc_on ? "varlistentry" : "listitem";
3433                         sgmlOpenTag(ofs, depth + 1 + command_depth,
3434                                     false, environment_inner[depth]);
3435
3436                         item_name = desc_on ? "term" : "para";
3437                         sgmlOpenTag(ofs, depth + 1 + command_depth,
3438                                     false, item_name);
3439                         break;
3440                 default:
3441                         sgmlOpenTag(ofs, depth + command_depth,
3442                                     false, style->latexname());
3443                         break;
3444                 }
3445
3446                 simpleDocBookOnePar(ofs, par, desc_on,
3447                                     depth + 1 + command_depth);
3448                 par = par->next();
3449
3450                 string end_tag;
3451                 // write closing SGML tags
3452                 switch (style->latextype) {
3453                 case LATEX_COMMAND:
3454                         end_tag = c_params.empty() ? "title" : c_params;
3455                         sgmlCloseTag(ofs, depth + command_depth,
3456                                      false, end_tag);
3457                         break;
3458                 case LATEX_ENVIRONMENT:
3459                         if (!style->latexparam().empty()) {
3460                                 if (style->latexparam() == "CDATA")
3461                                         ofs << "]]>";
3462                                 else
3463                                         sgmlCloseTag(ofs, depth + command_depth, false, style->latexparam());
3464                         }
3465                         break;
3466                 case LATEX_ITEM_ENVIRONMENT:
3467                         if (desc_on == 1) break;
3468                         end_tag= "para";
3469                         sgmlCloseTag(ofs, depth + 1 + command_depth, false, end_tag);
3470                         break;
3471                 case LATEX_PARAGRAPH:
3472                         sgmlCloseTag(ofs, depth + command_depth, false, style->latexname());
3473                         break;
3474                 default:
3475                         sgmlCloseTag(ofs, depth + command_depth, false, style->latexname());
3476                         break;
3477                 }
3478         }
3479
3480         // Close open tags
3481         for (int d = depth; d >= 0; --d) {
3482                 if (!environment_stack[depth].empty()) {
3483                         if (environment_inner[depth] != "!-- --") {
3484                                 item_name = "listitem";
3485                                 sgmlCloseTag(ofs, command_depth + depth, false, item_name);
3486                                if (environment_inner[depth] == "varlistentry")
3487                                        sgmlCloseTag(ofs, depth + command_depth, false, environment_inner[depth]);
3488                         }
3489
3490                         sgmlCloseTag(ofs, depth + command_depth, false, environment_stack[depth]);
3491                 }
3492         }
3493
3494         for (int j = command_depth; j >= 0 ; --j)
3495                 if (!command_stack[j].empty()) {
3496                         sgmlCloseTag(ofs, j, false, command_stack[j]);
3497                         ofs << endl;
3498                 }
3499
3500         ofs << "\n\n";
3501         sgmlCloseTag(ofs, 0, false, top_element);
3502
3503         ofs.close();
3504         // How to check for successful close
3505
3506         // we want this to be true outside previews (for insetexternal)
3507         niceFile = true;
3508 }
3509
3510
3511 void Buffer::simpleDocBookOnePar(ostream & os,
3512                                  Paragraph * par, int & desc_on,
3513                                  Paragraph::depth_type depth) const
3514 {
3515         bool emph_flag = false;
3516
3517         LyXLayout_ptr const & style = par->layout();
3518
3519         LyXFont font_old = (style->labeltype == LABEL_MANUAL ? style->labelfont : style->font);
3520
3521         int char_line_count = depth;
3522         //if (!style.free_spacing)
3523         //      os << string(depth,' ');
3524
3525         // parsing main loop
3526         for (pos_type i = 0; i < par->size(); ++i) {
3527                 LyXFont font = par->getFont(params, i);
3528
3529                 // handle <emphasis> tag
3530                 if (font_old.emph() != font.emph()) {
3531                         if (font.emph() == LyXFont::ON) {
3532                                 if (style->latexparam() == "CDATA")
3533                                         os << "]]>";
3534                                 os << "<emphasis>";
3535                                 if (style->latexparam() == "CDATA")
3536                                         os << "<![CDATA[";
3537                                 emph_flag = true;
3538                         } else if (i) {
3539                                 if (style->latexparam() == "CDATA")
3540                                         os << "]]>";
3541                                 os << "</emphasis>";
3542                                 if (style->latexparam() == "CDATA")
3543                                         os << "<![CDATA[";
3544                                 emph_flag = false;
3545                         }
3546                 }
3547
3548
3549                 if (par->isInset(i)) {
3550                         Inset * inset = par->getInset(i);
3551                         // don't print the inset in position 0 if desc_on == 3 (label)
3552                         if (i || desc_on != 3) {
3553                                 if (style->latexparam() == "CDATA")
3554                                         os << "]]>";
3555                                 inset->docbook(this, os, false);
3556                                 if (style->latexparam() == "CDATA")
3557                                         os << "<![CDATA[";
3558                         }
3559                 } else {
3560                         char c = par->getChar(i);
3561                         string sgml_string;
3562                         par->sgmlConvertChar(c, sgml_string);
3563
3564                         if (style->pass_thru) {
3565                                 os << c;
3566                         } else if (style->free_spacing || par->isFreeSpacing() || c != ' ') {
3567                                         os << sgml_string;
3568                         } else if (desc_on ==1) {
3569                                 ++char_line_count;
3570                                 os << "\n</term><listitem><para>";
3571                                 desc_on = 2;
3572                         } else {
3573                                 os << ' ';
3574                         }
3575                 }
3576                 font_old = font;
3577         }
3578
3579         if (emph_flag) {
3580                 if (style->latexparam() == "CDATA")
3581                         os << "]]>";
3582                 os << "</emphasis>";
3583                 if (style->latexparam() == "CDATA")
3584                         os << "<![CDATA[";
3585         }
3586
3587         // resets description flag correctly
3588         if (desc_on == 1) {
3589                 // <term> not closed...
3590                 os << "</term>\n<listitem><para>&nbsp;</para>";
3591         }
3592         if (style->free_spacing)
3593                 os << '\n';
3594 }
3595
3596
3597 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
3598 // Other flags: -wall -v0 -x
3599 int Buffer::runChktex()
3600 {
3601         if (!users->text) return 0;
3602
3603         users->owner()->prohibitInput();
3604
3605         // get LaTeX-Filename
3606         string const name = getLatexName();
3607         string path = filePath();
3608
3609         string const org_path = path;
3610         if (lyxrc.use_tempdir || !IsDirWriteable(path)) {
3611                 path = tmppath;
3612         }
3613
3614         Path p(path); // path to LaTeX file
3615         users->owner()->message(_("Running chktex..."));
3616
3617         // Remove all error insets
3618         bool const removedErrorInsets = users->removeAutoInsets();
3619
3620         // Generate the LaTeX file if neccessary
3621         makeLaTeXFile(name, org_path, false);
3622
3623         TeXErrors terr;
3624         Chktex chktex(lyxrc.chktex_command, name, filePath());
3625         int res = chktex.run(terr); // run chktex
3626
3627         if (res == -1) {
3628                 Alert::alert(_("chktex did not work!"),
3629                            _("Could not run with file:"), name);
3630         } else if (res > 0) {
3631                 // Insert all errors as errors boxes
3632                 users->insertErrors(terr);
3633         }
3634
3635         // if we removed error insets before we ran chktex or if we inserted
3636         // error insets after we ran chktex, this must be run:
3637         if (removedErrorInsets || res) {
3638 #warning repaint needed here, or do you mean update() ?
3639                 users->repaint();
3640                 users->fitCursor();
3641         }
3642         users->owner()->allowInput();
3643
3644         return res;
3645 }
3646
3647
3648 void Buffer::validate(LaTeXFeatures & features) const
3649 {
3650         Paragraph * par = paragraph;
3651         LyXTextClass const & tclass = params.getLyXTextClass();
3652
3653         // AMS Style is at document level
3654         if (params.use_amsmath || tclass.provides(LyXTextClass::amsmath))
3655                 features.require("amsmath");
3656
3657         while (par) {
3658                 // We don't use "lyxerr.debug" because of speed. (Asger)
3659                 if (lyxerr.debugging(Debug::LATEX))
3660                         lyxerr << "Paragraph: " <<  par << endl;
3661
3662                 // Now just follow the list of paragraphs and run
3663                 // validate on each of them.
3664                 par->validate(features);
3665
3666                 // and then the next paragraph
3667                 par = par->next();
3668         }
3669
3670         // the bullet shapes are buffer level not paragraph level
3671         // so they are tested here
3672         for (int i = 0; i < 4; ++i) {
3673                 if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
3674                         int const font = params.user_defined_bullets[i].getFont();
3675                         if (font == 0) {
3676                                 int const c = params
3677                                         .user_defined_bullets[i]
3678                                         .getCharacter();
3679                                 if (c == 16
3680                                    || c == 17
3681                                    || c == 25
3682                                    || c == 26
3683                                    || c == 31) {
3684                                         features.require("latexsym");
3685                                 }
3686                         } else if (font == 1) {
3687                                 features.require("amssymb");
3688                         } else if ((font >= 2 && font <= 5)) {
3689                                 features.require("pifont");
3690                         }
3691                 }
3692         }
3693
3694         if (lyxerr.debugging(Debug::LATEX)) {
3695                 features.showStruct();
3696         }
3697 }
3698
3699
3700 // This function should be in Buffer because it's a buffer's property (ale)
3701 string const Buffer::getIncludeonlyList(char delim)
3702 {
3703         string lst;
3704         for (inset_iterator it = inset_iterator_begin();
3705             it != inset_iterator_end(); ++it) {
3706                 if ((*it)->lyxCode() == Inset::INCLUDE_CODE) {
3707                         InsetInclude * insetinc =
3708                                 static_cast<InsetInclude *>(*it);
3709                         if (insetinc->isIncludeOnly()) {
3710                                 if (!lst.empty())
3711                                         lst += delim;
3712                                 lst += insetinc->getRelFileBaseName();
3713                         }
3714                 }
3715         }
3716         lyxerr[Debug::INFO] << "Includeonly(" << lst << ')' << endl;
3717         return lst;
3718 }
3719
3720
3721 vector<string> const Buffer::getLabelList()
3722 {
3723         /// if this is a child document and the parent is already loaded
3724         /// Use the parent's list instead  [ale990407]
3725         if (!params.parentname.empty()
3726             && bufferlist.exists(params.parentname)) {
3727                 Buffer * tmp = bufferlist.getBuffer(params.parentname);
3728                 if (tmp)
3729                         return tmp->getLabelList();
3730         }
3731
3732         vector<string> label_list;
3733         for (inset_iterator it = inset_iterator_begin();
3734              it != inset_iterator_end(); ++it) {
3735                 vector<string> const l = (*it)->getLabelList();
3736                 label_list.insert(label_list.end(), l.begin(), l.end());
3737         }
3738         return label_list;
3739 }
3740
3741
3742 // This is also a buffer property (ale)
3743 vector<pair<string, string> > const Buffer::getBibkeyList() const
3744 {
3745         typedef pair<string, string> StringPair;
3746         /// if this is a child document and the parent is already loaded
3747         /// Use the parent's list instead  [ale990412]
3748         if (!params.parentname.empty() && bufferlist.exists(params.parentname)) {
3749                 Buffer const * tmp = bufferlist.getBuffer(params.parentname);
3750                 if (tmp)
3751                         return tmp->getBibkeyList();
3752         }
3753
3754         vector<StringPair> keys;
3755         Paragraph * par = paragraph;
3756         while (par) {
3757                 if (par->bibkey) {
3758                         string const key = par->bibkey->getContents();
3759                         string const opt = par->bibkey->getOptions();
3760                         string const ref = par->asString(this, false);
3761                         string const info = opt + "TheBibliographyRef" + ref;
3762
3763                         keys.push_back(StringPair(key, info));
3764                 }
3765                 par = par->next();
3766         }
3767
3768         // Might be either using bibtex or a child has bibliography
3769         if (keys.empty()) {
3770                 for (inset_iterator it = inset_const_iterator_begin();
3771                         it != inset_const_iterator_end(); ++it) {
3772                         // Search for Bibtex or Include inset
3773                         if ((*it)->lyxCode() == Inset::BIBTEX_CODE) {
3774                                 vector<StringPair> tmp =
3775                                         static_cast<InsetBibtex*>(*it)->getKeys(this);
3776                                 keys.insert(keys.end(), tmp.begin(), tmp.end());
3777                         } else if ((*it)->lyxCode() == Inset::INCLUDE_CODE) {
3778                                 vector<StringPair> const tmp =
3779                                         static_cast<InsetInclude*>(*it)->getKeys();
3780                                 keys.insert(keys.end(), tmp.begin(), tmp.end());
3781                         }
3782                 }
3783         }
3784
3785         return keys;
3786 }
3787
3788
3789 bool Buffer::isDepClean(string const & name) const
3790 {
3791         DEPCLEAN * item = dep_clean;
3792         while (item && item->master != name)
3793                 item = item->next;
3794         if (!item) return true;
3795         return item->clean;
3796 }
3797
3798
3799 void Buffer::markDepClean(string const & name)
3800 {
3801         if (!dep_clean) {
3802                 dep_clean = new DEPCLEAN;
3803                 dep_clean->clean = true;
3804                 dep_clean->master = name;
3805                 dep_clean->next = 0;
3806         } else {
3807                 DEPCLEAN * item = dep_clean;
3808                 while (item && item->master != name)
3809                         item = item->next;
3810                 if (item) {
3811                         item->clean = true;
3812                 } else {
3813                         item = new DEPCLEAN;
3814                         item->clean = true;
3815                         item->master = name;
3816                         item->next = 0;
3817                 }
3818         }
3819 }
3820
3821
3822 bool Buffer::dispatch(string const & command, bool * result)
3823 {
3824         // Split command string into command and argument
3825         string cmd;
3826         string line = ltrim(command);
3827         string const arg = trim(split(line, cmd, ' '));
3828
3829         return dispatch(lyxaction.LookupFunc(cmd), arg, result);
3830 }
3831
3832
3833 bool Buffer::dispatch(int action, string const & argument, bool * result)
3834 {
3835         bool dispatched = true;
3836
3837         switch (action) {
3838                 case LFUN_EXPORT: {
3839                         bool const tmp = Exporter::Export(this, argument, false);
3840                         if (result)
3841                                 *result = tmp;
3842                         break;
3843                 }
3844
3845                 default:
3846                         dispatched = false;
3847         }
3848         return dispatched;
3849 }
3850
3851
3852 void Buffer::resizeInsets(BufferView * bv)
3853 {
3854         /// then remove all LyXText in text-insets
3855         Paragraph * par = paragraph;
3856         for (; par; par = par->next()) {
3857             par->resizeInsetsLyXText(bv);
3858         }
3859 }
3860
3861
3862 void Buffer::redraw()
3863 {
3864 #warning repaint needed here, or do you mean update() ?
3865         users->repaint();
3866         users->fitCursor();
3867 }
3868
3869
3870 void Buffer::changeLanguage(Language const * from, Language const * to)
3871 {
3872
3873         ParIterator end = par_iterator_end();
3874         for (ParIterator it = par_iterator_begin(); it != end; ++it)
3875                 (*it)->changeLanguage(params, from, to);
3876 }
3877
3878
3879 bool Buffer::isMultiLingual()
3880 {
3881         ParIterator end = par_iterator_end();
3882         for (ParIterator it = par_iterator_begin(); it != end; ++it)
3883                 if ((*it)->isMultiLingual(params))
3884                         return true;
3885
3886         return false;
3887 }
3888
3889
3890 Buffer::inset_iterator::inset_iterator(Paragraph * paragraph, pos_type pos)
3891         : par(paragraph)
3892 {
3893         it = par->InsetIterator(pos);
3894         if (it == par->inset_iterator_end()) {
3895                 par = par->next();
3896                 setParagraph();
3897         }
3898 }
3899
3900
3901 void Buffer::inset_iterator::setParagraph()
3902 {
3903         while (par) {
3904                 it = par->inset_iterator_begin();
3905                 if (it != par->inset_iterator_end())
3906                         return;
3907                 par = par->next();
3908         }
3909         //it = 0;
3910         // We maintain an invariant that whenever par = 0 then it = 0
3911 }
3912
3913
3914 Inset * Buffer::getInsetFromID(int id_arg) const
3915 {
3916         for (inset_iterator it = inset_const_iterator_begin();
3917                  it != inset_const_iterator_end(); ++it)
3918         {
3919                 if ((*it)->id() == id_arg)
3920                         return *it;
3921                 Inset * in = (*it)->getInsetFromID(id_arg);
3922                 if (in)
3923                         return in;
3924         }
3925         return 0;
3926 }
3927
3928
3929 Paragraph * Buffer::getParFromID(int id) const
3930 {
3931         if (id < 0) return 0;
3932         Paragraph * par = paragraph;
3933         while (par) {
3934                 if (par->id() == id) {
3935                         return par;
3936                 }
3937                 Paragraph * tmp = par->getParFromID(id);
3938                 if (tmp) {
3939                         return tmp;
3940                 }
3941                 par = par->next();
3942         }
3943         return 0;
3944 }
3945
3946
3947 ParIterator Buffer::par_iterator_begin()
3948 {
3949         return ParIterator(paragraph);
3950 }
3951
3952
3953 ParIterator Buffer::par_iterator_end()
3954 {
3955         return ParIterator();
3956 }