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