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         LyXFont font1;
1508         LyXFont font2;
1509         Inset const * inset;
1510         char c;
1511         char depth = 0;
1512         int ltype = 0;
1513         int ltype_depth = 0;
1514         unsigned int currlinelen = 0;
1515         bool ref_printed = false;
1516
1517         int noparbreak = 0;
1518         int islatex = 0;
1519         if (!par->previous()) {
1520                 /* begins or ends a deeper area ?*/
1521                 if (depth != par->params.depth()) {
1522                         if (par->params.depth() > depth) {
1523                                 while (par->params.depth() > depth) {
1524                                         ++depth;
1525                                 }
1526                         } else {
1527                                 while (par->params.depth() < depth) {
1528                                         --depth;
1529                                 }
1530                         }
1531                 }
1532
1533                 /* First write the layout */
1534                 string const tmp = textclasslist.NameOfLayout(params.textclass, par->layout);
1535                 if (tmp == "Itemize") {
1536                         ltype = 1;
1537                         ltype_depth = depth + 1;
1538                 } else if (tmp == "Enumerate") {
1539                         ltype = 2;
1540                         ltype_depth = depth + 1;
1541                 } else if (strstr(tmp.c_str(), "ection")) {
1542                         ltype = 3;
1543                         ltype_depth = depth + 1;
1544                 } else if (strstr(tmp.c_str(), "aragraph")) {
1545                         ltype = 4;
1546                         ltype_depth = depth + 1;
1547                 } else if (tmp == "Description") {
1548                         ltype = 5;
1549                         ltype_depth = depth + 1;
1550                 } else if (tmp == "Abstract") {
1551                         ltype = 6;
1552                         ltype_depth = 0;
1553                 } else if (tmp == "Bibliography") {
1554                         ltype = 7;
1555                         ltype_depth = 0;
1556                 } else {
1557                         ltype = 0;
1558                         ltype_depth = 0;
1559                 }
1560
1561                 /* maybe some vertical spaces */
1562
1563                 /* the labelwidthstring used in lists */
1564
1565                 /* some lines? */
1566
1567                 /* some pagebreaks? */
1568
1569                 /* noindent ? */
1570
1571                 /* what about the alignment */
1572         } else {
1573                 lyxerr << "Should this ever happen?" << endl;
1574         }
1575
1576         font1 = LyXFont(LyXFont::ALL_INHERIT, params.language);
1577         for (LyXParagraph::size_type i = 0; i < par->size(); ++i) {
1578                 if (!i && !noparbreak) {
1579                         if (linelen > 0)
1580                                 buffer << "\n\n";
1581                         for (char j = 0; j < depth; ++j)
1582                                 buffer << "  ";
1583                         currlinelen = depth * 2;
1584                         switch (ltype) {
1585                         case 0: /* Standard */
1586                         case 4: /* (Sub)Paragraph */
1587                         case 5: /* Description */
1588                                 break;
1589                         case 6: /* Abstract */
1590                                 if (linelen > 0)
1591                                         buffer << "Abstract\n\n";
1592                                 else
1593                                         buffer << "Abstract: ";
1594                                 break;
1595                         case 7: /* Bibliography */
1596                                 if (!ref_printed) {
1597                                         if (linelen > 0)
1598                                                 buffer << "References\n\n";
1599                                         else
1600                                                 buffer << "References: ";
1601                                         ref_printed = true;
1602                                 }
1603                                 break;
1604                         default:
1605                                 buffer << par->params.labelString() << " ";
1606                                 break;
1607                         }
1608                         if (ltype_depth > depth) {
1609                                 for (char j = ltype_depth - 1; j > depth; --j)
1610                                         buffer << "  ";
1611                                 currlinelen += (ltype_depth-depth)*2;
1612                         }
1613                 }
1614                 font2 = par->GetFontSettings(params, i);
1615                 if (font1.latex() != font2.latex()) {
1616                         if (font2.latex() == LyXFont::OFF)
1617                                 islatex = 0;
1618                         else
1619                                 islatex = 1;
1620                 } else {
1621                         islatex = 0;
1622                 }
1623                 c = par->GetUChar(params, i);
1624                 if (islatex)
1625                         continue;
1626                 switch (c) {
1627                 case LyXParagraph::META_INSET:
1628                         if ((inset = par->GetInset(i))) {
1629                                 if (!inset->Ascii(this, buffer)) {
1630                                         string dummy;
1631                                         string s = 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                         break;
1640                 case LyXParagraph::META_NEWLINE:
1641                         if (linelen > 0) {
1642                                 buffer << "\n";
1643                                 for (char j = 0; j < depth; ++j)
1644                                         buffer << "  ";
1645                         }
1646                         currlinelen = depth * 2;
1647                         if (ltype_depth > depth) {
1648                                 for (char j = ltype_depth;
1649                                     j > depth; --j)
1650                                         buffer << "  ";
1651                                 currlinelen += (ltype_depth - depth) * 2;
1652                         }
1653                         break;
1654                 case LyXParagraph::META_HFILL:
1655                         buffer << "\t";
1656                         break;
1657                 case '\\':
1658                         buffer << "\\";
1659                         break;
1660                 default:
1661                         if ((linelen > 0) && (currlinelen > (linelen - 10)) &&
1662                             (c == ' ') && ((i + 2) < par->size()))
1663                         {
1664                                 buffer << "\n";
1665                                 for (char j = 0; j < depth; ++j)
1666                                         buffer << "  ";
1667                                 currlinelen = depth * 2;
1668                                 if (ltype_depth > depth) {
1669                                         for (char j = ltype_depth;
1670                                             j > depth; --j)
1671                                                 buffer << "  ";
1672                                         currlinelen += (ltype_depth-depth)*2;
1673                                 }
1674                         } else if (c != '\0')
1675                                 buffer << c;
1676                         else if (c == '\0')
1677                                 lyxerr.debug() << "writeAsciiFile: NULL char in structure." << endl;
1678                         ++currlinelen;
1679                         break;
1680                 }
1681         }
1682         return buffer.str().c_str();
1683 }
1684
1685
1686 void Buffer::writeFileAscii(string const & fname, int linelen)
1687 {
1688         ofstream ofs(fname.c_str());
1689         if (!ofs) {
1690                 WriteFSAlert(_("Error: Cannot write file:"), fname);
1691                 return;
1692         }
1693         writeFileAscii(ofs, linelen);
1694 }
1695
1696
1697 void Buffer::writeFileAscii(ostream & ofs, int linelen)
1698 {
1699         LyXParagraph * par = paragraph;
1700         while (par) {
1701                 ofs << asciiParagraph(par, linelen);
1702                 par = par->next();
1703         }
1704         ofs << "\n";
1705 }
1706
1707 bool use_babel;
1708
1709 void Buffer::makeLaTeXFile(string const & fname,
1710                            string const & original_path,
1711                            bool nice, bool only_body)
1712 {
1713         lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
1714
1715         niceFile = nice; // this will be used by Insetincludes.
1716
1717         tex_code_break_column = lyxrc.ascii_linelen;
1718
1719         LyXTextClass const & tclass =
1720                 textclasslist.TextClass(params.textclass);
1721
1722         ofstream ofs(fname.c_str());
1723         if (!ofs) {
1724                 WriteFSAlert(_("Error: Cannot open file: "), fname);
1725                 return;
1726         }
1727
1728         // validate the buffer.
1729         lyxerr[Debug::LATEX] << "  Validating buffer..." << endl;
1730         LaTeXFeatures features(params, tclass.numLayouts());
1731         validate(features);
1732         lyxerr[Debug::LATEX] << "  Buffer validation done." << endl;
1733
1734         texrow.reset();
1735         // The starting paragraph of the coming rows is the
1736         // first paragraph of the document. (Asger)
1737         texrow.start(paragraph, 0);
1738
1739         if (!only_body && nice) {
1740                 ofs << "%% " LYX_DOCVERSION " created this file.  "
1741                         "For more info, see http://www.lyx.org/.\n"
1742                         "%% Do not edit unless you really know what "
1743                         "you are doing.\n";
1744                 texrow.newline();
1745                 texrow.newline();
1746         }
1747         lyxerr.debug() << "lyx header finished" << endl;
1748         // There are a few differences between nice LaTeX and usual files:
1749         // usual is \batchmode and has a
1750         // special input@path to allow the including of figures
1751         // with either \input or \includegraphics (what figinsets do).
1752         // batchmode is not set if there is a tex_code_break_column.
1753         // In this case somebody is interested in the generated LaTeX,
1754         // so this is OK. input@path is set when the actual parameter
1755         // original_path is set. This is done for usual tex-file, but not
1756         // for nice-latex-file. (Matthias 250696)
1757         if (!only_body) {
1758                 if (!nice){
1759                         // code for usual, NOT nice-latex-file
1760                         ofs << "\\batchmode\n"; // changed
1761                         // from \nonstopmode
1762                         texrow.newline();
1763                 }
1764                 if (!original_path.empty()) {
1765                         ofs << "\\makeatletter\n"
1766                             << "\\def\\input@path{{"
1767                             << original_path << "/}}\n"
1768                             << "\\makeatother\n";
1769                         texrow.newline();
1770                         texrow.newline();
1771                         texrow.newline();
1772                 }
1773
1774                 ofs << "\\documentclass";
1775
1776                 ostringstream options; // the document class options.
1777
1778                 if (tokenPos(tclass.opt_fontsize(),
1779                              '|', params.fontsize) >= 0) {
1780                         // only write if existing in list (and not default)
1781                         options << params.fontsize << "pt,";
1782                 }
1783
1784
1785                 if (!params.use_geometry &&
1786                     (params.paperpackage == BufferParams::PACKAGE_NONE)) {
1787                         switch (params.papersize) {
1788                         case BufferParams::PAPER_A4PAPER:
1789                                 options << "a4paper,";
1790                                 break;
1791                         case BufferParams::PAPER_USLETTER:
1792                                 options << "letterpaper,";
1793                                 break;
1794                         case BufferParams::PAPER_A5PAPER:
1795                                 options << "a5paper,";
1796                                 break;
1797                         case BufferParams::PAPER_B5PAPER:
1798                                 options << "b5paper,";
1799                                 break;
1800                         case BufferParams::PAPER_EXECUTIVEPAPER:
1801                                 options << "executivepaper,";
1802                                 break;
1803                         case BufferParams::PAPER_LEGALPAPER:
1804                                 options << "legalpaper,";
1805                                 break;
1806                         }
1807                 }
1808
1809                 // if needed
1810                 if (params.sides != tclass.sides()) {
1811                         switch (params.sides) {
1812                         case LyXTextClass::OneSide:
1813                                 options << "oneside,";
1814                                 break;
1815                         case LyXTextClass::TwoSides:
1816                                 options << "twoside,";
1817                                 break;
1818                         }
1819                 }
1820
1821                 // if needed
1822                 if (params.columns != tclass.columns()) {
1823                         if (params.columns == 2)
1824                                 options << "twocolumn,";
1825                         else
1826                                 options << "onecolumn,";
1827                 }
1828
1829                 if (!params.use_geometry
1830                     && params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
1831                         options << "landscape,";
1832
1833                 // language should be a parameter to \documentclass
1834                 use_babel = false;
1835                 ostringstream language_options;
1836                 if (params.language->babel() == "hebrew"
1837                     && default_language->babel() != "hebrew")
1838                          // This seems necessary
1839                         features.UsedLanguages.insert(default_language);
1840
1841                 if (lyxrc.language_use_babel ||
1842                     params.language->lang() != lyxrc.default_language ||
1843                     !features.UsedLanguages.empty()) {
1844                         use_babel = true;
1845                         for (LaTeXFeatures::LanguageList::const_iterator cit =
1846                                      features.UsedLanguages.begin();
1847                              cit != features.UsedLanguages.end(); ++cit)
1848                                 language_options << (*cit)->babel() << ',';
1849                         language_options << params.language->babel();
1850                         if (lyxrc.language_global_options)
1851                                 options << language_options.str() << ',';
1852                 }
1853
1854                 // the user-defined options
1855                 if (!params.options.empty()) {
1856                         options << params.options << ',';
1857                 }
1858
1859                 string strOptions(options.str().c_str());
1860                 if (!strOptions.empty()){
1861                         strOptions = strip(strOptions, ',');
1862                         ofs << '[' << strOptions << ']';
1863                 }
1864
1865                 ofs << '{'
1866                     << textclasslist.LatexnameOfClass(params.textclass)
1867                     << "}\n";
1868                 texrow.newline();
1869                 // end of \documentclass defs
1870
1871                 // font selection must be done before loading fontenc.sty
1872                 // The ae package is not needed when using OT1 font encoding.
1873                 if (params.fonts != "default" &&
1874                     (params.fonts != "ae" || lyxrc.fontenc != "default")) {
1875                         ofs << "\\usepackage{" << params.fonts << "}\n";
1876                         texrow.newline();
1877                         if (params.fonts == "ae") {
1878                                 ofs << "\\usepackage{aecompl}\n";
1879                                 texrow.newline();
1880                         }
1881                 }
1882                 // this one is not per buffer
1883                 if (lyxrc.fontenc != "default") {
1884                         ofs << "\\usepackage[" << lyxrc.fontenc
1885                             << "]{fontenc}\n";
1886                         texrow.newline();
1887                 }
1888
1889                 if (params.inputenc == "auto") {
1890                         string const doc_encoding =
1891                                 params.language->encoding()->LatexName();
1892
1893                         // Create a list with all the input encodings used
1894                         // in the document
1895                         set<string> encodings;
1896                         for (LaTeXFeatures::LanguageList::const_iterator it =
1897                                      features.UsedLanguages.begin();
1898                              it != features.UsedLanguages.end(); ++it)
1899                                 if ((*it)->encoding()->LatexName() != doc_encoding)
1900                                         encodings.insert((*it)->encoding()->LatexName());
1901
1902                         ofs << "\\usepackage[";
1903                         std::copy(encodings.begin(), encodings.end(),
1904                                   std::ostream_iterator<string>(ofs, ","));
1905                         ofs << doc_encoding << "]{inputenc}\n";
1906                         texrow.newline();
1907                 } else if (params.inputenc != "default") {
1908                         ofs << "\\usepackage[" << params.inputenc
1909                             << "]{inputenc}\n";
1910                         texrow.newline();
1911                 }
1912
1913                 // At the very beginning the text parameters.
1914                 if (params.paperpackage != BufferParams::PACKAGE_NONE) {
1915                         switch (params.paperpackage) {
1916                         case BufferParams::PACKAGE_A4:
1917                                 ofs << "\\usepackage{a4}\n";
1918                                 texrow.newline();
1919                                 break;
1920                         case BufferParams::PACKAGE_A4WIDE:
1921                                 ofs << "\\usepackage{a4wide}\n";
1922                                 texrow.newline();
1923                                 break;
1924                         case BufferParams::PACKAGE_WIDEMARGINSA4:
1925                                 ofs << "\\usepackage[widemargins]{a4}\n";
1926                                 texrow.newline();
1927                                 break;
1928                         }
1929                 }
1930                 if (params.use_geometry) {
1931                         ofs << "\\usepackage{geometry}\n";
1932                         texrow.newline();
1933                         ofs << "\\geometry{verbose";
1934                         if (params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
1935                                 ofs << ",landscape";
1936                         switch (params.papersize2) {
1937                         case BufferParams::VM_PAPER_CUSTOM:
1938                                 if (!params.paperwidth.empty())
1939                                         ofs << ",paperwidth="
1940                                             << params.paperwidth;
1941                                 if (!params.paperheight.empty())
1942                                         ofs << ",paperheight="
1943                                             << params.paperheight;
1944                                 break;
1945                         case BufferParams::VM_PAPER_USLETTER:
1946                                 ofs << ",letterpaper";
1947                                 break;
1948                         case BufferParams::VM_PAPER_USLEGAL:
1949                                 ofs << ",legalpaper";
1950                                 break;
1951                         case BufferParams::VM_PAPER_USEXECUTIVE:
1952                                 ofs << ",executivepaper";
1953                                 break;
1954                         case BufferParams::VM_PAPER_A3:
1955                                 ofs << ",a3paper";
1956                                 break;
1957                         case BufferParams::VM_PAPER_A4:
1958                                 ofs << ",a4paper";
1959                                 break;
1960                         case BufferParams::VM_PAPER_A5:
1961                                 ofs << ",a5paper";
1962                                 break;
1963                         case BufferParams::VM_PAPER_B3:
1964                                 ofs << ",b3paper";
1965                                 break;
1966                         case BufferParams::VM_PAPER_B4:
1967                                 ofs << ",b4paper";
1968                                 break;
1969                         case BufferParams::VM_PAPER_B5:
1970                                 ofs << ",b5paper";
1971                                 break;
1972                         default:
1973                                 // default papersize ie BufferParams::VM_PAPER_DEFAULT
1974                                 switch (lyxrc.default_papersize) {
1975                                 case BufferParams::PAPER_DEFAULT: // keep compiler happy
1976                                 case BufferParams::PAPER_USLETTER:
1977                                         ofs << ",letterpaper";
1978                                         break;
1979                                 case BufferParams::PAPER_LEGALPAPER:
1980                                         ofs << ",legalpaper";
1981                                         break;
1982                                 case BufferParams::PAPER_EXECUTIVEPAPER:
1983                                         ofs << ",executivepaper";
1984                                         break;
1985                                 case BufferParams::PAPER_A3PAPER:
1986                                         ofs << ",a3paper";
1987                                         break;
1988                                 case BufferParams::PAPER_A4PAPER:
1989                                         ofs << ",a4paper";
1990                                         break;
1991                                 case BufferParams::PAPER_A5PAPER:
1992                                         ofs << ",a5paper";
1993                                         break;
1994                                 case BufferParams::PAPER_B5PAPER:
1995                                         ofs << ",b5paper";
1996                                         break;
1997                                 }
1998                         }
1999                         if (!params.topmargin.empty())
2000                                 ofs << ",tmargin=" << params.topmargin;
2001                         if (!params.bottommargin.empty())
2002                                 ofs << ",bmargin=" << params.bottommargin;
2003                         if (!params.leftmargin.empty())
2004                                 ofs << ",lmargin=" << params.leftmargin;
2005                         if (!params.rightmargin.empty())
2006                                 ofs << ",rmargin=" << params.rightmargin;
2007                         if (!params.headheight.empty())
2008                                 ofs << ",headheight=" << params.headheight;
2009                         if (!params.headsep.empty())
2010                                 ofs << ",headsep=" << params.headsep;
2011                         if (!params.footskip.empty())
2012                                 ofs << ",footskip=" << params.footskip;
2013                         ofs << "}\n";
2014                         texrow.newline();
2015                 }
2016                 if (features.amsstyle
2017                     && !tclass.provides(LyXTextClass::amsmath)) {
2018                         ofs << "\\usepackage{amsmath}\n";
2019                         texrow.newline();
2020                 }
2021
2022                 if (tokenPos(tclass.opt_pagestyle(),
2023                              '|', params.pagestyle) >= 0) {
2024                         if (params.pagestyle == "fancy") {
2025                                 ofs << "\\usepackage{fancyhdr}\n";
2026                                 texrow.newline();
2027                         }
2028                         ofs << "\\pagestyle{" << params.pagestyle << "}\n";
2029                         texrow.newline();
2030                 }
2031
2032                 // We try to load babel late, in case it interferes
2033                 // with other packages.
2034                 if (use_babel) {
2035                         string tmp = lyxrc.language_package;
2036                         if (!lyxrc.language_global_options
2037                             && tmp == "\\usepackage{babel}")
2038                                 tmp = string("\\usepackage[") +
2039                                         language_options.str().c_str() +
2040                                         "]{babel}";
2041                         ofs << tmp << "\n";
2042                         texrow.newline();
2043                 }
2044
2045                 if (params.secnumdepth != tclass.secnumdepth()) {
2046                         ofs << "\\setcounter{secnumdepth}{"
2047                             << params.secnumdepth
2048                             << "}\n";
2049                         texrow.newline();
2050                 }
2051                 if (params.tocdepth != tclass.tocdepth()) {
2052                         ofs << "\\setcounter{tocdepth}{"
2053                             << params.tocdepth
2054                             << "}\n";
2055                         texrow.newline();
2056                 }
2057
2058                 if (params.paragraph_separation) {
2059                         switch (params.defskip.kind()) {
2060                         case VSpace::SMALLSKIP:
2061                                 ofs << "\\setlength\\parskip{\\smallskipamount}\n";
2062                                 break;
2063                         case VSpace::MEDSKIP:
2064                                 ofs << "\\setlength\\parskip{\\medskipamount}\n";
2065                                 break;
2066                         case VSpace::BIGSKIP:
2067                                 ofs << "\\setlength\\parskip{\\bigskipamount}\n";
2068                                 break;
2069                         case VSpace::LENGTH:
2070                                 ofs << "\\setlength\\parskip{"
2071                                     << params.defskip.length().asLatexString()
2072                                     << "}\n";
2073                                 break;
2074                         default: // should never happen // Then delete it.
2075                                 ofs << "\\setlength\\parskip{\\medskipamount}\n";
2076                                 break;
2077                         }
2078                         texrow.newline();
2079
2080                         ofs << "\\setlength\\parindent{0pt}\n";
2081                         texrow.newline();
2082                 }
2083
2084                 // Now insert the LyX specific LaTeX commands...
2085
2086                 // The optional packages;
2087                 string preamble(features.getPackages());
2088
2089                 // this might be useful...
2090                 preamble += "\n\\makeatletter\n";
2091
2092                 // Some macros LyX will need
2093                 string tmppreamble(features.getMacros());
2094
2095                 if (!tmppreamble.empty()) {
2096                         preamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2097                                 "LyX specific LaTeX commands.\n"
2098                                 + tmppreamble + '\n';
2099                 }
2100
2101                 // the text class specific preamble
2102                 tmppreamble = features.getTClassPreamble();
2103                 if (!tmppreamble.empty()) {
2104                         preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2105                                 "Textclass specific LaTeX commands.\n"
2106                                 + tmppreamble + '\n';
2107                 }
2108
2109                 /* the user-defined preamble */
2110                 if (!params.preamble.empty()) {
2111                         preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2112                                 "User specified LaTeX commands.\n"
2113                                 + params.preamble + '\n';
2114                 }
2115
2116                 preamble += "\\makeatother\n";
2117
2118                 // Itemize bullet settings need to be last in case the user
2119                 // defines their own bullets that use a package included
2120                 // in the user-defined preamble -- ARRae
2121                 // Actually it has to be done much later than that
2122                 // since some packages like frenchb make modifications
2123                 // at \begin{document} time -- JMarc
2124                 string bullets_def;
2125                 for (int i = 0; i < 4; ++i) {
2126                         if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
2127                                 if (bullets_def.empty())
2128                                         bullets_def="\\AtBeginDocument{\n";
2129                                 bullets_def += "  \\renewcommand{\\labelitemi";
2130                                 switch (i) {
2131                                 // `i' is one less than the item to modify
2132                                 case 0:
2133                                         break;
2134                                 case 1:
2135                                         bullets_def += 'i';
2136                                         break;
2137                                 case 2:
2138                                         bullets_def += "ii";
2139                                         break;
2140                                 case 3:
2141                                         bullets_def += 'v';
2142                                         break;
2143                                 }
2144                                 bullets_def += "}{" +
2145                                   params.user_defined_bullets[i].getText()
2146                                   + "}\n";
2147                         }
2148                 }
2149
2150                 if (!bullets_def.empty())
2151                   preamble += bullets_def + "}\n\n";
2152
2153                 for (int j = countChar(preamble, '\n'); j-- ;) {
2154                         texrow.newline();
2155                 }
2156
2157                 ofs << preamble;
2158
2159                 // make the body.
2160                 ofs << "\\begin{document}\n";
2161                 texrow.newline();
2162         } // only_body
2163         lyxerr.debug() << "preamble finished, now the body." << endl;
2164
2165         if (!lyxrc.language_auto_begin) {
2166                 ofs << subst(lyxrc.language_command_begin, "$$lang",
2167                              params.language->babel())
2168                     << endl;
2169                 texrow.newline();
2170         }
2171
2172         latexParagraphs(ofs, paragraph, 0, texrow);
2173
2174         // add this just in case after all the paragraphs
2175         ofs << endl;
2176         texrow.newline();
2177
2178         if (!lyxrc.language_auto_end) {
2179                 ofs << subst(lyxrc.language_command_end, "$$lang",
2180                              params.language->babel())
2181                     << endl;
2182                 texrow.newline();
2183         }
2184
2185         if (!only_body) {
2186                 ofs << "\\end{document}\n";
2187                 texrow.newline();
2188
2189                 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
2190         } else {
2191                 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
2192                                      << endl;
2193         }
2194
2195         // Just to be sure. (Asger)
2196         texrow.newline();
2197
2198         // tex_code_break_column's value is used to decide
2199         // if we are in batchmode or not (within mathed_write()
2200         // in math_write.C) so we must set it to a non-zero
2201         // value when we leave otherwise we save incorrect .lyx files.
2202         tex_code_break_column = lyxrc.ascii_linelen;
2203
2204         ofs.close();
2205         if (ofs.fail()) {
2206                 lyxerr << "File was not closed properly." << endl;
2207         }
2208
2209         lyxerr.debug() << "Finished making latex file." << endl;
2210 }
2211
2212
2213 //
2214 // LaTeX all paragraphs from par to endpar, if endpar == 0 then to the end
2215 //
2216 void Buffer::latexParagraphs(ostream & ofs, LyXParagraph * par,
2217                              LyXParagraph * endpar, TexRow & texrow) const
2218 {
2219         bool was_title = false;
2220         bool already_title = false;
2221
2222         // if only_body
2223         while (par != endpar) {
2224                 LyXLayout const & layout =
2225                         textclasslist.Style(params.textclass,
2226                                             par->layout);
2227
2228                 if (layout.intitle) {
2229                         if (already_title) {
2230                                 lyxerr <<"Error in latexParagraphs: You"
2231                                         " should not mix title layouts"
2232                                         " with normal ones." << endl;
2233                         } else
2234                                 was_title = true;
2235                 } else if (was_title && !already_title) {
2236                         ofs << "\\maketitle\n";
2237                         texrow.newline();
2238                         already_title = true;
2239                         was_title = false;
2240                 }
2241
2242                 if (layout.isEnvironment()) {
2243                         par = par->TeXEnvironment(this, params, ofs, texrow);
2244                 } else {
2245                         par = par->TeXOnePar(this, params, ofs, texrow, false);
2246                 }
2247         }
2248         // It might be that we only have a title in this document
2249         if (was_title && !already_title) {
2250                 ofs << "\\maketitle\n";
2251                 texrow.newline();
2252         }
2253 }
2254
2255
2256 bool Buffer::isLatex() const
2257 {
2258         return textclasslist.TextClass(params.textclass).outputType() == LATEX;
2259 }
2260
2261
2262 bool Buffer::isLinuxDoc() const
2263 {
2264         return textclasslist.TextClass(params.textclass).outputType() == LINUXDOC;
2265 }
2266
2267
2268 bool Buffer::isLiterate() const
2269 {
2270         return textclasslist.TextClass(params.textclass).outputType() == LITERATE;
2271 }
2272
2273
2274 bool Buffer::isDocBook() const
2275 {
2276         return textclasslist.TextClass(params.textclass).outputType() == DOCBOOK;
2277 }
2278
2279
2280 bool Buffer::isSGML() const
2281 {
2282         return textclasslist.TextClass(params.textclass).outputType() == LINUXDOC ||
2283                textclasslist.TextClass(params.textclass).outputType() == DOCBOOK;
2284 }
2285
2286
2287 void Buffer::sgmlOpenTag(ostream & os, int depth,
2288                          string const & latexname) const
2289 {
2290         if (!latexname.empty() && latexname != "!-- --")
2291                 os << string(depth, ' ') << "<" << latexname << ">\n";
2292 }
2293
2294
2295 void Buffer::sgmlCloseTag(ostream & os, int depth,
2296                           string const & latexname) const
2297 {
2298         if (!latexname.empty() && latexname != "!-- --")
2299                 os << string(depth, ' ') << "</" << latexname << ">\n";
2300 }
2301
2302
2303 void Buffer::makeLinuxDocFile(string const & fname, bool nice, bool body_only)
2304 {
2305         ofstream ofs(fname.c_str());
2306
2307         if (!ofs) {
2308                 WriteAlert(_("LYX_ERROR:"), _("Cannot write file"), fname);
2309                 return;
2310         }
2311
2312         niceFile = nice; // this will be used by included files.
2313
2314         LyXTextClass const & tclass =
2315                 textclasslist.TextClass(params.textclass);
2316
2317         LaTeXFeatures features(params, tclass.numLayouts());
2318         validate(features);
2319
2320         texrow.reset();
2321
2322         string top_element = textclasslist.LatexnameOfClass(params.textclass);
2323
2324         if (!body_only) {
2325                 string sgml_includedfiles=features.getIncludedFiles(fname);
2326
2327                 if (params.preamble.empty() && sgml_includedfiles.empty()) {
2328                         ofs << "<!doctype linuxdoc system>\n\n";
2329                 } else {
2330                         ofs << "<!doctype linuxdoc system [ "
2331                             << params.preamble << sgml_includedfiles << " \n]>\n\n";
2332                 }
2333
2334                 if (params.options.empty())
2335                         sgmlOpenTag(ofs, 0, top_element);
2336                 else {
2337                         string top = top_element;
2338                         top += " ";
2339                         top += params.options;
2340                         sgmlOpenTag(ofs, 0, top);
2341                 }
2342         }
2343
2344         ofs << "<!-- "  << LYX_DOCVERSION
2345             << " created this file. For more info see http://www.lyx.org/"
2346             << " -->\n";
2347
2348         int depth = 0; // paragraph depth
2349         LyXParagraph * par = paragraph;
2350         string item_name;
2351         vector<string> environment_stack(5);
2352
2353         while (par) {
2354                 LyXLayout const & style =
2355                         textclasslist.Style(params.textclass,
2356                                             par->layout);
2357
2358                 // treat <toc> as a special case for compatibility with old code
2359                 if (par->GetChar(0) == LyXParagraph::META_INSET) {
2360                         Inset * inset = par->GetInset(0);
2361                         Inset::Code lyx_code = inset->LyxCode();
2362                         if (lyx_code == Inset::TOC_CODE){
2363                                 string const temp = "toc";
2364                                 sgmlOpenTag(ofs, depth, temp);
2365
2366                                 par = par->next();
2367                                 continue;
2368                         }
2369                 }
2370
2371                 // environment tag closing
2372                 for (; depth > par->params.depth(); --depth) {
2373                         sgmlCloseTag(ofs, depth, environment_stack[depth]);
2374                         environment_stack[depth].erase();
2375                 }
2376
2377                 // write opening SGML tags
2378                 switch (style.latextype) {
2379                 case LATEX_PARAGRAPH:
2380                         if (depth == par->params.depth()
2381                            && !environment_stack[depth].empty()) {
2382                                 sgmlCloseTag(ofs, depth, environment_stack[depth]);
2383                                 environment_stack[depth].erase();
2384                                 if (depth)
2385                                         --depth;
2386                                 else
2387                                         ofs << "</p>";
2388                         }
2389                         sgmlOpenTag(ofs, depth, style.latexname());
2390                         break;
2391
2392                 case LATEX_COMMAND:
2393                         if (depth!= 0)
2394                                 LinuxDocError(par, 0,
2395                                               _("Error : Wrong depth for"
2396                                                 " LatexType Command.\n"));
2397
2398                         if (!environment_stack[depth].empty()){
2399                                 sgmlCloseTag(ofs, depth,
2400                                              environment_stack[depth]);
2401                                 ofs << "</p>";
2402                         }
2403
2404                         environment_stack[depth].erase();
2405                         sgmlOpenTag(ofs, depth, style.latexname());
2406                         break;
2407
2408                 case LATEX_ENVIRONMENT:
2409                 case LATEX_ITEM_ENVIRONMENT:
2410                         if (depth == par->params.depth()
2411                             && environment_stack[depth] != style.latexname()) {
2412                                 sgmlCloseTag(ofs, depth,
2413                                              environment_stack[depth]);
2414                                 environment_stack[depth].erase();
2415                         }
2416                         if (depth < par->params.depth()) {
2417                                depth = par->params.depth();
2418                                environment_stack[depth].erase();
2419                         }
2420                         if (environment_stack[depth] != style.latexname()) {
2421                                 if (depth == 0) {
2422                                         sgmlOpenTag(ofs, depth, "p");
2423                                 }
2424                                 sgmlOpenTag(ofs, depth, style.latexname());
2425
2426                                 if (environment_stack.size() == depth + 1)
2427                                         environment_stack.push_back("!-- --");
2428                                 environment_stack[depth] = style.latexname();
2429                         }
2430
2431                         if (style.latexparam() == "CDATA")
2432                                 ofs << "<![CDATA[";
2433
2434                         if (style.latextype == LATEX_ENVIRONMENT) break;
2435
2436                         if (style.labeltype == LABEL_MANUAL)
2437                                 item_name = "tag";
2438                         else
2439                                 item_name = "item";
2440
2441                         sgmlOpenTag(ofs, depth + 1, item_name);
2442                         break;
2443                 default:
2444                         sgmlOpenTag(ofs, depth, style.latexname());
2445                         break;
2446                 }
2447
2448                 SimpleLinuxDocOnePar(ofs, par, depth);
2449
2450                 par = par->next();
2451
2452                 ofs << "\n";
2453                 // write closing SGML tags
2454                 switch (style.latextype) {
2455                 case LATEX_COMMAND:
2456                         break;
2457                 case LATEX_ENVIRONMENT:
2458                 case LATEX_ITEM_ENVIRONMENT:
2459                         if (style.latexparam() == "CDATA")
2460                                 ofs << "]]>";
2461                         break;
2462                 default:
2463                         sgmlCloseTag(ofs, depth, style.latexname());
2464                         break;
2465                 }
2466         }
2467
2468         // Close open tags
2469         for (int i=depth; i >= 0; --i)
2470                 sgmlCloseTag(ofs, depth, environment_stack[i]);
2471
2472         if (!body_only) {
2473                 ofs << "\n\n";
2474                 sgmlCloseTag(ofs, 0, top_element);
2475         }
2476
2477         ofs.close();
2478         // How to check for successful close
2479 }
2480
2481
2482 void Buffer::DocBookHandleCaption(ostream & os, string & inner_tag,
2483                                   int depth, int desc_on,
2484                                   LyXParagraph * & par)
2485 {
2486         LyXParagraph * tpar = par;
2487         while (tpar
2488                && (tpar->layout != textclasslist.NumberOfLayout(params.textclass,
2489                                                                 "Caption").second))
2490                 tpar = tpar->next();
2491
2492         if (tpar &&
2493             tpar->layout == textclasslist.NumberOfLayout(params.textclass,
2494                                                          "Caption").second) {
2495                 sgmlOpenTag(os, depth + 1, inner_tag);
2496                 string extra_par;
2497                 SimpleDocBookOnePar(os, extra_par, tpar,
2498                                     desc_on, depth + 2);
2499                 sgmlCloseTag(os, depth+1, inner_tag);
2500                 if (!extra_par.empty())
2501                         os << extra_par;
2502         }
2503 }
2504
2505
2506 // checks, if newcol chars should be put into this line
2507 // writes newline, if necessary.
2508 namespace {
2509
2510 void linux_doc_line_break(ostream & os, string::size_type & colcount,
2511                           string::size_type newcol)
2512 {
2513         colcount += newcol;
2514         if (colcount > lyxrc.ascii_linelen) {
2515                 os << "\n";
2516                 colcount = newcol; // assume write after this call
2517         }
2518 }
2519
2520 enum PAR_TAG {
2521         NONE=0,
2522         TT = 1,
2523         SF = 2,
2524         BF = 4,
2525         IT = 8,
2526         SL = 16,
2527         EM = 32
2528 };
2529
2530
2531 string tag_name(PAR_TAG const & pt) {
2532         switch (pt) {
2533         case NONE: return "!-- --";
2534         case TT: return "tt";
2535         case SF: return "sf";
2536         case BF: return "bf";
2537         case IT: return "it";
2538         case SL: return "sl";
2539         case EM: return "em";
2540         }
2541         return "";
2542 }
2543
2544
2545 inline
2546 void operator|=(PAR_TAG & p1, PAR_TAG const & p2)
2547 {
2548         p1 = static_cast<PAR_TAG>(p1 | p2);
2549 }
2550
2551
2552 inline
2553 void reset(PAR_TAG & p1, PAR_TAG const & p2)
2554 {
2555         p1 = static_cast<PAR_TAG>( p1 & ~p2);
2556 }
2557
2558 } // namespace anon
2559
2560
2561
2562
2563 // Handle internal paragraph parsing -- layout already processed.
2564 void Buffer::SimpleLinuxDocOnePar(ostream & os,
2565                                   LyXParagraph * par, int /*depth*/)
2566 {
2567         LyXLayout const & style = textclasslist.Style(params.textclass,
2568                                                       par->GetLayout());
2569         string::size_type char_line_count = 5;     // Heuristic choice ;-)
2570
2571         // gets paragraph main font
2572         LyXFont font_old;
2573         bool desc_on;
2574         if (style.labeltype == LABEL_MANUAL) {
2575                 font_old = style.labelfont;
2576                 desc_on = true;
2577         } else {
2578                 font_old = style.font;
2579                 desc_on = false;
2580         }
2581
2582         LyXFont::FONT_FAMILY family_type = LyXFont::ROMAN_FAMILY;
2583         LyXFont::FONT_SERIES series_type = LyXFont::MEDIUM_SERIES;
2584         LyXFont::FONT_SHAPE  shape_type  = LyXFont::UP_SHAPE;
2585         bool is_em = false;
2586
2587         stack < PAR_TAG > tag_state;
2588         // parsing main loop
2589         for (LyXParagraph::size_type i = 0; i < par->size(); ++i) {
2590
2591                 PAR_TAG tag_close = NONE;
2592                 list < PAR_TAG > tag_open;
2593
2594                 LyXFont const font = par->getFont(params, i);
2595
2596                 if (font_old.family() != font.family()) {
2597                         switch (family_type) {
2598                         case LyXFont::SANS_FAMILY:
2599                                 tag_close |= SF;
2600                                 break;
2601                         case LyXFont::TYPEWRITER_FAMILY:
2602                                 tag_close |= TT;
2603                                 break;
2604                         default:
2605                                 break;
2606                         }
2607
2608                         family_type = font.family();
2609
2610                         switch (family_type) {
2611                         case LyXFont::SANS_FAMILY:
2612                                 tag_open.push_back(SF);
2613                                 break;
2614                         case LyXFont::TYPEWRITER_FAMILY:
2615                                 tag_open.push_back(TT);
2616                                 break;
2617                         default:
2618                                 break;
2619                         }
2620                 }
2621
2622                 if (font_old.series() != font.series()) {
2623                         switch (series_type) {
2624                         case LyXFont::BOLD_SERIES:
2625                                 tag_close |= BF;
2626                                 break;
2627                         default:
2628                                 break;
2629                         }
2630
2631                         series_type = font.series();
2632
2633                         switch (series_type) {
2634                         case LyXFont::BOLD_SERIES:
2635                                 tag_open.push_back(BF);
2636                                 break;
2637                         default:
2638                                 break;
2639                         }
2640
2641                 }
2642
2643                 if (font_old.shape() != font.shape()) {
2644                         switch (shape_type) {
2645                         case LyXFont::ITALIC_SHAPE:
2646                                 tag_close |= IT;
2647                                 break;
2648                         case LyXFont::SLANTED_SHAPE:
2649                                 tag_close |= SL;
2650                                 break;
2651                         default:
2652                                 break;
2653                         }
2654
2655                         shape_type = font.shape();
2656
2657                         switch (shape_type) {
2658                         case LyXFont::ITALIC_SHAPE:
2659                                 tag_open.push_back(IT);
2660                                 break;
2661                         case LyXFont::SLANTED_SHAPE:
2662                                 tag_open.push_back(SL);
2663                                 break;
2664                         default:
2665                                 break;
2666                         }
2667                 }
2668                 // handle <em> tag
2669                 if (font_old.emph() != font.emph()) {
2670                         if (font.emph() == LyXFont::ON) {
2671                                 tag_open.push_back(EM);
2672                                 is_em = true;
2673                         }
2674                         else if (is_em) {
2675                                 tag_close |= EM;
2676                                 is_em = false;
2677                         }
2678                 }
2679
2680                 list < PAR_TAG > temp;
2681                 while(!tag_state.empty() && tag_close ) {
2682                         PAR_TAG k =  tag_state.top();
2683                         tag_state.pop();
2684                         os << "</" << tag_name(k) << ">";
2685                         if (tag_close & k)
2686                                 reset(tag_close,k);
2687                         else
2688                                 temp.push_back(k);
2689                 }
2690
2691                 for(list< PAR_TAG >::const_iterator j = temp.begin();
2692                     j != temp.end(); ++j) {
2693                         tag_state.push(*j);
2694                         os << "<" << tag_name(*j) << ">";
2695                 }
2696
2697                 for(list< PAR_TAG >::const_iterator j = tag_open.begin();
2698                     j != tag_open.end(); ++j) {
2699                         tag_state.push(*j);
2700                         os << "<" << tag_name(*j) << ">";
2701                 }
2702
2703                 char c = par->GetChar(i);
2704
2705                 if (c == LyXParagraph::META_INSET) {
2706                         Inset * inset = par->GetInset(i);
2707                         inset->Linuxdoc(this, os);
2708                         font_old = font;
2709                         continue;
2710                 }
2711
2712                 if (font.latex() == LyXFont::ON || style.latexparam() == "CDATA") {
2713                         // "TeX"-Mode on == > SGML-Mode on.
2714                         if (c != '\0')
2715                                 os << c;
2716                         ++char_line_count;
2717                 } else {
2718                         string sgml_string;
2719                         if (par->linuxDocConvertChar(c, sgml_string)
2720                             && !style.free_spacing) {
2721                                 // in freespacing mode, spaces are
2722                                 // non-breaking characters
2723                                 if (desc_on) {// if char is ' ' then...
2724
2725                                         ++char_line_count;
2726                                         linux_doc_line_break(os, char_line_count, 6);
2727                                         os << "</tag>";
2728                                         desc_on = false;
2729                                 } else  {
2730                                         linux_doc_line_break(os, char_line_count, 1);
2731                                         os << c;
2732                                 }
2733                         } else {
2734                                 os << sgml_string;
2735                                 char_line_count += sgml_string.length();
2736                         }
2737                 }
2738                 font_old = font;
2739         }
2740
2741         while (!tag_state.empty()) {
2742                 os << "</" << tag_name(tag_state.top()) << ">";
2743                 tag_state.pop();
2744         }
2745
2746         // resets description flag correctly
2747         if (desc_on) {
2748                 // <tag> not closed...
2749                 linux_doc_line_break(os, char_line_count, 6);
2750                 os << "</tag>";
2751         }
2752 }
2753
2754
2755 // Print an error message.
2756 void Buffer::LinuxDocError(LyXParagraph * par, int pos,
2757                            string const & message)
2758 {
2759         // insert an error marker in text
2760         InsetError * new_inset = new InsetError(message);
2761         par->InsertInset(pos, new_inset);
2762 }
2763
2764
2765 void Buffer::makeDocBookFile(string const & fname, bool nice, bool only_body)
2766 {
2767         ofstream ofs(fname.c_str());
2768         if (!ofs) {
2769                 WriteAlert(_("LYX_ERROR:"), _("Cannot write file"), fname);
2770                 return;
2771         }
2772
2773         LyXParagraph * par = paragraph;
2774
2775         niceFile = nice; // this will be used by Insetincludes.
2776
2777         LyXTextClass const & tclass =
2778                 textclasslist.TextClass(params.textclass);
2779
2780         LaTeXFeatures features(params, tclass.numLayouts());
2781         validate(features);
2782
2783         texrow.reset();
2784
2785         string top_element = textclasslist.LatexnameOfClass(params.textclass);
2786
2787         if (!only_body) {
2788                 string sgml_includedfiles = features.getIncludedFiles(fname);
2789
2790                 ofs << "<!doctype " << top_element
2791                     << " public \"-//OASIS//DTD DocBook V3.1//EN\"";
2792
2793                 if (params.preamble.empty() && sgml_includedfiles.empty())
2794                         ofs << ">\n\n";
2795                 else
2796                         ofs << "\n [ " << params.preamble
2797                             << sgml_includedfiles << " \n]>\n\n";
2798         }
2799
2800         string top = top_element;
2801         top += " lang=\"";
2802         top += params.language->code();
2803         top += "\"";
2804
2805         if (!params.options.empty()) {
2806                 top += " ";
2807                 top += params.options;
2808         }
2809         sgmlOpenTag(ofs, 0, top);
2810
2811         ofs << "<!-- DocBook file was created by " << LYX_DOCVERSION
2812             << "\n  See http://www.lyx.org/ for more information -->\n";
2813
2814         vector<string> environment_stack(10);
2815         vector<string> environment_inner(10);
2816         vector<string> command_stack(10);
2817
2818         bool command_flag = false;
2819         int command_depth = 0;
2820         int command_base = 0;
2821         int cmd_depth = 0;
2822         int depth = 0; // paragraph depth
2823
2824         string item_name;
2825         string command_name;
2826
2827         while (par) {
2828                 string sgmlparam;
2829                 string c_depth;
2830                 string c_params;
2831                 int desc_on = 0; // description mode
2832
2833                 LyXLayout const & style =
2834                         textclasslist.Style(params.textclass,
2835                                             par->layout);
2836
2837                 // environment tag closing
2838                 for (; depth > par->params.depth(); --depth) {
2839                         if (environment_inner[depth] != "!-- --") {
2840                                 item_name = "listitem";
2841                                 sgmlCloseTag(ofs, command_depth + depth,
2842                                              item_name);
2843                                 if (environment_inner[depth] == "varlistentry")
2844                                         sgmlCloseTag(ofs, depth+command_depth,
2845                                                      environment_inner[depth]);
2846                         }
2847                         sgmlCloseTag(ofs, depth + command_depth,
2848                                      environment_stack[depth]);
2849                         environment_stack[depth].erase();
2850                         environment_inner[depth].erase();
2851                 }
2852
2853                 if (depth == par->params.depth()
2854                    && environment_stack[depth] != style.latexname()
2855                    && !environment_stack[depth].empty()) {
2856                         if (environment_inner[depth] != "!-- --") {
2857                                 item_name= "listitem";
2858                                 sgmlCloseTag(ofs, command_depth+depth,
2859                                              item_name);
2860                                 if (environment_inner[depth] == "varlistentry")
2861                                         sgmlCloseTag(ofs,
2862                                                      depth + command_depth,
2863                                                      environment_inner[depth]);
2864                         }
2865
2866                         sgmlCloseTag(ofs, depth + command_depth,
2867                                      environment_stack[depth]);
2868
2869                         environment_stack[depth].erase();
2870                         environment_inner[depth].erase();
2871                 }
2872
2873                 // Write opening SGML tags.
2874                 switch (style.latextype) {
2875                 case LATEX_PARAGRAPH:
2876                         sgmlOpenTag(ofs, depth + command_depth,
2877                                     style.latexname());
2878                         break;
2879
2880                 case LATEX_COMMAND:
2881                         if (depth != 0)
2882                                 LinuxDocError(par, 0,
2883                                               _("Error : Wrong depth for "
2884                                                 "LatexType Command.\n"));
2885
2886                         command_name = style.latexname();
2887
2888                         sgmlparam = style.latexparam();
2889                         c_params = split(sgmlparam, c_depth,'|');
2890
2891                         cmd_depth = lyx::atoi(c_depth);
2892
2893                         if (command_flag) {
2894                                 if (cmd_depth < command_base) {
2895                                         for (int j = command_depth; j >= command_base; --j)
2896                                                 sgmlCloseTag(ofs, j, command_stack[j]);
2897                                         command_depth = command_base = cmd_depth;
2898                                 } else if (cmd_depth <= command_depth) {
2899                                         for (int j = command_depth; j >= cmd_depth; --j)
2900                                                 sgmlCloseTag(ofs, j, command_stack[j]);
2901                                         command_depth = cmd_depth;
2902                                 } else
2903                                         command_depth = cmd_depth;
2904                         } else {
2905                                 command_depth = command_base = cmd_depth;
2906                                 command_flag = true;
2907                         }
2908                         if (command_stack.size() == command_depth + 1)
2909                                 command_stack.push_back("");
2910                         command_stack[command_depth] = command_name;
2911
2912                         // treat label as a special case for
2913                         // more WYSIWYM handling.
2914                         if (par->GetChar(0) == LyXParagraph::META_INSET) {
2915                                 Inset * inset = par->GetInset(0);
2916                                 Inset::Code lyx_code = inset->LyxCode();
2917                                 if (lyx_code == Inset::LABEL_CODE){
2918                                         command_name += " id=\"";
2919                                         command_name += (static_cast<InsetCommand *>(inset))->getContents();
2920                                         command_name += "\"";
2921                                         desc_on = 3;
2922                                 }
2923                         }
2924
2925                         sgmlOpenTag(ofs, depth + command_depth, command_name);
2926                         if (c_params.empty())
2927                                 item_name = "title";
2928                         else
2929                                 item_name = c_params;
2930                         sgmlOpenTag(ofs, depth + 1 + command_depth, item_name);
2931                         break;
2932
2933                 case LATEX_ENVIRONMENT:
2934                 case LATEX_ITEM_ENVIRONMENT:
2935                         if (depth < par->params.depth()) {
2936                                 depth = par->params.depth();
2937                                 environment_stack[depth].erase();
2938                         }
2939
2940                         if (environment_stack[depth] != style.latexname()) {
2941                                 if(environment_stack.size() == depth + 1) {
2942                                         environment_stack.push_back("!-- --");
2943                                         environment_inner.push_back("!-- --");
2944                                 }
2945                                 environment_stack[depth] = style.latexname();
2946                                 environment_inner[depth] = "!-- --";
2947                                 sgmlOpenTag(ofs, depth + command_depth,
2948                                             environment_stack[depth]);
2949                         } else {
2950                                 if (environment_inner[depth] != "!-- --") {
2951                                         item_name= "listitem";
2952                                         sgmlCloseTag(ofs,
2953                                                      command_depth + depth,
2954                                                      item_name);
2955                                         if (environment_inner[depth] == "varlistentry")
2956                                                 sgmlCloseTag(ofs,
2957                                                              depth + command_depth,
2958                                                              environment_inner[depth]);
2959                                 }
2960                         }
2961
2962                         if (style.latextype == LATEX_ENVIRONMENT) {
2963                                 if (!style.latexparam().empty()) {
2964                                         if(style.latexparam() == "CDATA")
2965                                                 ofs << "<![CDATA[";
2966                                         else
2967                                                 sgmlOpenTag(ofs, depth + command_depth,
2968                                                             style.latexparam());
2969                                 }
2970                                 break;
2971                         }
2972
2973                         desc_on = (style.labeltype == LABEL_MANUAL);
2974
2975                         if (desc_on)
2976                                 environment_inner[depth]= "varlistentry";
2977                         else
2978                                 environment_inner[depth]= "listitem";
2979
2980                         sgmlOpenTag(ofs, depth + 1 + command_depth,
2981                                     environment_inner[depth]);
2982
2983                         if (desc_on) {
2984                                 item_name= "term";
2985                                 sgmlOpenTag(ofs, depth + 1 + command_depth,
2986                                             item_name);
2987                         } else {
2988                                 item_name= "para";
2989                                 sgmlOpenTag(ofs, depth + 1 + command_depth,
2990                                             item_name);
2991                         }
2992                         break;
2993                 default:
2994                         sgmlOpenTag(ofs, depth + command_depth,
2995                                     style.latexname());
2996                         break;
2997                 }
2998
2999                 string extra_par;
3000                 SimpleDocBookOnePar(ofs, extra_par, par, desc_on,
3001                                     depth + 1 + command_depth);
3002                 par = par->next();
3003
3004                 string end_tag;
3005                 // write closing SGML tags
3006                 switch (style.latextype) {
3007                 case LATEX_COMMAND:
3008                         if (c_params.empty())
3009                                 end_tag = "title";
3010                         else
3011                                 end_tag = c_params;
3012                         sgmlCloseTag(ofs, depth + command_depth, end_tag);
3013                         break;
3014                 case LATEX_ENVIRONMENT:
3015                         if (!style.latexparam().empty()) {
3016                                 if(style.latexparam() == "CDATA")
3017                                         ofs << "]]>";
3018                                 else
3019                                         sgmlCloseTag(ofs, depth + command_depth,
3020                                                      style.latexparam());
3021                         }
3022                         break;
3023                 case LATEX_ITEM_ENVIRONMENT:
3024                         if (desc_on == 1) break;
3025                         end_tag= "para";
3026                         sgmlCloseTag(ofs, depth + 1 + command_depth, end_tag);
3027                         break;
3028                 case LATEX_PARAGRAPH:
3029                         sgmlCloseTag(ofs, depth + command_depth, style.latexname());
3030                         break;
3031                 default:
3032                         sgmlCloseTag(ofs, depth + command_depth, style.latexname());
3033                         break;
3034                 }
3035         }
3036
3037         // Close open tags
3038         for (; depth >= 0; --depth) {
3039                 if (!environment_stack[depth].empty()) {
3040                         if (environment_inner[depth] != "!-- --") {
3041                                 item_name = "listitem";
3042                                 sgmlCloseTag(ofs, command_depth + depth,
3043                                              item_name);
3044                                if (environment_inner[depth] == "varlistentry")
3045                                        sgmlCloseTag(ofs, depth + command_depth,
3046                                                     environment_inner[depth]);
3047                         }
3048
3049                         sgmlCloseTag(ofs, depth + command_depth,
3050                                      environment_stack[depth]);
3051                 }
3052         }
3053
3054         for (int j = command_depth; j >= command_base; --j)
3055                 if (!command_stack[j].empty())
3056                         sgmlCloseTag(ofs, j, command_stack[j]);
3057
3058         ofs << "\n\n";
3059         sgmlCloseTag(ofs, 0, top_element);
3060
3061         ofs.close();
3062         // How to check for successful close
3063 }
3064
3065
3066 void Buffer::SimpleDocBookOnePar(ostream & os, string & extra,
3067                                  LyXParagraph * par, int & desc_on,
3068                                  int depth) const
3069 {
3070         bool emph_flag = false;
3071
3072         LyXLayout const & style = textclasslist.Style(params.textclass,
3073                                                       par->GetLayout());
3074
3075         LyXFont font_old = style.labeltype == LABEL_MANUAL ? style.labelfont : style.font;
3076
3077         int char_line_count = depth;
3078         if (!style.free_spacing)
3079                 os << string(depth,' ');
3080
3081         // parsing main loop
3082         for (LyXParagraph::size_type i = 0;
3083              i < par->size(); ++i) {
3084                 LyXFont font = par->getFont(params, i);
3085
3086                 // handle <emphasis> tag
3087                 if (font_old.emph() != font.emph()) {
3088                         if (font.emph() == LyXFont::ON) {
3089                                 os << "<emphasis>";
3090                                 emph_flag = true;
3091                         }else if(i) {
3092                                 os << "</emphasis>";
3093                                 emph_flag = false;
3094                         }
3095                 }
3096
3097                 char c = par->GetChar(i);
3098
3099                 if (c == LyXParagraph::META_INSET) {
3100                         Inset * inset = par->GetInset(i);
3101                         std::ostringstream ost;
3102                         inset->DocBook(this, ost);
3103                         string tmp_out = ost.str().c_str();
3104
3105                         //
3106                         // This code needs some explanation:
3107                         // Two insets are treated specially
3108                         //   label if it is the first element in a command paragraph
3109                         //         desc_on == 3
3110                         //   graphics inside tables or figure floats can't go on
3111                         //   title (the equivalente in latex for this case is caption
3112                         //   and title should come first
3113                         //         desc_on == 4
3114                         //
3115                         if (desc_on!= 3 || i!= 0) {
3116                                 if (!tmp_out.empty() && tmp_out[0] == '@') {
3117                                         if (desc_on == 4)
3118                                                 extra += frontStrip(tmp_out, '@');
3119                                         else
3120                                                 os << frontStrip(tmp_out, '@');
3121                                 }
3122                                 else
3123                                         os << tmp_out;
3124                         }
3125                 } else if (font.latex() == LyXFont::ON) {
3126                         // "TeX"-Mode on ==> SGML-Mode on.
3127                         if (c != '\0')
3128                                 os << c;
3129                         ++char_line_count;
3130                 } else {
3131                         string sgml_string;
3132                         if (par->linuxDocConvertChar(c, sgml_string)
3133                             && !style.free_spacing) { // in freespacing
3134                                                      // mode, spaces are
3135                                                      // non-breaking characters
3136                                 // char is ' '
3137                                 if (desc_on == 1) {
3138                                         ++char_line_count;
3139                                         os << "\n</term><listitem><para>";
3140                                         desc_on = 2;
3141                                 } else {
3142                                         os << c;
3143                                 }
3144                         } else {
3145                                 os << sgml_string;
3146                         }
3147                 }
3148                 font_old = font;
3149         }
3150
3151         if (emph_flag) {
3152                 os << "</emphasis>";
3153         }
3154
3155         // resets description flag correctly
3156         if (desc_on == 1) {
3157                 // <term> not closed...
3158                 os << "</term>";
3159         }
3160         os << '\n';
3161 }
3162
3163
3164 // This should be enabled when the Chktex class is implemented. (Asger)
3165 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
3166 // Other flags: -wall -v0 -x
3167 int Buffer::runChktex()
3168 {
3169         if (!users->text) return 0;
3170
3171         ProhibitInput(users);
3172
3173         // get LaTeX-Filename
3174         string const name = getLatexName();
3175         string path = OnlyPath(filename);
3176
3177         string const org_path = path;
3178         if (lyxrc.use_tempdir || (IsDirWriteable(path) < 1)) {
3179                 path = tmppath;
3180         }
3181
3182         Path p(path); // path to LaTeX file
3183         users->owner()->message(_("Running chktex..."));
3184
3185         // Remove all error insets
3186         bool const removedErrorInsets = users->removeAutoInsets();
3187
3188         // Generate the LaTeX file if neccessary
3189         makeLaTeXFile(name, org_path, false);
3190
3191         TeXErrors terr;
3192         Chktex chktex(lyxrc.chktex_command, name, filepath);
3193         int res = chktex.run(terr); // run chktex
3194
3195         if (res == -1) {
3196                 WriteAlert(_("chktex did not work!"),
3197                            _("Could not run with file:"), name);
3198         } else if (res > 0) {
3199                 // Insert all errors as errors boxes
3200                 users->insertErrors(terr);
3201         }
3202
3203         // if we removed error insets before we ran chktex or if we inserted
3204         // error insets after we ran chktex, this must be run:
3205         if (removedErrorInsets || res){
3206                 users->redraw();
3207                 users->fitCursor(users->text);
3208         }
3209         AllowInput(users);
3210
3211         return res;
3212 }
3213
3214
3215 void Buffer::validate(LaTeXFeatures & features) const
3216 {
3217         LyXParagraph * par = paragraph;
3218         LyXTextClass const & tclass =
3219                 textclasslist.TextClass(params.textclass);
3220
3221         // AMS Style is at document level
3222
3223         features.amsstyle = (params.use_amsmath ||
3224                              tclass.provides(LyXTextClass::amsmath));
3225
3226         while (par) {
3227                 // We don't use "lyxerr.debug" because of speed. (Asger)
3228                 if (lyxerr.debugging(Debug::LATEX))
3229                         lyxerr << "Paragraph: " <<  par << endl;
3230
3231                 // Now just follow the list of paragraphs and run
3232                 // validate on each of them.
3233                 par->validate(features);
3234
3235                 // and then the next paragraph
3236                 par = par->next();
3237         }
3238
3239         // the bullet shapes are buffer level not paragraph level
3240         // so they are tested here
3241         for (int i = 0; i < 4; ++i) {
3242                 if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
3243                         int const font = params.user_defined_bullets[i].getFont();
3244                         if (font == 0) {
3245                                 int const c = params
3246                                         .user_defined_bullets[i]
3247                                         .getCharacter();
3248                                 if (c == 16
3249                                    || c == 17
3250                                    || c == 25
3251                                    || c == 26
3252                                    || c == 31) {
3253                                         features.latexsym = true;
3254                                 }
3255                         } else if (font == 1) {
3256                                 features.amssymb = true;
3257                         } else if ((font >= 2 && font <= 5)) {
3258                                 features.pifont = true;
3259                         }
3260                 }
3261         }
3262
3263         if (lyxerr.debugging(Debug::LATEX)) {
3264                 features.showStruct();
3265         }
3266 }
3267
3268
3269 void Buffer::setPaperStuff()
3270 {
3271         params.papersize = BufferParams::PAPER_DEFAULT;
3272         char const c1 = params.paperpackage;
3273         if (c1 == BufferParams::PACKAGE_NONE) {
3274                 char const c2 = params.papersize2;
3275                 if (c2 == BufferParams::VM_PAPER_USLETTER)
3276                         params.papersize = BufferParams::PAPER_USLETTER;
3277                 else if (c2 == BufferParams::VM_PAPER_USLEGAL)
3278                         params.papersize = BufferParams::PAPER_LEGALPAPER;
3279                 else if (c2 == BufferParams::VM_PAPER_USEXECUTIVE)
3280                         params.papersize = BufferParams::PAPER_EXECUTIVEPAPER;
3281                 else if (c2 == BufferParams::VM_PAPER_A3)
3282                         params.papersize = BufferParams::PAPER_A3PAPER;
3283                 else if (c2 == BufferParams::VM_PAPER_A4)
3284                         params.papersize = BufferParams::PAPER_A4PAPER;
3285                 else if (c2 == BufferParams::VM_PAPER_A5)
3286                         params.papersize = BufferParams::PAPER_A5PAPER;
3287                 else if ((c2 == BufferParams::VM_PAPER_B3) || (c2 == BufferParams::VM_PAPER_B4) ||
3288                          (c2 == BufferParams::VM_PAPER_B5))
3289                         params.papersize = BufferParams::PAPER_B5PAPER;
3290         } else if ((c1 == BufferParams::PACKAGE_A4) || (c1 == BufferParams::PACKAGE_A4WIDE) ||
3291                    (c1 == BufferParams::PACKAGE_WIDEMARGINSA4))
3292                 params.papersize = BufferParams::PAPER_A4PAPER;
3293 }
3294
3295
3296 // This function should be in Buffer because it's a buffer's property (ale)
3297 string const Buffer::getIncludeonlyList(char delim)
3298 {
3299         string lst;
3300         for (inset_iterator it = inset_iterator_begin();
3301             it != inset_iterator_end(); ++it) {
3302                 if ((*it)->LyxCode() == Inset::INCLUDE_CODE) {
3303                         InsetInclude * insetinc =
3304                                 static_cast<InsetInclude *>(*it);
3305                         if (insetinc->isIncludeOnly()) {
3306                                 if (!lst.empty())
3307                                         lst += delim;
3308                                 lst += insetinc->getRelFileBaseName();
3309                         }
3310                 }
3311         }
3312         lyxerr.debug() << "Includeonly(" << lst << ')' << endl;
3313         return lst;
3314 }
3315
3316
3317 vector<string> const Buffer::getLabelList()
3318 {
3319         /// if this is a child document and the parent is already loaded
3320         /// Use the parent's list instead  [ale990407]
3321         if (!params.parentname.empty()
3322             && bufferlist.exists(params.parentname)) {
3323                 Buffer * tmp = bufferlist.getBuffer(params.parentname);
3324                 if (tmp)
3325                         return tmp->getLabelList();
3326         }
3327
3328         vector<string> label_list;
3329         for (inset_iterator it = inset_iterator_begin();
3330              it != inset_iterator_end(); ++it) {
3331                 vector<string> const l = (*it)->getLabelList();
3332                 label_list.insert(label_list.end(), l.begin(), l.end());
3333         }
3334         return label_list;
3335 }
3336
3337
3338 Buffer::Lists const Buffer::getLists() const
3339 {
3340         Lists l;
3341         LyXParagraph * par = paragraph;
3342         bool found;
3343         LyXTextClassList::size_type cap;
3344         boost::tie(found, cap) = textclasslist
3345                 .NumberOfLayout(params.textclass, "Caption");
3346
3347         while (par) {
3348                 char const labeltype =
3349                         textclasslist.Style(params.textclass,
3350                                             par->GetLayout()).labeltype;
3351
3352                 if (labeltype >= LABEL_COUNTER_CHAPTER
3353                     && labeltype <= LABEL_COUNTER_CHAPTER + params.tocdepth) {
3354                                 // insert this into the table of contents
3355                         SingleList & item = l["TOC"];
3356                         int depth = max(0,
3357                                         labeltype -
3358                                         textclasslist.TextClass(params.textclass).maxcounter());
3359                         item.push_back(TocItem(par, depth, par->String(this, true)));
3360                 }
3361                 // For each paragrph, traverse its insets and look for
3362                 // FLOAT_CODE
3363
3364                 if (found) {
3365                         LyXParagraph::inset_iterator it =
3366                                 par->inset_iterator_begin();
3367                         LyXParagraph::inset_iterator end =
3368                                 par->inset_iterator_end();
3369
3370                         for (; it != end; ++it) {
3371                                 if ((*it)->LyxCode() == Inset::FLOAT_CODE) {
3372                                         InsetFloat * il =
3373                                                 static_cast<InsetFloat*>(*it);
3374
3375                                         string const type = il->type();
3376
3377                                         // Now find the caption in the float...
3378                                         // We now tranverse the paragraphs of
3379                                         // the inset...
3380                                         LyXParagraph * tmp = il->inset.par;
3381                                         while (tmp) {
3382                                                 if (tmp->layout == cap) {
3383                                                         SingleList & item = l[type];
3384                                                         string const str =
3385                                                                 tostr(item.size()+1) + ". " + tmp->String(this, false);
3386                                                         item.push_back(TocItem(tmp, 0 , str));
3387                                                 }
3388                                                 tmp = tmp->next();
3389                                         }
3390                                 }
3391                         }
3392                 } else {
3393                         lyxerr << "caption not found" << endl;
3394                 }
3395
3396                 par = par->next();
3397         }
3398         return l;
3399 }
3400
3401
3402 // This is also a buffer property (ale)
3403 vector<pair<string, string> > const Buffer::getBibkeyList()
3404 {
3405         /// if this is a child document and the parent is already loaded
3406         /// Use the parent's list instead  [ale990412]
3407         if (!params.parentname.empty() && bufferlist.exists(params.parentname)) {
3408                 Buffer * tmp = bufferlist.getBuffer(params.parentname);
3409                 if (tmp)
3410                         return tmp->getBibkeyList();
3411         }
3412
3413         vector<pair<string, string> > keys;
3414         LyXParagraph * par = paragraph;
3415         while (par) {
3416                 if (par->bibkey)
3417                         keys.push_back(pair<string, string>(par->bibkey->getContents(),
3418                                                            par->String(this, false)));
3419                 par = par->next();
3420         }
3421
3422         // Might be either using bibtex or a child has bibliography
3423         if (keys.empty()) {
3424                 for (inset_iterator it = inset_iterator_begin();
3425                         it != inset_iterator_end(); ++it) {
3426                         // Search for Bibtex or Include inset
3427                         if ((*it)->LyxCode() == Inset::BIBTEX_CODE) {
3428                                 vector<pair<string,string> > tmp =
3429                                         static_cast<InsetBibtex*>(*it)->getKeys(this);
3430                                 keys.insert(keys.end(), tmp.begin(), tmp.end());
3431                         } else if ((*it)->LyxCode() == Inset::INCLUDE_CODE) {
3432                                 vector<pair<string,string> > const tmp =
3433                                         static_cast<InsetInclude*>(*it)->getKeys();
3434                                 keys.insert(keys.end(), tmp.begin(), tmp.end());
3435                         }
3436                 }
3437         }
3438
3439         return keys;
3440 }
3441
3442
3443 bool Buffer::isDepClean(string const & name) const
3444 {
3445         DEPCLEAN * item = dep_clean;
3446         while (item && item->master != name)
3447                 item = item->next;
3448         if (!item) return true;
3449         return item->clean;
3450 }
3451
3452
3453 void Buffer::markDepClean(string const & name)
3454 {
3455         if (!dep_clean) {
3456                 dep_clean = new DEPCLEAN;
3457                 dep_clean->clean = true;
3458                 dep_clean->master = name;
3459                 dep_clean->next = 0;
3460         } else {
3461                 DEPCLEAN * item = dep_clean;
3462                 while (item && item->master != name)
3463                         item = item->next;
3464                 if (item) {
3465                         item->clean = true;
3466                 } else {
3467                         item = new DEPCLEAN;
3468                         item->clean = true;
3469                         item->master = name;
3470                         item->next = 0;
3471                 }
3472         }
3473 }
3474
3475
3476 bool Buffer::Dispatch(string const & command)
3477 {
3478         // Split command string into command and argument
3479         string cmd;
3480         string line = frontStrip(command);
3481         string const arg = strip(frontStrip(split(line, cmd, ' ')));
3482
3483         return Dispatch(lyxaction.LookupFunc(cmd), arg);
3484 }
3485
3486
3487 bool Buffer::Dispatch(int action, string const & argument)
3488 {
3489         bool dispatched = true;
3490         switch (action) {
3491                 case LFUN_EXPORT:
3492                         Exporter::Export(this, argument, false);
3493                         break;
3494
3495                 default:
3496                         dispatched = false;
3497         }
3498         return dispatched;
3499 }
3500
3501
3502 void Buffer::resize()
3503 {
3504         /// resize the BufferViews!
3505         if (users)
3506                 users->resize();
3507 }
3508
3509
3510 void Buffer::resizeInsets(BufferView * bv)
3511 {
3512         /// then remove all LyXText in text-insets
3513         LyXParagraph * par = paragraph;
3514         for (; par; par = par->next()) {
3515             par->resizeInsetsLyXText(bv);
3516         }
3517 }
3518
3519
3520 void Buffer::ChangeLanguage(Language const * from, Language const * to)
3521 {
3522
3523         LyXParagraph * par = paragraph;
3524         while (par) {
3525                 par->ChangeLanguage(params, from, to);
3526                 par = par->next();
3527         }
3528 }
3529
3530
3531 bool Buffer::isMultiLingual()
3532 {
3533         LyXParagraph * par = paragraph;
3534         while (par) {
3535                 if (par->isMultiLingual(params))
3536                         return true;
3537                 par = par->next();
3538         }
3539         return false;
3540 }
3541
3542
3543 Buffer::inset_iterator::inset_iterator(LyXParagraph * paragraph,
3544                                        LyXParagraph::size_type pos)
3545         : par(paragraph)
3546 {
3547         it = par->InsetIterator(pos);
3548         if (it == par->inset_iterator_end()) {
3549                 par = par->next();
3550                 SetParagraph();
3551         }
3552 }
3553
3554
3555 void Buffer::inset_iterator::SetParagraph()
3556 {
3557         while (par) {
3558                 it = par->inset_iterator_begin();
3559                 if (it != par->inset_iterator_end())
3560                         return;
3561                 par = par->next();
3562         }
3563         //it = 0;
3564         // We maintain an invariant that whenever par = 0 then it = 0
3565 }