src/BufferParams.cpp

   1 /**
   2  * \file BufferParams.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Alfredo Braunstein
   7  * \author Lars Gullik Bjønnes
   8  * \author Jean-Marc Lasgouttes
   9  * \author John Levon
  10  * \author André Pönitz
  11  * \author Martin Vermeer
  12  *
  13  * Full author contact details are available in file CREDITS.
  14  */
  15
  16 #include <config.h>
  17
  18 #include "BufferParams.h"
  19
  20 #include "Author.h"
  21 #include "BranchList.h"
  22 #include "buffer_funcs.h"
  23 #include "Bullet.h"
  24 #include "Color.h"
  25 #include "Encoding.h"
  26 #include "Language.h"
  27 #include "LaTeXFeatures.h"
  28 #include "ModuleList.h"
  29 #include "Font.h"
  30 #include "Lexer.h"
  31 #include "LyXRC.h"
  32 #include "TextClassList.h"
  33 #include "OutputParams.h"
  34 #include "Spacing.h"
  35 #include "TexRow.h"
  36 #include "VSpace.h"
  37 #include "PDFOptions.h"
  38
  39 #include "frontends/alert.h"
  40
  41 #include "insets/InsetListingsParams.h"
  42
  43 #include "support/convert.h"
  44 #include "support/debug.h"
  45 #include "support/docstream.h"
  46 #include "support/FileName.h"
  47 #include "support/filetools.h"
  48 #include "support/gettext.h"
  49 #include "support/Messages.h"
  50 #include "support/Translator.h"
  51 #include "support/lstrings.h"
  52
  53 #include <algorithm>
  54 #include <sstream>
  55
  56 using namespace std;
  57 using namespace lyx::support;
  58
  59
  60 static char const * const string_paragraph_separation[] = {
  61         "indent", "skip", ""
  62 };
  63
  64
  65 static char const * const string_quotes_language[] = {
  66         "english", "swedish", "german", "polish", "french", "danish", ""
  67 };
  68
  69
  70 static char const * const string_papersize[] = {
  71         "default", "custom", "letterpaper", "executivepaper", "legalpaper",
  72         "a3paper", "a4paper", "a5paper", "b3paper", "b4paper", "b5paper", ""
  73 };
  74
  75
  76 static char const * const string_orientation[] = {
  77         "portrait", "landscape", ""
  78 };
  79
  80
  81 static char const * const string_footnotekinds[] = {
  82         "footnote", "margin", "fig", "tab", "alg", "wide-fig", "wide-tab", ""
  83 };
  84
  85
  86 static char const * const tex_graphics[] = {
  87         "default", "dvips", "dvitops", "emtex",
  88         "ln", "oztex", "textures", "none", ""
  89 };
  90
  91
  92 namespace lyx {
  93
  94 // Local translators
  95 namespace {
  96
  97 // Paragraph separation
  98 typedef Translator<string, BufferParams::PARSEP> ParSepTranslator;
  99
 100
 101 ParSepTranslator const init_parseptranslator()
 102 {
 103         ParSepTranslator translator(string_paragraph_separation[0], BufferParams::PARSEP_INDENT);
 104         translator.addPair(string_paragraph_separation[1], BufferParams::PARSEP_SKIP);
 105         return translator;
 106 }
 107
 108
 109 ParSepTranslator const & parseptranslator()
 110 {
 111         static ParSepTranslator translator = init_parseptranslator();
 112         return translator;
 113 }
 114
 115
 116 // Quotes language
 117 typedef Translator<string, InsetQuotes::quote_language> QuotesLangTranslator;
 118
 119
 120 QuotesLangTranslator const init_quoteslangtranslator()
 121 {
 122         QuotesLangTranslator translator(string_quotes_language[0], InsetQuotes::EnglishQ);
 123         translator.addPair(string_quotes_language[1], InsetQuotes::SwedishQ);
 124         translator.addPair(string_quotes_language[2], InsetQuotes::GermanQ);
 125         translator.addPair(string_quotes_language[3], InsetQuotes::PolishQ);
 126         translator.addPair(string_quotes_language[4], InsetQuotes::FrenchQ);
 127         translator.addPair(string_quotes_language[5], InsetQuotes::DanishQ);
 128         return translator;
 129 }
 130
 131
 132 QuotesLangTranslator const & quoteslangtranslator()
 133 {
 134         static QuotesLangTranslator translator = init_quoteslangtranslator();
 135         return translator;
 136 }
 137
 138
 139 // Paper size
 140 typedef Translator<string, PAPER_SIZE> PaperSizeTranslator;
 141
 142
 143 PaperSizeTranslator const init_papersizetranslator()
 144 {
 145         PaperSizeTranslator translator(string_papersize[0], PAPER_DEFAULT);
 146         translator.addPair(string_papersize[1], PAPER_CUSTOM);
 147         translator.addPair(string_papersize[2], PAPER_USLETTER);
 148         translator.addPair(string_papersize[3], PAPER_USLEGAL);
 149         translator.addPair(string_papersize[4], PAPER_USEXECUTIVE);
 150         translator.addPair(string_papersize[5], PAPER_A3);
 151         translator.addPair(string_papersize[6], PAPER_A4);
 152         translator.addPair(string_papersize[7], PAPER_A5);
 153         translator.addPair(string_papersize[8], PAPER_B3);
 154         translator.addPair(string_papersize[9], PAPER_B4);
 155         translator.addPair(string_papersize[10], PAPER_B5);
 156         return translator;
 157 }
 158
 159
 160 PaperSizeTranslator const & papersizetranslator()
 161 {
 162         static PaperSizeTranslator translator = init_papersizetranslator();
 163         return translator;
 164 }
 165
 166
 167 // Paper orientation
 168 typedef Translator<string, PAPER_ORIENTATION> PaperOrientationTranslator;
 169
 170
 171 PaperOrientationTranslator const init_paperorientationtranslator()
 172 {
 173         PaperOrientationTranslator translator(string_orientation[0], ORIENTATION_PORTRAIT);
 174         translator.addPair(string_orientation[1], ORIENTATION_LANDSCAPE);
 175         return translator;
 176 }
 177
 178
 179 PaperOrientationTranslator const & paperorientationtranslator()
 180 {
 181         static PaperOrientationTranslator translator = init_paperorientationtranslator();
 182         return translator;
 183 }
 184
 185
 186 // Page sides
 187 typedef Translator<int, PageSides> SidesTranslator;
 188
 189
 190 SidesTranslator const init_sidestranslator()
 191 {
 192         SidesTranslator translator(1, OneSide);
 193         translator.addPair(2, TwoSides);
 194         return translator;
 195 }
 196
 197
 198 SidesTranslator const & sidestranslator()
 199 {
 200         static SidesTranslator translator = init_sidestranslator();
 201         return translator;
 202 }
 203
 204
 205 // LaTeX packages
 206 typedef Translator<int, BufferParams::Package> PackageTranslator;
 207
 208
 209 PackageTranslator const init_packagetranslator()
 210 {
 211         PackageTranslator translator(0, BufferParams::package_off);
 212         translator.addPair(1, BufferParams::package_auto);
 213         translator.addPair(2, BufferParams::package_on);
 214         return translator;
 215 }
 216
 217
 218 PackageTranslator const & packagetranslator()
 219 {
 220         static PackageTranslator translator = init_packagetranslator();
 221         return translator;
 222 }
 223
 224
 225 // Cite engine
 226 typedef Translator<string, biblio::CiteEngine> CiteEngineTranslator;
 227
 228
 229 CiteEngineTranslator const init_citeenginetranslator()
 230 {
 231         CiteEngineTranslator translator("basic", biblio::ENGINE_BASIC);
 232         translator.addPair("natbib_numerical", biblio::ENGINE_NATBIB_NUMERICAL);
 233         translator.addPair("natbib_authoryear", biblio::ENGINE_NATBIB_AUTHORYEAR);
 234         translator.addPair("jurabib", biblio::ENGINE_JURABIB);
 235         return translator;
 236 }
 237
 238
 239 CiteEngineTranslator const & citeenginetranslator()
 240 {
 241         static CiteEngineTranslator translator = init_citeenginetranslator();
 242         return translator;
 243 }
 244
 245
 246 // Spacing
 247 typedef Translator<string, Spacing::Space> SpaceTranslator;
 248
 249
 250 SpaceTranslator const init_spacetranslator()
 251 {
 252         SpaceTranslator translator("default", Spacing::Default);
 253         translator.addPair("single", Spacing::Single);
 254         translator.addPair("onehalf", Spacing::Onehalf);
 255         translator.addPair("double", Spacing::Double);
 256         translator.addPair("other", Spacing::Other);
 257         return translator;
 258 }
 259
 260
 261 SpaceTranslator const & spacetranslator()
 262 {
 263         static SpaceTranslator translator = init_spacetranslator();
 264         return translator;
 265 }
 266
 267
 268 } // anon namespace
 269
 270
 271 class BufferParams::Impl
 272 {
 273 public:
 274         Impl();
 275
 276         AuthorList authorlist;
 277         BranchList branchlist;
 278         Bullet temp_bullets[4];
 279         Bullet user_defined_bullets[4];
 280         Spacing spacing;
 281         /** This is the amount of space used for paragraph_separation "skip",
 282          * and for detached paragraphs in "indented" documents.
 283          */
 284         VSpace defskip;
 285         PDFOptions pdfoptions;
 286 };
 287
 288
 289 BufferParams::Impl::Impl()
 290         : defskip(VSpace::MEDSKIP)
 291 {
 292         // set initial author
 293         // FIXME UNICODE
 294         authorlist.record(Author(from_utf8(lyxrc.user_name), from_utf8(lyxrc.user_email)));
 295 }
 296
 297
 298 BufferParams::Impl *
 299 BufferParams::MemoryTraits::clone(BufferParams::Impl const * ptr)
 300 {
 301         BOOST_ASSERT(ptr);
 302
 303         return new BufferParams::Impl(*ptr);
 304 }
 305
 306
 307 void BufferParams::MemoryTraits::destroy(BufferParams::Impl * ptr)
 308 {
 309         delete ptr;
 310 }
 311
 312
 313 BufferParams::BufferParams()
 314         : pimpl_(new Impl)
 315 {
 316         setBaseClass(defaultTextclass());
 317         makeTextClass();
 318         paragraph_separation = PARSEP_INDENT;
 319         quotes_language = InsetQuotes::EnglishQ;
 320         fontsize = "default";
 321
 322         /*  PaperLayout */
 323         papersize = PAPER_DEFAULT;
 324         orientation = ORIENTATION_PORTRAIT;
 325         use_geometry = false;
 326         use_amsmath = package_auto;
 327         use_esint = package_auto;
 328         cite_engine_ = biblio::ENGINE_BASIC;
 329         use_bibtopic = false;
 330         trackChanges = false;
 331         outputChanges = false;
 332         secnumdepth = 3;
 333         tocdepth = 3;
 334         language = default_language;
 335         fontsRoman = "default";
 336         fontsSans = "default";
 337         fontsTypewriter = "default";
 338         fontsDefaultFamily = "default";
 339         fontsSC = false;
 340         fontsOSF = false;
 341         fontsSansScale = 100;
 342         fontsTypewriterScale = 100;
 343         inputenc = "auto";
 344         graphicsDriver = "default";
 345         sides = OneSide;
 346         columns = 1;
 347         listings_params = string();
 348         pagestyle = "default";
 349         compressed = false;
 350         embedded = false;
 351         for (int iter = 0; iter < 4; ++iter) {
 352                 user_defined_bullet(iter) = ITEMIZE_DEFAULTS[iter];
 353                 temp_bullet(iter) = ITEMIZE_DEFAULTS[iter];
 354         }
 355 }
 356
 357
 358 BufferParams::~BufferParams()
 359 {}
 360
 361
 362 docstring const BufferParams::B_(string const & l10n) const
 363 {
 364         BOOST_ASSERT(language);
 365         return getMessages(language->code()).get(l10n);
 366 }
 367
 368
 369 AuthorList & BufferParams::authors()
 370 {
 371         return pimpl_->authorlist;
 372 }
 373
 374
 375 AuthorList const & BufferParams::authors() const
 376 {
 377         return pimpl_->authorlist;
 378 }
 379
 380
 381 BranchList & BufferParams::branchlist()
 382 {
 383         return pimpl_->branchlist;
 384 }
 385
 386
 387 BranchList const & BufferParams::branchlist() const
 388 {
 389         return pimpl_->branchlist;
 390 }
 391
 392
 393 Bullet & BufferParams::temp_bullet(lyx::size_type const index)
 394 {
 395         BOOST_ASSERT(index < 4);
 396         return pimpl_->temp_bullets[index];
 397 }
 398
 399
 400 Bullet const & BufferParams::temp_bullet(lyx::size_type const index) const
 401 {
 402         BOOST_ASSERT(index < 4);
 403         return pimpl_->temp_bullets[index];
 404 }
 405
 406
 407 Bullet & BufferParams::user_defined_bullet(lyx::size_type const index)
 408 {
 409         BOOST_ASSERT(index < 4);
 410         return pimpl_->user_defined_bullets[index];
 411 }
 412
 413
 414 Bullet const & BufferParams::user_defined_bullet(lyx::size_type const index) const
 415 {
 416         BOOST_ASSERT(index < 4);
 417         return pimpl_->user_defined_bullets[index];
 418 }
 419
 420
 421 Spacing & BufferParams::spacing()
 422 {
 423         return pimpl_->spacing;
 424 }
 425
 426
 427 Spacing const & BufferParams::spacing() const
 428 {
 429         return pimpl_->spacing;
 430 }
 431
 432
 433 PDFOptions & BufferParams::pdfoptions()
 434 {
 435         return pimpl_->pdfoptions;
 436 }
 437
 438
 439 PDFOptions const & BufferParams::pdfoptions() const
 440 {
 441         return pimpl_->pdfoptions;
 442 }
 443
 444
 445 VSpace const & BufferParams::getDefSkip() const
 446 {
 447         return pimpl_->defskip;
 448 }
 449
 450
 451 void BufferParams::setDefSkip(VSpace const & vs)
 452 {
 453         pimpl_->defskip = vs;
 454 }
 455
 456
 457 string const BufferParams::readToken(Lexer & lex, string const & token,
 458         FileName const & filepath)
 459 {
 460         if (token == "\\textclass") {
 461                 lex.next();
 462                 string const classname = lex.getString();
 463                 // if there exists a local layout file, ignore the system one
 464                 // NOTE: in this case, the textclass (.cls file) is assumed to be available.
 465                 pair<bool, lyx::textclass_type> pp =
 466                         make_pair(false, textclass_type(0));
 467                 if (!filepath.empty())
 468                         pp = textclasslist.addTextClass(
 469                                 classname, filepath.absFilename());
 470                 if (pp.first)
 471                         setBaseClass(pp.second);
 472                 else {
 473                         pp = textclasslist.numberOfClass(classname);
 474                         if (pp.first)
 475                                 setBaseClass(pp.second);
 476                         else {
 477                                 // a warning will be given for unknown class
 478                                 setBaseClass(defaultTextclass());
 479                                 return classname;
 480                         }
 481                 }
 482                 // FIXME: this warning will be given even if there exists a local .cls
 483                 // file. Even worse, the .lyx file can not be compiled or exported
 484                 // because the textclass is marked as unavilable.
 485                 if (!getTextClass().isTeXClassAvailable()) {
 486                         docstring const msg =
 487                                 bformat(_("The layout file requested by this document,\n"
 488                                                  "%1$s.layout,\n"
 489                                                  "is not usable. This is probably because a LaTeX\n"
 490                                                  "class or style file required by it is not\n"
 491                                                  "available. See the Customization documentation\n"
 492                                                  "for more information.\n"), from_utf8(classname));
 493                         frontend::Alert::warning(_("Document class not available"),
 494                                        msg + _("LyX will not be able to produce output."));
 495                 }
 496
 497         } else if (token == "\\begin_preamble") {
 498                 readPreamble(lex);
 499         } else if (token == "\\begin_modules") {
 500                 readModules(lex);
 501         } else if (token == "\\options") {
 502                 lex.eatLine();
 503                 options = lex.getString();
 504         } else if (token == "\\language") {
 505                 readLanguage(lex);
 506         } else if (token == "\\inputencoding") {
 507                 lex >> inputenc;
 508         } else if (token == "\\graphics") {
 509                 readGraphicsDriver(lex);
 510         } else if (token == "\\font_roman") {
 511                 lex >> fontsRoman;
 512         } else if (token == "\\font_sans") {
 513                 lex >> fontsSans;
 514         } else if (token == "\\font_typewriter") {
 515                 lex >> fontsTypewriter;
 516         } else if (token == "\\font_default_family") {
 517                 lex >> fontsDefaultFamily;
 518         } else if (token == "\\font_sc") {
 519                 lex >> fontsSC;
 520         } else if (token == "\\font_osf") {
 521                 lex >> fontsOSF;
 522         } else if (token == "\\font_sf_scale") {
 523                 lex >> fontsSansScale;
 524         } else if (token == "\\font_tt_scale") {
 525                 lex >> fontsTypewriterScale;
 526         } else if (token == "\\paragraph_separation") {
 527                 string parsep;
 528                 lex >> parsep;
 529                 paragraph_separation = parseptranslator().find(parsep);
 530         } else if (token == "\\defskip") {
 531                 lex.next();
 532                 pimpl_->defskip = VSpace(lex.getString());
 533         } else if (token == "\\quotes_language") {
 534                 string quotes_lang;
 535                 lex >> quotes_lang;
 536                 quotes_language = quoteslangtranslator().find(quotes_lang);
 537         } else if (token == "\\papersize") {
 538                 string ppsize;
 539                 lex >> ppsize;
 540                 papersize = papersizetranslator().find(ppsize);
 541         } else if (token == "\\use_geometry") {
 542                 lex >> use_geometry;
 543         } else if (token == "\\use_amsmath") {
 544                 int use_ams;
 545                 lex >> use_ams;
 546                 use_amsmath = packagetranslator().find(use_ams);
 547         } else if (token == "\\use_esint") {
 548                 int useesint;
 549                 lex >> useesint;
 550                 use_esint = packagetranslator().find(useesint);
 551         } else if (token == "\\cite_engine") {
 552                 string engine;
 553                 lex >> engine;
 554                 cite_engine_ = citeenginetranslator().find(engine);
 555         } else if (token == "\\use_bibtopic") {
 556                 lex >> use_bibtopic;
 557         } else if (token == "\\tracking_changes") {
 558                 lex >> trackChanges;
 559         } else if (token == "\\output_changes") {
 560                 lex >> outputChanges;
 561         } else if (token == "\\branch") {
 562                 lex.next();
 563                 docstring branch = lex.getDocString();
 564                 branchlist().add(branch);
 565                 while (true) {
 566                         lex.next();
 567                         string const tok = lex.getString();
 568                         if (tok == "\\end_branch")
 569                                 break;
 570                         Branch * branch_ptr = branchlist().find(branch);
 571                         if (tok == "\\selected") {
 572                                 lex.next();
 573                                 if (branch_ptr)
 574                                         branch_ptr->setSelected(lex.getInteger());
 575                         }
 576                         // not yet operational
 577                         if (tok == "\\color") {
 578                                 lex.eatLine();
 579                                 string color = lex.getString();
 580                                 if (branch_ptr)
 581                                         branch_ptr->setColor(color);
 582                                 // Update also the Color table:
 583                                 if (color == "none")
 584                                         color = lcolor.getX11Name(Color_background);
 585                                 // FIXME UNICODE
 586                                 lcolor.setColor(to_utf8(branch), color);
 587
 588                         }
 589                 }
 590         } else if (token == "\\author") {
 591                 lex.eatLine();
 592                 istringstream ss(lex.getString());
 593                 Author a;
 594                 ss >> a;
 595                 author_map.push_back(pimpl_->authorlist.record(a));
 596         } else if (token == "\\paperorientation") {
 597                 string orient;
 598                 lex >> orient;
 599                 orientation = paperorientationtranslator().find(orient);
 600         } else if (token == "\\paperwidth") {
 601                 lex >> paperwidth;
 602         } else if (token == "\\paperheight") {
 603                 lex >> paperheight;
 604         } else if (token == "\\leftmargin") {
 605                 lex >> leftmargin;
 606         } else if (token == "\\topmargin") {
 607                 lex >> topmargin;
 608         } else if (token == "\\rightmargin") {
 609                 lex >> rightmargin;
 610         } else if (token == "\\bottommargin") {
 611                 lex >> bottommargin;
 612         } else if (token == "\\headheight") {
 613                 lex >> headheight;
 614         } else if (token == "\\headsep") {
 615                 lex >> headsep;
 616         } else if (token == "\\footskip") {
 617                 lex >> footskip;
 618         } else if (token == "\\paperfontsize") {
 619                 lex >> fontsize;
 620         } else if (token == "\\papercolumns") {
 621                 lex >> columns;
 622         } else if (token == "\\listings_params") {
 623                 string par;
 624                 lex >> par;
 625                 listings_params = InsetListingsParams(par).params();
 626         } else if (token == "\\papersides") {
 627                 int psides;
 628                 lex >> psides;
 629                 sides = sidestranslator().find(psides);
 630         } else if (token == "\\paperpagestyle") {
 631                 lex >> pagestyle;
 632         } else if (token == "\\bullet") {
 633                 readBullets(lex);
 634         } else if (token == "\\bulletLaTeX") {
 635                 readBulletsLaTeX(lex);
 636         } else if (token == "\\secnumdepth") {
 637                 lex >> secnumdepth;
 638         } else if (token == "\\tocdepth") {
 639                 lex >> tocdepth;
 640         } else if (token == "\\spacing") {
 641                 string nspacing;
 642                 lex >> nspacing;
 643                 string tmp_val;
 644                 if (nspacing == "other") {
 645                         lex >> tmp_val;
 646                 }
 647                 spacing().set(spacetranslator().find(nspacing), tmp_val);
 648         } else if (token == "\\float_placement") {
 649                 lex >> float_placement;
 650
 651         } else if (prefixIs(token, "\\pdf_") || token == "\\use_hyperref") {
 652                 string toktmp = pdfoptions().readToken(lex, token);
 653                 if (!toktmp.empty()) {
 654                         lyxerr << "PDFOptions::readToken(): Unknown token: " <<
 655                                 toktmp << endl;
 656                         return toktmp;
 657                 }
 658         } else {
 659                 lyxerr << "BufferParams::readToken(): Unknown token: " <<
 660                         token << endl;
 661                 return token;
 662         }
 663
 664         return string();
 665 }
 666
 667
 668 void BufferParams::writeFile(ostream & os) const
 669 {
 670         // The top of the file is written by the buffer.
 671         // Prints out the buffer info into the .lyx file given by file
 672
 673         // the textclass
 674         os << "\\textclass " << textclasslist[baseClass_].name() << '\n';
 675
 676         // then the preamble
 677         if (!preamble.empty()) {
 678                 // remove '\n' from the end of preamble
 679                 string const tmppreamble = rtrim(preamble, "\n");
 680                 os << "\\begin_preamble\n"
 681                    << tmppreamble
 682                    << "\n\\end_preamble\n";
 683         }
 684
 685         // the options
 686         if (!options.empty()) {
 687                 os << "\\options " << options << '\n';
 688         }
 689
 690         //the modules
 691         if (!layoutModules_.empty()) {
 692                 os << "\\begin_modules" << '\n';
 693                 LayoutModuleList::const_iterator it = layoutModules_.begin();
 694                 for (; it != layoutModules_.end(); it++)
 695                         os << *it << '\n';
 696                 os << "\\end_modules" << '\n';
 697         }
 698
 699         // then the text parameters
 700         if (language != ignore_language)
 701                 os << "\\language " << language->lang() << '\n';
 702         os << "\\inputencoding " << inputenc
 703            << "\n\\font_roman " << fontsRoman
 704            << "\n\\font_sans " << fontsSans
 705            << "\n\\font_typewriter " << fontsTypewriter
 706            << "\n\\font_default_family " << fontsDefaultFamily
 707            << "\n\\font_sc " << convert<string>(fontsSC)
 708            << "\n\\font_osf " << convert<string>(fontsOSF)
 709            << "\n\\font_sf_scale " << fontsSansScale
 710            << "\n\\font_tt_scale " << fontsTypewriterScale
 711            << "\n\\graphics " << graphicsDriver << '\n';
 712
 713         if (!float_placement.empty()) {
 714                 os << "\\float_placement " << float_placement << '\n';
 715         }
 716         os << "\\paperfontsize " << fontsize << '\n';
 717
 718         spacing().writeFile(os);
 719         pdfoptions().writeFile(os);
 720
 721         os << "\\papersize " << string_papersize[papersize]
 722            << "\n\\use_geometry " << convert<string>(use_geometry)
 723            << "\n\\use_amsmath " << use_amsmath
 724            << "\n\\use_esint " << use_esint
 725            << "\n\\cite_engine " << citeenginetranslator().find(cite_engine_)
 726            << "\n\\use_bibtopic " << convert<string>(use_bibtopic)
 727            << "\n\\paperorientation " << string_orientation[orientation]
 728            << '\n';
 729
 730         BranchList::const_iterator it = branchlist().begin();
 731         BranchList::const_iterator end = branchlist().end();
 732         for (; it != end; ++it) {
 733                 os << "\\branch " << to_utf8(it->getBranch())
 734                    << "\n\\selected " << it->getSelected()
 735                    << "\n\\color " << lyx::X11hexname(it->getColor())
 736                    << "\n\\end_branch"
 737                    << "\n";
 738         }
 739
 740         if (!paperwidth.empty())
 741                 os << "\\paperwidth "
 742                    << VSpace(paperwidth).asLyXCommand() << '\n';
 743         if (!paperheight.empty())
 744                 os << "\\paperheight "
 745                    << VSpace(paperheight).asLyXCommand() << '\n';
 746         if (!leftmargin.empty())
 747                 os << "\\leftmargin "
 748                    << VSpace(leftmargin).asLyXCommand() << '\n';
 749         if (!topmargin.empty())
 750                 os << "\\topmargin "
 751                    << VSpace(topmargin).asLyXCommand() << '\n';
 752         if (!rightmargin.empty())
 753                 os << "\\rightmargin "
 754                    << VSpace(rightmargin).asLyXCommand() << '\n';
 755         if (!bottommargin.empty())
 756                 os << "\\bottommargin "
 757                    << VSpace(bottommargin).asLyXCommand() << '\n';
 758         if (!headheight.empty())
 759                 os << "\\headheight "
 760                    << VSpace(headheight).asLyXCommand() << '\n';
 761         if (!headsep.empty())
 762                 os << "\\headsep "
 763                    << VSpace(headsep).asLyXCommand() << '\n';
 764         if (!footskip.empty())
 765                 os << "\\footskip "
 766                    << VSpace(footskip).asLyXCommand() << '\n';
 767         os << "\\secnumdepth " << secnumdepth
 768            << "\n\\tocdepth " << tocdepth
 769            << "\n\\paragraph_separation "
 770            << string_paragraph_separation[paragraph_separation]
 771            << "\n\\defskip " << getDefSkip().asLyXCommand()
 772            << "\n\\quotes_language "
 773            << string_quotes_language[quotes_language]
 774            << "\n\\papercolumns " << columns
 775            << "\n\\papersides " << sides
 776            << "\n\\paperpagestyle " << pagestyle << '\n';
 777         if (!listings_params.empty())
 778                 os << "\\listings_params \"" <<
 779                         InsetListingsParams(listings_params).encodedString() << "\"\n";
 780         for (int i = 0; i < 4; ++i) {
 781                 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
 782                         if (user_defined_bullet(i).getFont() != -1) {
 783                                 os << "\\bullet " << i << " "
 784                                    << user_defined_bullet(i).getFont() << " "
 785                                    << user_defined_bullet(i).getCharacter() << " "
 786                                    << user_defined_bullet(i).getSize() << "\n";
 787                         }
 788                         else {
 789                                 // FIXME UNICODE
 790                                 os << "\\bulletLaTeX " << i << " \""
 791                                    << lyx::to_ascii(user_defined_bullet(i).getText())
 792                                    << "\"\n";
 793                         }
 794                 }
 795         }
 796
 797         os << "\\tracking_changes " << convert<string>(trackChanges) << "\n";
 798         os << "\\output_changes " << convert<string>(outputChanges) << "\n";
 799
 800         AuthorList::Authors::const_iterator a_it = pimpl_->authorlist.begin();
 801         AuthorList::Authors::const_iterator a_end = pimpl_->authorlist.end();
 802         for (; a_it != a_end; ++a_it) {
 803                 if (a_it->second.used())
 804                         os << "\\author " << a_it->second << "\n";
 805                 else
 806                         os << "\\author " << Author() << "\n";
 807         }
 808 }
 809
 810
 811 void BufferParams::validate(LaTeXFeatures & features) const
 812 {
 813         if (!getTextClass().requires().empty()) {
 814                 vector<string> req = getTextClass().requires();
 815                 for (vector<string>::const_iterator it = req.begin();
 816                      it != req.end(); ++it) {
 817                         features.require(*it);
 818                 }
 819         }
 820
 821         if (outputChanges) {
 822                 bool dvipost    = LaTeXFeatures::isAvailable("dvipost");
 823                 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
 824                                   LaTeXFeatures::isAvailable("xcolor");
 825
 826                 switch (features.runparams().flavor) {
 827                 case OutputParams::LATEX:
 828                         if (dvipost) {
 829                                 features.require("ct-dvipost");
 830                                 features.require("dvipost");
 831                         } else if (xcolorsoul) {
 832                                 features.require("ct-xcolor-soul");
 833                                 features.require("soul");
 834                                 features.require("xcolor");
 835                         } else {
 836                                 features.require("ct-none");
 837                         }
 838                         break;
 839                 case OutputParams::PDFLATEX:
 840                         if (xcolorsoul) {
 841                                 features.require("ct-xcolor-soul");
 842                                 features.require("soul");
 843                                 features.require("xcolor");
 844                                 // improves color handling in PDF output
 845                                 features.require("pdfcolmk");
 846                         } else {
 847                                 features.require("ct-none");
 848                         }
 849                         break;
 850                 default:
 851                         break;
 852                 }
 853         }
 854
 855         // Floats with 'Here definitely' as default setting.
 856         if (float_placement.find('H') != string::npos)
 857                 features.require("float");
 858
 859         // AMS Style is at document level
 860         if (use_amsmath == package_on
 861             || getTextClass().provides("amsmath"))
 862                 features.require("amsmath");
 863         if (use_esint == package_on)
 864                 features.require("esint");
 865
 866         // the bullet shapes are buffer level not paragraph level
 867         // so they are tested here
 868         for (int i = 0; i < 4; ++i) {
 869                 if (user_defined_bullet(i) == ITEMIZE_DEFAULTS[i])
 870                         continue;
 871                 int const font = user_defined_bullet(i).getFont();
 872                 if (font == 0) {
 873                         int const c = user_defined_bullet(i).getCharacter();
 874                         if (c == 16
 875                             || c == 17
 876                             || c == 25
 877                             || c == 26
 878                             || c == 31) {
 879                                 features.require("latexsym");
 880                         }
 881                 } else if (font == 1) {
 882                         features.require("amssymb");
 883                 } else if (font >= 2 && font <= 5) {
 884                         features.require("pifont");
 885                 }
 886         }
 887 }
 888
 889
 890 bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
 891                               TexRow & texrow) const
 892 {
 893         os << "\\documentclass";
 894
 895         TextClass const & tclass = getTextClass();
 896
 897         ostringstream clsoptions; // the document class options.
 898
 899         if (tokenPos(tclass.opt_fontsize(),
 900                      '|', fontsize) >= 0) {
 901                 // only write if existing in list (and not default)
 902                 clsoptions << fontsize << "pt,";
 903         }
 904
 905         // custom, A3, B3 and B4 paper sizes need geometry
 906         bool nonstandard_papersize = papersize == PAPER_B3
 907                 || papersize == PAPER_B4
 908                 || papersize == PAPER_A3
 909                 || papersize == PAPER_CUSTOM;
 910
 911         if (!use_geometry) {
 912                 switch (papersize) {
 913                 case PAPER_A4:
 914                         clsoptions << "a4paper,";
 915                         break;
 916                 case PAPER_USLETTER:
 917                         clsoptions << "letterpaper,";
 918                         break;
 919                 case PAPER_A5:
 920                         clsoptions << "a5paper,";
 921                         break;
 922                 case PAPER_B5:
 923                         clsoptions << "b5paper,";
 924                         break;
 925                 case PAPER_USEXECUTIVE:
 926                         clsoptions << "executivepaper,";
 927                         break;
 928                 case PAPER_USLEGAL:
 929                         clsoptions << "legalpaper,";
 930                         break;
 931                 case PAPER_DEFAULT:
 932                 case PAPER_A3:
 933                 case PAPER_B3:
 934                 case PAPER_B4:
 935                 case PAPER_CUSTOM:
 936                         break;
 937                 }
 938         }
 939
 940         // if needed
 941         if (sides != tclass.sides()) {
 942                 switch (sides) {
 943                 case OneSide:
 944                         clsoptions << "oneside,";
 945                         break;
 946                 case TwoSides:
 947                         clsoptions << "twoside,";
 948                         break;
 949                 }
 950         }
 951
 952         // if needed
 953         if (columns != tclass.columns()) {
 954                 if (columns == 2)
 955                         clsoptions << "twocolumn,";
 956                 else
 957                         clsoptions << "onecolumn,";
 958         }
 959
 960         if (!use_geometry
 961             && orientation == ORIENTATION_LANDSCAPE)
 962                 clsoptions << "landscape,";
 963
 964         // language should be a parameter to \documentclass
 965         if (language->babel() == "hebrew"
 966             && default_language->babel() != "hebrew")
 967                 // This seems necessary
 968                 features.useLanguage(default_language);
 969
 970         ostringstream language_options;
 971         bool const use_babel = features.useBabel();
 972         if (use_babel) {
 973                 language_options << features.getLanguages();
 974                 if (!language->babel().empty()) {
 975                         if (!language_options.str().empty())
 976                                 language_options << ',';
 977                         language_options << language->babel();
 978                 }
 979                 // when Vietnamese is used, babel must directly be loaded with the
 980                 // language options, not in the class options, see
 981                 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129417.html
 982                 size_t viet = language_options.str().find("vietnam");
 983                 // viet = string::npos when not found
 984                 if (lyxrc.language_global_options && !language_options.str().empty()
 985                         && viet == string::npos)
 986                         clsoptions << language_options.str() << ',';
 987         }
 988
 989         // the user-defined options
 990         if (!options.empty()) {
 991                 clsoptions << options << ',';
 992         }
 993
 994         string strOptions(clsoptions.str());
 995         if (!strOptions.empty()) {
 996                 strOptions = rtrim(strOptions, ",");
 997                 // FIXME UNICODE
 998                 os << '[' << from_utf8(strOptions) << ']';
 999         }
1000
1001         os << '{' << from_ascii(tclass.latexname()) << "}\n";
1002         texrow.newline();
1003         // end of \documentclass defs
1004
1005         // font selection must be done before loading fontenc.sty
1006         string const fonts =
1007                 loadFonts(fontsRoman, fontsSans,
1008                           fontsTypewriter, fontsSC, fontsOSF,
1009                           fontsSansScale, fontsTypewriterScale);
1010         if (!fonts.empty()) {
1011                 os << from_ascii(fonts);
1012                 texrow.newline();
1013         }
1014         if (fontsDefaultFamily != "default")
1015                 os << "\\renewcommand{\\familydefault}{\\"
1016                    << from_ascii(fontsDefaultFamily) << "}\n";
1017
1018         // set font encoding
1019         // this one is not per buffer
1020         // for arabic_arabi and farsi we also need to load the LAE and LFE encoding
1021         if (lyxrc.fontenc != "default") {
1022                 if (language->lang() == "arabic_arabi" || language->lang() == "farsi") {
1023                         os << "\\usepackage[" << from_ascii(lyxrc.fontenc)
1024                            << ",LFE,LAE]{fontenc}\n";
1025                         texrow.newline();
1026                 } else {
1027                         os << "\\usepackage[" << from_ascii(lyxrc.fontenc)
1028                            << "]{fontenc}\n";
1029                         texrow.newline();
1030                 }
1031         }
1032
1033         // handle inputenc etc.
1034         writeEncodingPreamble(os, features, texrow);
1035
1036         if (!listings_params.empty()) {
1037                 os << "\\usepackage{listings}\n";
1038                 texrow.newline();
1039                 os << "\\lstset{";
1040                 // do not test validity because listings_params is supposed to be valid
1041                 string par = InsetListingsParams(listings_params).separatedParams(true);
1042                 os << from_ascii(par);
1043                 // count the number of newlines
1044                 for (size_t i = 0; i < par.size(); ++i)
1045                         if (par[i] == '\n')
1046                                 texrow.newline();
1047                 os << "}\n";
1048                 texrow.newline();
1049         }
1050         if (use_geometry || nonstandard_papersize) {
1051                 os << "\\usepackage{geometry}\n";
1052                 texrow.newline();
1053                 os << "\\geometry{verbose";
1054                 if (orientation == ORIENTATION_LANDSCAPE)
1055                         os << ",landscape";
1056                 switch (papersize) {
1057                 case PAPER_CUSTOM:
1058                         if (!paperwidth.empty())
1059                                 os << ",paperwidth="
1060                                    << from_ascii(paperwidth);
1061                         if (!paperheight.empty())
1062                                 os << ",paperheight="
1063                                    << from_ascii(paperheight);
1064                         break;
1065                 case PAPER_USLETTER:
1066                         os << ",letterpaper";
1067                         break;
1068                 case PAPER_USLEGAL:
1069                         os << ",legalpaper";
1070                         break;
1071                 case PAPER_USEXECUTIVE:
1072                         os << ",executivepaper";
1073                         break;
1074                 case PAPER_A3:
1075                         os << ",a3paper";
1076                         break;
1077                 case PAPER_A4:
1078                         os << ",a4paper";
1079                         break;
1080                 case PAPER_A5:
1081                         os << ",a5paper";
1082                         break;
1083                 case PAPER_B3:
1084                         os << ",b3paper";
1085                         break;
1086                 case PAPER_B4:
1087                         os << ",b4paper";
1088                         break;
1089                 case PAPER_B5:
1090                         os << ",b5paper";
1091                         break;
1092                 default:
1093                         // default papersize ie PAPER_DEFAULT
1094                         switch (lyxrc.default_papersize) {
1095                         case PAPER_DEFAULT: // keep compiler happy
1096                         case PAPER_USLETTER:
1097                                 os << ",letterpaper";
1098                                 break;
1099                         case PAPER_USLEGAL:
1100                                 os << ",legalpaper";
1101                                 break;
1102                         case PAPER_USEXECUTIVE:
1103                                 os << ",executivepaper";
1104                                 break;
1105                         case PAPER_A3:
1106                                 os << ",a3paper";
1107                                 break;
1108                         case PAPER_A4:
1109                                 os << ",a4paper";
1110                                 break;
1111                         case PAPER_A5:
1112                                 os << ",a5paper";
1113                                 break;
1114                         case PAPER_B5:
1115                                 os << ",b5paper";
1116                                 break;
1117                         case PAPER_B3:
1118                         case PAPER_B4:
1119                         case PAPER_CUSTOM:
1120                                 break;
1121                         }
1122                 }
1123                 if (!topmargin.empty())
1124                         os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1125                 if (!bottommargin.empty())
1126                         os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1127                 if (!leftmargin.empty())
1128                         os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1129                 if (!rightmargin.empty())
1130                         os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1131                 if (!headheight.empty())
1132                         os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1133                 if (!headsep.empty())
1134                         os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1135                 if (!footskip.empty())
1136                         os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1137                 os << "}\n";
1138                 texrow.newline();
1139         }
1140
1141         if (tokenPos(tclass.opt_pagestyle(),
1142                      '|', pagestyle) >= 0) {
1143                 if (pagestyle == "fancy") {
1144                         os << "\\usepackage{fancyhdr}\n";
1145                         texrow.newline();
1146                 }
1147                 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1148                 texrow.newline();
1149         }
1150
1151         // Only if class has a ToC hierarchy
1152         if (tclass.hasTocLevels()) {
1153                 if (secnumdepth != tclass.secnumdepth()) {
1154                         os << "\\setcounter{secnumdepth}{"
1155                            << secnumdepth
1156                            << "}\n";
1157                         texrow.newline();
1158                 }
1159                 if (tocdepth != tclass.tocdepth()) {
1160                         os << "\\setcounter{tocdepth}{"
1161                            << tocdepth
1162                            << "}\n";
1163                         texrow.newline();
1164                 }
1165         }
1166
1167         if (paragraph_separation) {
1168                 switch (getDefSkip().kind()) {
1169                 case VSpace::SMALLSKIP:
1170                         os << "\\setlength{\\parskip}{\\smallskipamount}\n";
1171                         break;
1172                 case VSpace::MEDSKIP:
1173                         os << "\\setlength{\\parskip}{\\medskipamount}\n";
1174                         break;
1175                 case VSpace::BIGSKIP:
1176                         os << "\\setlength{\\parskip}{\\bigskipamount}\n";
1177                         break;
1178                 case VSpace::LENGTH:
1179                         os << "\\setlength{\\parskip}{"
1180                            << from_utf8(getDefSkip().length().asLatexString())
1181                            << "}\n";
1182                         break;
1183                 default: // should never happen // Then delete it.
1184                         os << "\\setlength{\\parskip}{\\medskipamount}\n";
1185                         break;
1186                 }
1187                 texrow.newline();
1188
1189                 os << "\\setlength{\\parindent}{0pt}\n";
1190                 texrow.newline();
1191         }
1192
1193         // If we use jurabib, we have to call babel here.
1194         if (use_babel && features.isRequired("jurabib")) {
1195                 os << from_ascii(babelCall(language_options.str()))
1196                    << '\n'
1197                    << from_ascii(features.getBabelOptions());
1198                 texrow.newline();
1199         }
1200
1201         // Now insert the LyX specific LaTeX commands...
1202
1203         // The optional packages;
1204         docstring lyxpreamble(from_ascii(features.getPackages()));
1205
1206         // We try to load babel late, in case it interferes
1207         // with other packages. But some packages also need babel to be loaded
1208         // before, e.g. jurabib has to be called after babel.
1209         // So load babel after the optional packages but before the user-defined
1210         // preamble. This allows the users to redefine babel commands, e.g. to
1211         // translate the word "Index" to the German "Stichwortverzeichnis".
1212         // For more infos why this place was chosen, see
1213         // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg128425.html
1214         // If you encounter problems, you can shift babel to its old place behind
1215         // the user-defined preamble. But in this case you must change the Vietnamese
1216         // support from currently "\usepackage[vietnamese]{babel}" to:
1217         // \usepackage{vietnamese}
1218         // \usepackage{babel}
1219         // because vietnamese must be loaded before hyperref
1220         if (use_babel && !features.isRequired("jurabib")) {
1221                 // FIXME UNICODE
1222                 lyxpreamble += from_utf8(babelCall(language_options.str())) + '\n';
1223                 lyxpreamble += from_utf8(features.getBabelOptions());
1224         }
1225
1226         // When the language "japanese-plain" is used, the package "japanese" must
1227         // be loaded behind babel (it provides babel support for Japanese) but before
1228         // hyperref, see
1229         // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
1230         if (language->lang() == "japanese-plain" &&
1231                 !getTextClass().provides("japanese")) {
1232                 //load babel in case it was not loaded due to an empty language list
1233                 if (language_options.str().empty())
1234                         lyxpreamble += "\\usepackage{babel}\n";
1235                 lyxpreamble += "\\usepackage{japanese}\n";
1236         }
1237
1238         // PDF support.
1239         // * Hyperref manual: "Make sure it comes last of your loaded
1240         //   packages, to give it a fighting chance of not being over-written,
1241         //   since its job is to redefine many LATEX commands."
1242         // * Email from Heiko Oberdiek: "It is usually better to load babel
1243         //   before hyperref. Then hyperref has a chance to detect babel.
1244         // * Has to be loaded before the "LyX specific LaTeX commands" to
1245         //   avoid errors with algorithm floats.
1246         odocstringstream oss;
1247         // use hyperref explicitely when it is required
1248         pdfoptions().writeLaTeX(oss, features.isRequired("hyperref"));
1249         lyxpreamble += oss.str();
1250
1251         // this might be useful...
1252         lyxpreamble += "\n\\makeatletter\n";
1253
1254         // Some macros LyX will need
1255         docstring tmppreamble(from_ascii(features.getMacros()));
1256
1257         if (!tmppreamble.empty()) {
1258                 lyxpreamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1259                         "LyX specific LaTeX commands.\n"
1260                         + tmppreamble + '\n';
1261         }
1262
1263         // the text class specific preamble
1264         tmppreamble = features.getTClassPreamble();
1265         if (!tmppreamble.empty()) {
1266                 lyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1267                         "Textclass specific LaTeX commands.\n"
1268                         + tmppreamble + '\n';
1269         }
1270
1271         /* the user-defined preamble */
1272         if (!preamble.empty()) {
1273                 // FIXME UNICODE
1274                 lyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1275                         "User specified LaTeX commands.\n"
1276                         + from_utf8(preamble) + '\n';
1277         }
1278
1279         // Itemize bullet settings need to be last in case the user
1280         // defines their own bullets that use a package included
1281         // in the user-defined preamble -- ARRae
1282         // Actually it has to be done much later than that
1283         // since some packages like frenchb make modifications
1284         // at \begin{document} time -- JMarc
1285         docstring bullets_def;
1286         for (int i = 0; i < 4; ++i) {
1287                 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1288                         if (bullets_def.empty())
1289                                 bullets_def += "\\AtBeginDocument{\n";
1290                         bullets_def += "  \\def\\labelitemi";
1291                         switch (i) {
1292                                 // `i' is one less than the item to modify
1293                         case 0:
1294                                 break;
1295                         case 1:
1296                                 bullets_def += 'i';
1297                                 break;
1298                         case 2:
1299                                 bullets_def += "ii";
1300                                 break;
1301                         case 3:
1302                                 bullets_def += 'v';
1303                                 break;
1304                         }
1305                         bullets_def += '{' +
1306                                 user_defined_bullet(i).getText()
1307                                 + "}\n";
1308                 }
1309         }
1310
1311         if (!bullets_def.empty())
1312                 lyxpreamble += bullets_def + "}\n\n";
1313
1314         lyxpreamble += "\\makeatother\n\n";
1315
1316         int const nlines =
1317                 int(count(lyxpreamble.begin(), lyxpreamble.end(), '\n'));
1318         for (int j = 0; j != nlines; ++j) {
1319                 texrow.newline();
1320         }
1321
1322         os << lyxpreamble;
1323         return use_babel;
1324 }
1325
1326
1327 void BufferParams::useClassDefaults()
1328 {
1329         TextClass const & tclass = textclasslist[baseClass_];
1330
1331         sides = tclass.sides();
1332         columns = tclass.columns();
1333         pagestyle = tclass.pagestyle();
1334         options = tclass.options();
1335         // Only if class has a ToC hierarchy
1336         if (tclass.hasTocLevels()) {
1337                 secnumdepth = tclass.secnumdepth();
1338                 tocdepth = tclass.tocdepth();
1339         }
1340 }
1341
1342
1343 bool BufferParams::hasClassDefaults() const
1344 {
1345         TextClass const & tclass = textclasslist[baseClass_];
1346
1347         return (sides == tclass.sides()
1348                 && columns == tclass.columns()
1349                 && pagestyle == tclass.pagestyle()
1350                 && options == tclass.options()
1351                 && secnumdepth == tclass.secnumdepth()
1352                 && tocdepth == tclass.tocdepth());
1353 }
1354
1355
1356 TextClass const & BufferParams::getTextClass() const
1357 {
1358         return *textClass_;
1359 }
1360
1361
1362 TextClassPtr BufferParams::getTextClassPtr() const {
1363         return textClass_;
1364 }
1365
1366
1367 void BufferParams::setTextClass(TextClassPtr tc) {
1368         textClass_ = tc;
1369 }
1370
1371
1372 bool BufferParams::setBaseClass(textclass_type tc)
1373 {
1374         if (textclasslist[tc].load()) {
1375                 baseClass_ = tc;
1376                 return true;
1377         }
1378
1379         docstring s =
1380                 bformat(_("The document class %1$s could not be loaded."),
1381                 from_utf8(textclasslist[tc].name()));
1382         frontend::Alert::error(_("Could not load class"), s);
1383         return false;
1384 }
1385
1386
1387 textclass_type BufferParams::getBaseClass() const
1388 {
1389         return baseClass_;
1390 }
1391
1392
1393 void BufferParams::makeTextClass()
1394 {
1395         textClass_.reset(new TextClass(textclasslist[getBaseClass()]));
1396
1397         //FIXME It might be worth loading the children's modules here,
1398         //just as we load their bibliographies and such, instead of just
1399         //doing a check in InsetInclude.
1400         LayoutModuleList::const_iterator it = layoutModules_.begin();
1401         for (; it != layoutModules_.end(); it++) {
1402                 string const modName = *it;
1403                 LyXModule * lm = moduleList[modName];
1404                 if (!lm) {
1405                         docstring const msg =
1406                                 bformat(_("The module %1$s has been requested by\n"
1407                                         "this document but has not been found in the list of\n"
1408                                         "available modules. If you recently installed it, you\n"
1409                                         "probably need to reconfigure LyX.\n"), from_utf8(modName));
1410                         frontend::Alert::warning(_("Module not available"),
1411                                         msg + _("Some layouts may not be available."));
1412                         lyxerr << "BufferParams::makeTextClass(): Module " <<
1413                                         modName << " requested but not found in module list." <<
1414                                         endl;
1415                         continue;
1416                 }
1417                 if (!lm->isAvailable()) {
1418                         docstring const msg =
1419                                                 bformat(_("The module %1$s requires a package that is\n"
1420                                                 "not available in your LaTeX installation. LaTeX output\n"
1421                                                 "may not be possible.\n"), from_utf8(modName));
1422                         frontend::Alert::warning(_("Package not available"), msg);
1423                 }
1424                 FileName layout_file = libFileSearch("layouts", lm->getFilename());
1425                 textClass_->read(layout_file, TextClass::MODULE);
1426         }
1427 }
1428
1429
1430 vector<string> const & BufferParams::getModules() const {
1431         return layoutModules_;
1432 }
1433
1434
1435
1436 bool BufferParams::addLayoutModule(string const & modName) {
1437         LayoutModuleList::const_iterator it = layoutModules_.begin();
1438         LayoutModuleList::const_iterator end = layoutModules_.end();
1439         for (; it != end; it++) {
1440                 if (*it == modName)
1441                         break;
1442         }
1443         if (it != layoutModules_.end())
1444                 return false;
1445         layoutModules_.push_back(modName);
1446         return true;
1447 }
1448
1449
1450 void BufferParams::clearLayoutModules() {
1451         layoutModules_.clear();
1452 }
1453
1454
1455 Font const BufferParams::getFont() const
1456 {
1457         FontInfo f = getTextClass().defaultfont();
1458         if (fontsDefaultFamily == "rmdefault")
1459                 f.setFamily(ROMAN_FAMILY);
1460         else if (fontsDefaultFamily == "sfdefault")
1461                 f.setFamily(SANS_FAMILY);
1462         else if (fontsDefaultFamily == "ttdefault")
1463                 f.setFamily(TYPEWRITER_FAMILY);
1464         return Font(f, language);
1465 }
1466
1467
1468 void BufferParams::readPreamble(Lexer & lex)
1469 {
1470         if (lex.getString() != "\\begin_preamble")
1471                 lyxerr << "Error (BufferParams::readPreamble):"
1472                         "consistency check failed." << endl;
1473
1474         preamble = lex.getLongString("\\end_preamble");
1475 }
1476
1477
1478 void BufferParams::readLanguage(Lexer & lex)
1479 {
1480         if (!lex.next()) return;
1481
1482         string const tmptok = lex.getString();
1483
1484         // check if tmptok is part of tex_babel in tex-defs.h
1485         language = languages.getLanguage(tmptok);
1486         if (!language) {
1487                 // Language tmptok was not found
1488                 language = default_language;
1489                 lyxerr << "Warning: Setting language `"
1490                        << tmptok << "' to `" << language->lang()
1491                        << "'." << endl;
1492         }
1493 }
1494
1495
1496 void BufferParams::readGraphicsDriver(Lexer & lex)
1497 {
1498         if (!lex.next()) return;
1499
1500         string const tmptok = lex.getString();
1501         // check if tmptok is part of tex_graphics in tex_defs.h
1502         int n = 0;
1503         while (true) {
1504                 string const test = tex_graphics[n++];
1505
1506                 if (test == tmptok) {
1507                         graphicsDriver = tmptok;
1508                         break;
1509                 } else if (test == "") {
1510                         lex.printError(
1511                                 "Warning: graphics driver `$$Token' not recognized!\n"
1512                                 "         Setting graphics driver to `default'.\n");
1513                         graphicsDriver = "default";
1514                         break;
1515                 }
1516         }
1517 }
1518
1519
1520 void BufferParams::readBullets(Lexer & lex)
1521 {
1522         if (!lex.next()) return;
1523
1524         int const index = lex.getInteger();
1525         lex.next();
1526         int temp_int = lex.getInteger();
1527         user_defined_bullet(index).setFont(temp_int);
1528         temp_bullet(index).setFont(temp_int);
1529         lex >> temp_int;
1530         user_defined_bullet(index).setCharacter(temp_int);
1531         temp_bullet(index).setCharacter(temp_int);
1532         lex >> temp_int;
1533         user_defined_bullet(index).setSize(temp_int);
1534         temp_bullet(index).setSize(temp_int);
1535 }
1536
1537
1538 void BufferParams::readBulletsLaTeX(Lexer & lex)
1539 {
1540         // The bullet class should be able to read this.
1541         if (!lex.next()) return;
1542         int const index = lex.getInteger();
1543         lex.next(true);
1544         docstring const temp_str = lex.getDocString();
1545
1546         user_defined_bullet(index).setText(temp_str);
1547         temp_bullet(index).setText(temp_str);
1548 }
1549
1550
1551 void BufferParams::readModules(Lexer & lex)
1552 {
1553         if (!lex.eatLine()) {
1554                 lyxerr << "Error (BufferParams::readModules):"
1555                                 "Unexpected end of input." << endl;
1556                 return;
1557         }
1558         while (true) {
1559                 string mod = lex.getString();
1560                 if (mod == "\\end_modules")
1561                         break;
1562                 addLayoutModule(mod);
1563                 lex.eatLine();
1564         }
1565 }
1566
1567
1568 string const BufferParams::paperSizeName() const
1569 {
1570         char real_papersize = papersize;
1571         if (real_papersize == PAPER_DEFAULT)
1572                 real_papersize = lyxrc.default_papersize;
1573
1574         switch (real_papersize) {
1575         case PAPER_A3:
1576                 return "a3";
1577         case PAPER_A4:
1578                 return "a4";
1579         case PAPER_A5:
1580                 return "a5";
1581         case PAPER_B5:
1582                 return "b5";
1583         case PAPER_USEXECUTIVE:
1584                 return "foolscap";
1585         case PAPER_USLEGAL:
1586                 return "legal";
1587         case PAPER_USLETTER:
1588         default:
1589                 return "letter";
1590         }
1591 }
1592
1593
1594 string const BufferParams::dvips_options() const
1595 {
1596         string result;
1597
1598         if (use_geometry
1599             && papersize == PAPER_CUSTOM
1600             && !lyxrc.print_paper_dimension_flag.empty()
1601             && !paperwidth.empty()
1602             && !paperheight.empty()) {
1603                 // using a custom papersize
1604                 result = lyxrc.print_paper_dimension_flag;
1605                 result += ' ' + paperwidth;
1606                 result += ',' + paperheight;
1607         } else {
1608                 string const paper_option = paperSizeName();
1609                 if (paper_option != "letter" ||
1610                     orientation != ORIENTATION_LANDSCAPE) {
1611                         // dvips won't accept -t letter -t landscape.
1612                         // In all other cases, include the paper size
1613                         // explicitly.
1614                         result = lyxrc.print_paper_flag;
1615                         result += ' ' + paper_option;
1616                 }
1617         }
1618         if (orientation == ORIENTATION_LANDSCAPE &&
1619             papersize != PAPER_CUSTOM)
1620                 result += ' ' + lyxrc.print_landscape_flag;
1621         return result;
1622 }
1623
1624
1625 string const BufferParams::babelCall(string const & lang_opts) const
1626 {
1627         string lang_pack = lyxrc.language_package;
1628         if (lang_pack != "\\usepackage{babel}")
1629                 return lang_pack;
1630         // suppress the babel call when there is no babel language defined
1631         // for the document language in the lib/languages file and if no
1632         // other languages are used (lang_opts is then empty)
1633         if (lang_opts.empty())
1634                 return string();
1635         // when Vietnamese is used, babel must directly be loaded with the
1636         // language options, see
1637         // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129417.html
1638         size_t viet = lang_opts.find("vietnam");
1639         // viet = string::npos when not found
1640         if (!lyxrc.language_global_options || viet != string::npos)
1641                 return "\\usepackage[" + lang_opts + "]{babel}";
1642         return lang_pack;
1643 }
1644
1645
1646 void BufferParams::writeEncodingPreamble(odocstream & os,
1647                 LaTeXFeatures & features, TexRow & texrow) const
1648 {
1649         if (inputenc == "auto") {
1650                 string const doc_encoding =
1651                         language->encoding()->latexName();
1652                 Encoding::Package const package =
1653                         language->encoding()->package();
1654
1655                 // Create a list with all the input encodings used
1656                 // in the document
1657                 set<string> encodings =
1658                         features.getEncodingSet(doc_encoding);
1659
1660                 // When the encodings EUC-JP-plain, JIS-plain, or SJIS-plainare used, the
1661                 // package inputenc must be omitted. Therefore set the encoding to empty.
1662                 // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
1663                 if (doc_encoding == "EUC-JP-plain" || doc_encoding == "JIS-plain" ||
1664                         doc_encoding == "SJIS-plain")
1665                         encodings.clear();
1666
1667                 if (!encodings.empty() || package == Encoding::inputenc) {
1668                         os << "\\usepackage[";
1669                         set<string>::const_iterator it = encodings.begin();
1670                         set<string>::const_iterator const end = encodings.end();
1671                         if (it != end) {
1672                                 os << from_ascii(*it);
1673                                 ++it;
1674                         }
1675                         for (; it != end; ++it)
1676                                 os << ',' << from_ascii(*it);
1677                         if (package == Encoding::inputenc) {
1678                                 if (!encodings.empty())
1679                                         os << ',';
1680                                 os << from_ascii(doc_encoding);
1681                         }
1682                         os << "]{inputenc}\n";
1683                         texrow.newline();
1684                 }
1685                 if (package == Encoding::CJK || features.mustProvide("CJK")) {
1686                         os << "\\usepackage{CJK}\n";
1687                         texrow.newline();
1688                 }
1689         } else if (inputenc != "default") {
1690                 switch (encoding().package()) {
1691                 case Encoding::none:
1692                         break;
1693                 case Encoding::inputenc:
1694                         os << "\\usepackage[" << from_ascii(inputenc)
1695                            << "]{inputenc}\n";
1696                         texrow.newline();
1697                         break;
1698                 case Encoding::CJK:
1699                         os << "\\usepackage{CJK}\n";
1700                         texrow.newline();
1701                         break;
1702                 }
1703         }
1704
1705         // The encoding "armscii8" is only available when the package "armtex" is loaded.
1706         // armscii8 is used for Armenian.
1707         if (language->encoding()->latexName() == "armscii8" || inputenc == "armscii8") {
1708                 os << "\\usepackage{armtex}\n";
1709                 texrow.newline();
1710         }
1711 }
1712
1713
1714 string const BufferParams::loadFonts(string const & rm,
1715                                      string const & sf, string const & tt,
1716                                      bool const & sc, bool const & osf,
1717                                      int const & sfscale, int const & ttscale) const
1718 {
1719         /* The LaTeX font world is in a flux. In the PSNFSS font interface,
1720            several packages have been replaced by others, that might not
1721            be installed on every system. We have to take care for that
1722            (see psnfss.pdf). We try to support all psnfss fonts as well
1723            as the fonts that have become de facto standard in the LaTeX
1724            world (e.g. Latin Modern). We do not support obsolete fonts
1725            (like PSLatex). In general, it should be possible to mix any
1726            rm font with any sf or tt font, respectively. (JSpitzm)
1727            TODO:
1728                 -- separate math fonts.
1729         */
1730
1731         if (rm == "default" && sf == "default" && tt == "default")
1732                 //nothing to do
1733                 return string();
1734
1735         ostringstream os;
1736
1737         // ROMAN FONTS
1738         // Computer Modern (must be explicitely selectable -- there might be classes
1739         // that define a different default font!
1740         if (rm == "cmr") {
1741                 os << "\\renewcommand{\\rmdefault}{cmr}\n";
1742                 // osf for Computer Modern needs eco.sty
1743                 if (osf)
1744                         os << "\\usepackage{eco}\n";
1745         }
1746         // Latin Modern Roman
1747         else if (rm == "lmodern")
1748                 os << "\\usepackage{lmodern}\n";
1749         // AE
1750         else if (rm == "ae") {
1751                 // not needed when using OT1 font encoding.
1752                 if (lyxrc.fontenc != "default")
1753                         os << "\\usepackage{ae,aecompl}\n";
1754         }
1755         // Times
1756         else if (rm == "times") {
1757                 // try to load the best available package
1758                 if (LaTeXFeatures::isAvailable("mathptmx"))
1759                         os << "\\usepackage{mathptmx}\n";
1760                 else if (LaTeXFeatures::isAvailable("mathptm"))
1761                         os << "\\usepackage{mathptm}\n";
1762                 else
1763                         os << "\\usepackage{times}\n";
1764         }
1765         // Palatino
1766         else if (rm == "palatino") {
1767                 // try to load the best available package
1768                 if (LaTeXFeatures::isAvailable("mathpazo")) {
1769                         os << "\\usepackage";
1770                         if (osf || sc) {
1771                                 os << '[';
1772                                 if (!osf)
1773                                         os << "sc";
1774                                 else
1775                                         // "osf" includes "sc"!
1776                                         os << "osf";
1777                                 os << ']';
1778                         }
1779                         os << "{mathpazo}\n";
1780                 }
1781                 else if (LaTeXFeatures::isAvailable("mathpple"))
1782                         os << "\\usepackage{mathpple}\n";
1783                 else
1784                         os << "\\usepackage{palatino}\n";
1785         }
1786         // Utopia
1787         else if (rm == "utopia") {
1788                 // fourier supersedes utopia.sty, but does
1789                 // not work with OT1 encoding.
1790                 if (LaTeXFeatures::isAvailable("fourier")
1791                     && lyxrc.fontenc != "default") {
1792                         os << "\\usepackage";
1793                         if (osf || sc) {
1794                                 os << '[';
1795                                 if (sc)
1796                                         os << "expert";
1797                                 if (osf && sc)
1798                                         os << ',';
1799                                 if (osf)
1800                                         os << "oldstyle";
1801                                 os << ']';
1802                         }
1803                         os << "{fourier}\n";
1804                 }
1805                 else
1806                         os << "\\usepackage{utopia}\n";
1807         }
1808         // Bera (complete fontset)
1809         else if (rm == "bera" && sf == "default" && tt == "default")
1810                 os << "\\usepackage{bera}\n";
1811         // everything else
1812         else if (rm != "default")
1813                 os << "\\usepackage" << "{" << rm << "}\n";
1814
1815         // SANS SERIF
1816         // Helvetica, Bera Sans
1817         if (sf == "helvet" || sf == "berasans") {
1818                 if (sfscale != 100)
1819                         os << "\\usepackage[scaled=" << float(sfscale) / 100
1820                            << "]{" << sf << "}\n";
1821                 else
1822                         os << "\\usepackage{" << sf << "}\n";
1823         }
1824         // Avant Garde
1825         else if (sf == "avant")
1826                 os << "\\usepackage{" << sf << "}\n";
1827         // Computer Modern, Latin Modern, CM Bright
1828         else if (sf != "default")
1829                 os << "\\renewcommand{\\sfdefault}{" << sf << "}\n";
1830
1831         // monospaced/typewriter
1832         // Courier, LuxiMono
1833         if (tt == "luximono" || tt == "beramono") {
1834                 if (ttscale != 100)
1835                         os << "\\usepackage[scaled=" << float(ttscale) / 100
1836                            << "]{" << tt << "}\n";
1837                 else
1838                         os << "\\usepackage{" << tt << "}\n";
1839         }
1840         // Courier
1841         else if (tt == "courier" )
1842                 os << "\\usepackage{" << tt << "}\n";
1843         // Computer Modern, Latin Modern, CM Bright
1844         else if  (tt != "default")
1845                 os << "\\renewcommand{\\ttdefault}{" << tt << "}\n";
1846
1847         return os.str();
1848 }
1849
1850
1851 Encoding const & BufferParams::encoding() const
1852 {
1853         if (inputenc == "auto" || inputenc == "default")
1854                 return *(language->encoding());
1855         Encoding const * const enc =
1856                 encodings.getFromLaTeXName(inputenc);
1857         if (enc)
1858                 return *enc;
1859         lyxerr << "Unknown inputenc value `" << inputenc
1860                << "'. Using `auto' instead." << endl;
1861         return *(language->encoding());
1862 }
1863
1864
1865 biblio::CiteEngine BufferParams::getEngine() const
1866 {
1867         // FIXME the class should provide the numerical/
1868         // authoryear choice
1869         if (getTextClass().provides("natbib")
1870             && cite_engine_ != biblio::ENGINE_NATBIB_NUMERICAL)
1871                 return biblio::ENGINE_NATBIB_AUTHORYEAR;
1872         return cite_engine_;
1873 }
1874
1875
1876 void BufferParams::setCiteEngine(biblio::CiteEngine const cite_engine)
1877 {
1878         cite_engine_ = cite_engine;
1879 }
1880
1881 } // namespace lyx