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