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