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 "LayoutFile.h"
  22 #include "BranchList.h"
  23 #include "buffer_funcs.h"
  24 #include "Bullet.h"
  25 #include "Color.h"
  26 #include "ColorSet.h"
  27 #include "Converter.h"
  28 #include "Encoding.h"
  29 #include "HSpace.h"
  30 #include "IndicesList.h"
  31 #include "Language.h"
  32 #include "LaTeXFeatures.h"
  33 #include "LaTeXFonts.h"
  34 #include "ModuleList.h"
  35 #include "Font.h"
  36 #include "Lexer.h"
  37 #include "LyXRC.h"
  38 #include "OutputParams.h"
  39 #include "Spacing.h"
  40 #include "TexRow.h"
  41 #include "VSpace.h"
  42 #include "PDFOptions.h"
  43
  44 #include "frontends/alert.h"
  45
  46 #include "insets/InsetListingsParams.h"
  47
  48 #include "support/convert.h"
  49 #include "support/debug.h"
  50 #include "support/docstream.h"
  51 #include "support/FileName.h"
  52 #include "support/filetools.h"
  53 #include "support/gettext.h"
  54 #include "support/Messages.h"
  55 #include "support/Translator.h"
  56 #include "support/lstrings.h"
  57
  58 #include <algorithm>
  59 #include <sstream>
  60
  61 using namespace std;
  62 using namespace lyx::support;
  63
  64
  65 static char const * const string_paragraph_separation[] = {
  66         "indent", "skip", ""
  67 };
  68
  69
  70 static char const * const string_quotes_language[] = {
  71         "english", "swedish", "german", "polish", "french", "danish", ""
  72 };
  73
  74
  75 static char const * const string_papersize[] = {
  76         "default", "custom", "letterpaper", "legalpaper", "executivepaper",
  77         "a0paper", "a1paper", "a2paper", "a3paper",     "a4paper", "a5paper",
  78         "a6paper", "b0paper", "b1paper", "b2paper","b3paper", "b4paper",
  79         "b5paper", "b6paper", "c0paper", "c1paper", "c2paper", "c3paper",
  80         "c4paper", "c5paper", "c6paper", "b0j", "b1j", "b2j", "b3j", "b4j", "b5j",
  81         "b6j", ""
  82 };
  83
  84
  85 static char const * const string_orientation[] = {
  86         "portrait", "landscape", ""
  87 };
  88
  89
  90 static char const * const string_footnotekinds[] = {
  91         "footnote", "margin", "fig", "tab", "alg", "wide-fig", "wide-tab", ""
  92 };
  93
  94
  95 static char const * const tex_graphics[] = {
  96         "default", "dvialw", "dvilaser", "dvipdf", "dvipdfm", "dvipdfmx",
  97         "dvips", "dvipsone", "dvitops", "dviwin", "dviwindo", "dvi2ps", "emtex",
  98         "ln", "oztex", "pctexhp", "pctexps", "pctexwin", "pctex32", "pdftex",
  99         "psprint", "pubps", "tcidvi", "textures", "truetex", "vtex", "xdvi",
 100         "xetex", "none", ""
 101 };
 102
 103
 104
 105 namespace lyx {
 106
 107 // Local translators
 108 namespace {
 109
 110 // Paragraph separation
 111 typedef Translator<string, BufferParams::ParagraphSeparation> ParSepTranslator;
 112
 113
 114 ParSepTranslator const init_parseptranslator()
 115 {
 116         ParSepTranslator translator
 117                 (string_paragraph_separation[0], BufferParams::ParagraphIndentSeparation);
 118         translator.addPair(string_paragraph_separation[1], BufferParams::ParagraphSkipSeparation);
 119         return translator;
 120 }
 121
 122
 123 ParSepTranslator const & parseptranslator()
 124 {
 125         static ParSepTranslator translator = init_parseptranslator();
 126         return translator;
 127 }
 128
 129
 130 // Quotes language
 131 typedef Translator<string, InsetQuotes::QuoteLanguage> QuotesLangTranslator;
 132
 133
 134 QuotesLangTranslator const init_quoteslangtranslator()
 135 {
 136         QuotesLangTranslator translator
 137                 (string_quotes_language[0], InsetQuotes::EnglishQuotes);
 138         translator.addPair(string_quotes_language[1], InsetQuotes::SwedishQuotes);
 139         translator.addPair(string_quotes_language[2], InsetQuotes::GermanQuotes);
 140         translator.addPair(string_quotes_language[3], InsetQuotes::PolishQuotes);
 141         translator.addPair(string_quotes_language[4], InsetQuotes::FrenchQuotes);
 142         translator.addPair(string_quotes_language[5], InsetQuotes::DanishQuotes);
 143         return translator;
 144 }
 145
 146
 147 QuotesLangTranslator const & quoteslangtranslator()
 148 {
 149         static QuotesLangTranslator translator = init_quoteslangtranslator();
 150         return translator;
 151 }
 152
 153
 154 // Paper size
 155 typedef Translator<string, PAPER_SIZE> PaperSizeTranslator;
 156
 157
 158 static PaperSizeTranslator initPaperSizeTranslator()
 159 {
 160         PaperSizeTranslator translator(string_papersize[0], PAPER_DEFAULT);
 161         translator.addPair(string_papersize[1], PAPER_CUSTOM);
 162         translator.addPair(string_papersize[2], PAPER_USLETTER);
 163         translator.addPair(string_papersize[3], PAPER_USLEGAL);
 164         translator.addPair(string_papersize[4], PAPER_USEXECUTIVE);
 165         translator.addPair(string_papersize[5], PAPER_A0);
 166         translator.addPair(string_papersize[6], PAPER_A1);
 167         translator.addPair(string_papersize[7], PAPER_A2);
 168         translator.addPair(string_papersize[8], PAPER_A3);
 169         translator.addPair(string_papersize[9], PAPER_A4);
 170         translator.addPair(string_papersize[10], PAPER_A5);
 171         translator.addPair(string_papersize[11], PAPER_A6);
 172         translator.addPair(string_papersize[12], PAPER_B0);
 173         translator.addPair(string_papersize[13], PAPER_B1);
 174         translator.addPair(string_papersize[14], PAPER_B2);
 175         translator.addPair(string_papersize[15], PAPER_B3);
 176         translator.addPair(string_papersize[16], PAPER_B4);
 177         translator.addPair(string_papersize[17], PAPER_B5);
 178         translator.addPair(string_papersize[18], PAPER_B6);
 179         translator.addPair(string_papersize[19], PAPER_C0);
 180         translator.addPair(string_papersize[20], PAPER_C1);
 181         translator.addPair(string_papersize[21], PAPER_C2);
 182         translator.addPair(string_papersize[22], PAPER_C3);
 183         translator.addPair(string_papersize[23], PAPER_C4);
 184         translator.addPair(string_papersize[24], PAPER_C5);
 185         translator.addPair(string_papersize[25], PAPER_C6);
 186         translator.addPair(string_papersize[26], PAPER_JISB0);
 187         translator.addPair(string_papersize[27], PAPER_JISB1);
 188         translator.addPair(string_papersize[28], PAPER_JISB2);
 189         translator.addPair(string_papersize[29], PAPER_JISB3);
 190         translator.addPair(string_papersize[30], PAPER_JISB4);
 191         translator.addPair(string_papersize[31], PAPER_JISB5);
 192         translator.addPair(string_papersize[32], PAPER_JISB6);
 193         return translator;
 194 }
 195
 196
 197 PaperSizeTranslator const & papersizetranslator()
 198 {
 199         static PaperSizeTranslator translator = initPaperSizeTranslator();
 200         return translator;
 201 }
 202
 203
 204 // Paper orientation
 205 typedef Translator<string, PAPER_ORIENTATION> PaperOrientationTranslator;
 206
 207
 208 PaperOrientationTranslator const init_paperorientationtranslator()
 209 {
 210         PaperOrientationTranslator translator(string_orientation[0], ORIENTATION_PORTRAIT);
 211         translator.addPair(string_orientation[1], ORIENTATION_LANDSCAPE);
 212         return translator;
 213 }
 214
 215
 216 PaperOrientationTranslator const & paperorientationtranslator()
 217 {
 218         static PaperOrientationTranslator translator = init_paperorientationtranslator();
 219         return translator;
 220 }
 221
 222
 223 // Page sides
 224 typedef Translator<int, PageSides> SidesTranslator;
 225
 226
 227 SidesTranslator const init_sidestranslator()
 228 {
 229         SidesTranslator translator(1, OneSide);
 230         translator.addPair(2, TwoSides);
 231         return translator;
 232 }
 233
 234
 235 SidesTranslator const & sidestranslator()
 236 {
 237         static SidesTranslator translator = init_sidestranslator();
 238         return translator;
 239 }
 240
 241
 242 // LaTeX packages
 243 typedef Translator<int, BufferParams::Package> PackageTranslator;
 244
 245
 246 PackageTranslator const init_packagetranslator()
 247 {
 248         PackageTranslator translator(0, BufferParams::package_off);
 249         translator.addPair(1, BufferParams::package_auto);
 250         translator.addPair(2, BufferParams::package_on);
 251         return translator;
 252 }
 253
 254
 255 PackageTranslator const & packagetranslator()
 256 {
 257         static PackageTranslator translator = init_packagetranslator();
 258         return translator;
 259 }
 260
 261
 262 // Cite engine
 263 typedef Translator<string, CiteEngineType> CiteEngineTypeTranslator;
 264
 265
 266 CiteEngineTypeTranslator const init_citeenginetypetranslator()
 267 {
 268         CiteEngineTypeTranslator translator("authoryear", ENGINE_TYPE_AUTHORYEAR);
 269         translator.addPair("numerical", ENGINE_TYPE_NUMERICAL);
 270         return translator;
 271 }
 272
 273
 274 CiteEngineTypeTranslator const & citeenginetypetranslator()
 275 {
 276         static CiteEngineTypeTranslator translator = init_citeenginetypetranslator();
 277         return translator;
 278 }
 279
 280
 281 // Spacing
 282 typedef Translator<string, Spacing::Space> SpaceTranslator;
 283
 284
 285 SpaceTranslator const init_spacetranslator()
 286 {
 287         SpaceTranslator translator("default", Spacing::Default);
 288         translator.addPair("single", Spacing::Single);
 289         translator.addPair("onehalf", Spacing::Onehalf);
 290         translator.addPair("double", Spacing::Double);
 291         translator.addPair("other", Spacing::Other);
 292         return translator;
 293 }
 294
 295
 296 SpaceTranslator const & spacetranslator()
 297 {
 298         static SpaceTranslator translator = init_spacetranslator();
 299         return translator;
 300 }
 301
 302 } // anon namespace
 303
 304
 305 class BufferParams::Impl
 306 {
 307 public:
 308         Impl();
 309
 310         AuthorList authorlist;
 311         BranchList branchlist;
 312         Bullet temp_bullets[4];
 313         Bullet user_defined_bullets[4];
 314         IndicesList indiceslist;
 315         Spacing spacing;
 316         /** This is the amount of space used for paragraph_separation "skip",
 317          * and for detached paragraphs in "indented" documents.
 318          */
 319         HSpace indentation;
 320         VSpace defskip;
 321         PDFOptions pdfoptions;
 322         LayoutFileIndex baseClass_;
 323 };
 324
 325
 326 BufferParams::Impl::Impl()
 327         : defskip(VSpace::MEDSKIP), baseClass_(string(""))
 328 {
 329         // set initial author
 330         // FIXME UNICODE
 331         authorlist.record(Author(from_utf8(lyxrc.user_name), from_utf8(lyxrc.user_email)));
 332 }
 333
 334
 335 BufferParams::Impl *
 336 BufferParams::MemoryTraits::clone(BufferParams::Impl const * ptr)
 337 {
 338         LASSERT(ptr, /**/);
 339
 340         return new BufferParams::Impl(*ptr);
 341 }
 342
 343
 344 void BufferParams::MemoryTraits::destroy(BufferParams::Impl * ptr)
 345 {
 346         delete ptr;
 347 }
 348
 349
 350 BufferParams::BufferParams()
 351         : pimpl_(new Impl)
 352 {
 353         setBaseClass(defaultBaseclass());
 354         makeDocumentClass();
 355         paragraph_separation = ParagraphIndentSeparation;
 356         quotes_language = InsetQuotes::EnglishQuotes;
 357         fontsize = "default";
 358
 359         /*  PaperLayout */
 360         papersize = PAPER_DEFAULT;
 361         orientation = ORIENTATION_PORTRAIT;
 362         use_geometry = false;
 363         cite_engine_.push_back("basic");
 364         cite_engine_type_ = ENGINE_TYPE_NUMERICAL;
 365         biblio_style = "plain";
 366         use_bibtopic = false;
 367         use_indices = false;
 368         trackChanges = false;
 369         outputChanges = false;
 370         use_default_options = true;
 371         maintain_unincluded_children = false;
 372         secnumdepth = 3;
 373         tocdepth = 3;
 374         language = default_language;
 375         fontenc = "global";
 376         fonts_roman = "default";
 377         fonts_sans = "default";
 378         fonts_typewriter = "default";
 379         fonts_math = "auto";
 380         fonts_default_family = "default";
 381         useNonTeXFonts = false;
 382         fonts_expert_sc = false;
 383         fonts_old_figures = false;
 384         fonts_sans_scale = 100;
 385         fonts_typewriter_scale = 100;
 386         inputenc = "auto";
 387         lang_package = "default";
 388         graphics_driver = "default";
 389         default_output_format = "default";
 390         bibtex_command = "default";
 391         index_command = "default";
 392         sides = OneSide;
 393         columns = 1;
 394         listings_params = string();
 395         pagestyle = "default";
 396         suppress_date = false;
 397         justification = true;
 398         // no color is the default (white)
 399         backgroundcolor = lyx::rgbFromHexName("#ffffff");
 400         isbackgroundcolor = false;
 401         // no color is the default (black)
 402         fontcolor = lyx::rgbFromHexName("#000000");
 403         isfontcolor = false;
 404         // light gray is the default font color for greyed-out notes
 405         notefontcolor = lyx::rgbFromHexName("#cccccc");
 406         boxbgcolor = lyx::rgbFromHexName("#ff0000");
 407         compressed = lyxrc.save_compressed;
 408         for (int iter = 0; iter < 4; ++iter) {
 409                 user_defined_bullet(iter) = ITEMIZE_DEFAULTS[iter];
 410                 temp_bullet(iter) = ITEMIZE_DEFAULTS[iter];
 411         }
 412         // default index
 413         indiceslist().addDefault(B_("Index"));
 414         html_be_strict = false;
 415         html_math_output = MathML;
 416         html_math_img_scale = 1.0;
 417         html_css_as_file = false;
 418
 419         output_sync = false;
 420         use_refstyle = true;
 421 }
 422
 423
 424 docstring BufferParams::B_(string const & l10n) const
 425 {
 426         LASSERT(language, /**/);
 427         return getMessages(language->code()).get(l10n);
 428 }
 429
 430
 431 BufferParams::Package BufferParams::use_package(std::string const & p) const
 432 {
 433         PackageMap::const_iterator it = use_packages.find(p);
 434         if (it == use_packages.end())
 435                 return package_auto;
 436         return it->second;
 437 }
 438
 439
 440 void BufferParams::use_package(std::string const & p, BufferParams::Package u)
 441 {
 442         use_packages[p] = u;
 443 }
 444
 445
 446 vector<string> const & BufferParams::auto_packages()
 447 {
 448         static vector<string> packages;
 449         if (packages.empty()) {
 450                 // adding a package here implies a file format change!
 451                 packages.push_back("amsmath");
 452                 packages.push_back("amssymb");
 453                 packages.push_back("esint");
 454                 packages.push_back("mathdots");
 455                 packages.push_back("mathtools");
 456                 packages.push_back("mhchem");
 457                 packages.push_back("undertilde");
 458         }
 459         return packages;
 460 }
 461
 462
 463 AuthorList & BufferParams::authors()
 464 {
 465         return pimpl_->authorlist;
 466 }
 467
 468
 469 AuthorList const & BufferParams::authors() const
 470 {
 471         return pimpl_->authorlist;
 472 }
 473
 474
 475 BranchList & BufferParams::branchlist()
 476 {
 477         return pimpl_->branchlist;
 478 }
 479
 480
 481 BranchList const & BufferParams::branchlist() const
 482 {
 483         return pimpl_->branchlist;
 484 }
 485
 486
 487 IndicesList & BufferParams::indiceslist()
 488 {
 489         return pimpl_->indiceslist;
 490 }
 491
 492
 493 IndicesList const & BufferParams::indiceslist() const
 494 {
 495         return pimpl_->indiceslist;
 496 }
 497
 498
 499 Bullet & BufferParams::temp_bullet(lyx::size_type const index)
 500 {
 501         LASSERT(index < 4, /**/);
 502         return pimpl_->temp_bullets[index];
 503 }
 504
 505
 506 Bullet const & BufferParams::temp_bullet(lyx::size_type const index) const
 507 {
 508         LASSERT(index < 4, /**/);
 509         return pimpl_->temp_bullets[index];
 510 }
 511
 512
 513 Bullet & BufferParams::user_defined_bullet(lyx::size_type const index)
 514 {
 515         LASSERT(index < 4, /**/);
 516         return pimpl_->user_defined_bullets[index];
 517 }
 518
 519
 520 Bullet const & BufferParams::user_defined_bullet(lyx::size_type const index) const
 521 {
 522         LASSERT(index < 4, /**/);
 523         return pimpl_->user_defined_bullets[index];
 524 }
 525
 526
 527 Spacing & BufferParams::spacing()
 528 {
 529         return pimpl_->spacing;
 530 }
 531
 532
 533 Spacing const & BufferParams::spacing() const
 534 {
 535         return pimpl_->spacing;
 536 }
 537
 538
 539 PDFOptions & BufferParams::pdfoptions()
 540 {
 541         return pimpl_->pdfoptions;
 542 }
 543
 544
 545 PDFOptions const & BufferParams::pdfoptions() const
 546 {
 547         return pimpl_->pdfoptions;
 548 }
 549
 550
 551 HSpace const & BufferParams::getIndentation() const
 552 {
 553         return pimpl_->indentation;
 554 }
 555
 556
 557 void BufferParams::setIndentation(HSpace const & indent)
 558 {
 559         pimpl_->indentation = indent;
 560 }
 561
 562
 563 VSpace const & BufferParams::getDefSkip() const
 564 {
 565         return pimpl_->defskip;
 566 }
 567
 568
 569 void BufferParams::setDefSkip(VSpace const & vs)
 570 {
 571         // DEFSKIP will cause an infinite loop
 572         LASSERT(vs.kind() != VSpace::DEFSKIP, return);
 573         pimpl_->defskip = vs;
 574 }
 575
 576
 577 string BufferParams::readToken(Lexer & lex, string const & token,
 578         FileName const & filepath)
 579 {
 580         if (token == "\\textclass") {
 581                 lex.next();
 582                 string const classname = lex.getString();
 583                 // if there exists a local layout file, ignore the system one
 584                 // NOTE: in this case, the textclass (.cls file) is assumed to
 585                 // be available.
 586                 string tcp;
 587                 LayoutFileList & bcl = LayoutFileList::get();
 588                 if (tcp.empty() && !filepath.empty())
 589                         tcp = bcl.addLocalLayout(classname, filepath.absFileName());
 590                 if (!tcp.empty())
 591                         setBaseClass(tcp);
 592                 else
 593                         setBaseClass(classname);
 594                 // We assume that a tex class exists for local or unknown
 595                 // layouts so this warning, will only be given for system layouts.
 596                 if (!baseClass()->isTeXClassAvailable()) {
 597                         docstring const desc =
 598                                 translateIfPossible(from_utf8(baseClass()->description()));
 599                         docstring const prereqs =
 600                                 from_utf8(baseClass()->prerequisites());
 601                         docstring const msg =
 602                                 bformat(_("The selected document class\n"
 603                                                  "\t%1$s\n"
 604                                                  "requires external files that are not available.\n"
 605                                                  "The document class can still be used, but the\n"
 606                                                  "document cannot be compiled until the following\n"
 607                                                  "prerequisites are installed:\n"
 608                                                  "\t%2$s\n"
 609                                                  "See section 3.1.2.2 (Class Availability) of the\n"
 610                                                  "User's Guide for more information."), desc, prereqs);
 611                         frontend::Alert::warning(_("Document class not available"),
 612                                        msg);
 613                 }
 614         } else if (token == "\\begin_preamble") {
 615                 readPreamble(lex);
 616         } else if (token == "\\begin_local_layout") {
 617                 readLocalLayout(lex);
 618         } else if (token == "\\begin_modules") {
 619                 readModules(lex);
 620         } else if (token == "\\begin_removed_modules") {
 621                 readRemovedModules(lex);
 622         } else if (token == "\\begin_includeonly") {
 623                 readIncludeonly(lex);
 624         } else if (token == "\\maintain_unincluded_children") {
 625                 lex >> maintain_unincluded_children;
 626         } else if (token == "\\options") {
 627                 lex.eatLine();
 628                 options = lex.getString();
 629         } else if (token == "\\use_default_options") {
 630                 lex >> use_default_options;
 631         } else if (token == "\\master") {
 632                 lex.eatLine();
 633                 master = lex.getString();
 634         } else if (token == "\\suppress_date") {
 635                 lex >> suppress_date;
 636         } else if (token == "\\justification") {
 637                 lex >> justification;
 638         } else if (token == "\\language") {
 639                 readLanguage(lex);
 640         } else if (token == "\\language_package") {
 641                 lex.eatLine();
 642                 lang_package = lex.getString();
 643         } else if (token == "\\inputencoding") {
 644                 lex >> inputenc;
 645         } else if (token == "\\graphics") {
 646                 readGraphicsDriver(lex);
 647         } else if (token == "\\default_output_format") {
 648                 lex >> default_output_format;
 649         } else if (token == "\\bibtex_command") {
 650                 lex.eatLine();
 651                 bibtex_command = lex.getString();
 652         } else if (token == "\\index_command") {
 653                 lex.eatLine();
 654                 index_command = lex.getString();
 655         } else if (token == "\\fontencoding") {
 656                 lex.eatLine();
 657                 fontenc = lex.getString();
 658         } else if (token == "\\font_roman") {
 659                 lex.eatLine();
 660                 fonts_roman = lex.getString();
 661         } else if (token == "\\font_sans") {
 662                 lex.eatLine();
 663                 fonts_sans = lex.getString();
 664         } else if (token == "\\font_typewriter") {
 665                 lex.eatLine();
 666                 fonts_typewriter = lex.getString();
 667         } else if (token == "\\font_math") {
 668                 lex.eatLine();
 669                 fonts_math = lex.getString();
 670         } else if (token == "\\font_default_family") {
 671                 lex >> fonts_default_family;
 672         } else if (token == "\\use_non_tex_fonts") {
 673                 lex >> useNonTeXFonts;
 674         } else if (token == "\\font_sc") {
 675                 lex >> fonts_expert_sc;
 676         } else if (token == "\\font_osf") {
 677                 lex >> fonts_old_figures;
 678         } else if (token == "\\font_sf_scale") {
 679                 lex >> fonts_sans_scale;
 680         } else if (token == "\\font_tt_scale") {
 681                 lex >> fonts_typewriter_scale;
 682         } else if (token == "\\font_cjk") {
 683                 lex >> fonts_cjk;
 684         } else if (token == "\\paragraph_separation") {
 685                 string parsep;
 686                 lex >> parsep;
 687                 paragraph_separation = parseptranslator().find(parsep);
 688         } else if (token == "\\paragraph_indentation") {
 689                 lex.next();
 690                 string indentation = lex.getString();
 691                 pimpl_->indentation = HSpace(indentation);
 692         } else if (token == "\\defskip") {
 693                 lex.next();
 694                 string const defskip = lex.getString();
 695                 pimpl_->defskip = VSpace(defskip);
 696                 if (pimpl_->defskip.kind() == VSpace::DEFSKIP)
 697                         // that is invalid
 698                         pimpl_->defskip = VSpace(VSpace::MEDSKIP);
 699         } else if (token == "\\quotes_language") {
 700                 string quotes_lang;
 701                 lex >> quotes_lang;
 702                 quotes_language = quoteslangtranslator().find(quotes_lang);
 703         } else if (token == "\\papersize") {
 704                 string ppsize;
 705                 lex >> ppsize;
 706                 papersize = papersizetranslator().find(ppsize);
 707         } else if (token == "\\use_geometry") {
 708                 lex >> use_geometry;
 709         } else if (token == "\\use_package") {
 710                 string package;
 711                 int use;
 712                 lex >> package;
 713                 lex >> use;
 714                 use_package(package, packagetranslator().find(use));
 715         } else if (token == "\\cite_engine") {
 716                 lex.eatLine();
 717                 vector<string> engine = getVectorFromString(lex.getString());
 718                 setCiteEngine(engine);
 719         } else if (token == "\\cite_engine_type") {
 720                 string engine_type;
 721                 lex >> engine_type;
 722                 cite_engine_type_ = citeenginetypetranslator().find(engine_type);
 723         } else if (token == "\\biblio_style") {
 724                 lex.eatLine();
 725                 biblio_style = lex.getString();
 726         } else if (token == "\\use_bibtopic") {
 727                 lex >> use_bibtopic;
 728         } else if (token == "\\use_indices") {
 729                 lex >> use_indices;
 730         } else if (token == "\\tracking_changes") {
 731                 lex >> trackChanges;
 732         } else if (token == "\\output_changes") {
 733                 lex >> outputChanges;
 734         } else if (token == "\\branch") {
 735                 lex.eatLine();
 736                 docstring branch = lex.getDocString();
 737                 branchlist().add(branch);
 738                 while (true) {
 739                         lex.next();
 740                         string const tok = lex.getString();
 741                         if (tok == "\\end_branch")
 742                                 break;
 743                         Branch * branch_ptr = branchlist().find(branch);
 744                         if (tok == "\\selected") {
 745                                 lex.next();
 746                                 if (branch_ptr)
 747                                         branch_ptr->setSelected(lex.getInteger());
 748                         }
 749                         if (tok == "\\filename_suffix") {
 750                                 lex.next();
 751                                 if (branch_ptr)
 752                                         branch_ptr->setFileNameSuffix(lex.getInteger());
 753                         }
 754                         if (tok == "\\color") {
 755                                 lex.eatLine();
 756                                 string color = lex.getString();
 757                                 if (branch_ptr)
 758                                         branch_ptr->setColor(color);
 759                                 // Update also the Color table:
 760                                 if (color == "none")
 761                                         color = lcolor.getX11Name(Color_background);
 762                                 // FIXME UNICODE
 763                                 lcolor.setColor(to_utf8(branch), color);
 764                         }
 765                 }
 766         } else if (token == "\\index") {
 767                 lex.eatLine();
 768                 docstring index = lex.getDocString();
 769                 docstring shortcut;
 770                 indiceslist().add(index);
 771                 while (true) {
 772                         lex.next();
 773                         string const tok = lex.getString();
 774                         if (tok == "\\end_index")
 775                                 break;
 776                         Index * index_ptr = indiceslist().find(index);
 777                         if (tok == "\\shortcut") {
 778                                 lex.next();
 779                                 shortcut = lex.getDocString();
 780                                 if (index_ptr)
 781                                         index_ptr->setShortcut(shortcut);
 782                         }
 783                         if (tok == "\\color") {
 784                                 lex.eatLine();
 785                                 string color = lex.getString();
 786                                 if (index_ptr)
 787                                         index_ptr->setColor(color);
 788                                 // Update also the Color table:
 789                                 if (color == "none")
 790                                         color = lcolor.getX11Name(Color_background);
 791                                 // FIXME UNICODE
 792                                 if (!shortcut.empty())
 793                                         lcolor.setColor(to_utf8(shortcut), color);
 794                         }
 795                 }
 796         } else if (token == "\\author") {
 797                 lex.eatLine();
 798                 istringstream ss(lex.getString());
 799                 Author a;
 800                 ss >> a;
 801                 author_map[a.bufferId()] = pimpl_->authorlist.record(a);
 802         } else if (token == "\\paperorientation") {
 803                 string orient;
 804                 lex >> orient;
 805                 orientation = paperorientationtranslator().find(orient);
 806         } else if (token == "\\backgroundcolor") {
 807                 lex.eatLine();
 808                 backgroundcolor = lyx::rgbFromHexName(lex.getString());
 809                 isbackgroundcolor = true;
 810         } else if (token == "\\fontcolor") {
 811                 lex.eatLine();
 812                 fontcolor = lyx::rgbFromHexName(lex.getString());
 813                 isfontcolor = true;
 814         } else if (token == "\\notefontcolor") {
 815                 lex.eatLine();
 816                 string color = lex.getString();
 817                 notefontcolor = lyx::rgbFromHexName(color);
 818         } else if (token == "\\boxbgcolor") {
 819                 lex.eatLine();
 820                 string color = lex.getString();
 821                 boxbgcolor = lyx::rgbFromHexName(color);
 822         } else if (token == "\\paperwidth") {
 823                 lex >> paperwidth;
 824         } else if (token == "\\paperheight") {
 825                 lex >> paperheight;
 826         } else if (token == "\\leftmargin") {
 827                 lex >> leftmargin;
 828         } else if (token == "\\topmargin") {
 829                 lex >> topmargin;
 830         } else if (token == "\\rightmargin") {
 831                 lex >> rightmargin;
 832         } else if (token == "\\bottommargin") {
 833                 lex >> bottommargin;
 834         } else if (token == "\\headheight") {
 835                 lex >> headheight;
 836         } else if (token == "\\headsep") {
 837                 lex >> headsep;
 838         } else if (token == "\\footskip") {
 839                 lex >> footskip;
 840         } else if (token == "\\columnsep") {
 841                 lex >> columnsep;
 842         } else if (token == "\\paperfontsize") {
 843                 lex >> fontsize;
 844         } else if (token == "\\papercolumns") {
 845                 lex >> columns;
 846         } else if (token == "\\listings_params") {
 847                 string par;
 848                 lex >> par;
 849                 listings_params = InsetListingsParams(par).params();
 850         } else if (token == "\\papersides") {
 851                 int psides;
 852                 lex >> psides;
 853                 sides = sidestranslator().find(psides);
 854         } else if (token == "\\paperpagestyle") {
 855                 lex >> pagestyle;
 856         } else if (token == "\\bullet") {
 857                 readBullets(lex);
 858         } else if (token == "\\bulletLaTeX") {
 859                 readBulletsLaTeX(lex);
 860         } else if (token == "\\secnumdepth") {
 861                 lex >> secnumdepth;
 862         } else if (token == "\\tocdepth") {
 863                 lex >> tocdepth;
 864         } else if (token == "\\spacing") {
 865                 string nspacing;
 866                 lex >> nspacing;
 867                 string tmp_val;
 868                 if (nspacing == "other") {
 869                         lex >> tmp_val;
 870                 }
 871                 spacing().set(spacetranslator().find(nspacing), tmp_val);
 872         } else if (token == "\\float_placement") {
 873                 lex >> float_placement;
 874
 875         } else if (prefixIs(token, "\\pdf_") || token == "\\use_hyperref") {
 876                 string toktmp = pdfoptions().readToken(lex, token);
 877                 if (!toktmp.empty()) {
 878                         lyxerr << "PDFOptions::readToken(): Unknown token: " <<
 879                                 toktmp << endl;
 880                         return toktmp;
 881                 }
 882         } else if (token == "\\html_math_output") {
 883                 int temp;
 884                 lex >> temp;
 885                 html_math_output = static_cast<MathOutput>(temp);
 886         } else if (token == "\\html_be_strict") {
 887                 lex >> html_be_strict;
 888         } else if (token == "\\html_css_as_file") {
 889                 lex >> html_css_as_file;
 890         } else if (token == "\\html_math_img_scale") {
 891                 lex >> html_math_img_scale;
 892         } else if (token == "\\html_latex_start") {
 893                 lex.eatLine();
 894                 html_latex_start = lex.getString();
 895         } else if (token == "\\html_latex_end") {
 896                 lex.eatLine();
 897                 html_latex_end = lex.getString();
 898         } else if (token == "\\output_sync") {
 899                 lex >> output_sync;
 900         } else if (token == "\\output_sync_macro") {
 901                 lex >> output_sync_macro;
 902         } else if (token == "\\use_refstyle") {
 903                 lex >> use_refstyle;
 904         } else {
 905                 lyxerr << "BufferParams::readToken(): Unknown token: " <<
 906                         token << endl;
 907                 return token;
 908         }
 909
 910         return string();
 911 }
 912
 913
 914 void BufferParams::writeFile(ostream & os) const
 915 {
 916         // The top of the file is written by the buffer.
 917         // Prints out the buffer info into the .lyx file given by file
 918
 919         // the textclass
 920         os << "\\textclass " << baseClass()->name() << '\n';
 921
 922         // then the preamble
 923         if (!preamble.empty()) {
 924                 // remove '\n' from the end of preamble
 925                 string const tmppreamble = rtrim(preamble, "\n");
 926                 os << "\\begin_preamble\n"
 927                    << tmppreamble
 928                    << "\n\\end_preamble\n";
 929         }
 930
 931         // the options
 932         if (!options.empty()) {
 933                 os << "\\options " << options << '\n';
 934         }
 935
 936         // use the class options defined in the layout?
 937         os << "\\use_default_options "
 938            << convert<string>(use_default_options) << "\n";
 939
 940         // the master document
 941         if (!master.empty()) {
 942                 os << "\\master " << master << '\n';
 943         }
 944
 945         // removed modules
 946         if (!removed_modules_.empty()) {
 947                 os << "\\begin_removed_modules" << '\n';
 948                 list<string>::const_iterator it = removed_modules_.begin();
 949                 list<string>::const_iterator en = removed_modules_.end();
 950                 for (; it != en; ++it)
 951                         os << *it << '\n';
 952                 os << "\\end_removed_modules" << '\n';
 953         }
 954
 955         // the modules
 956         if (!layout_modules_.empty()) {
 957                 os << "\\begin_modules" << '\n';
 958                 LayoutModuleList::const_iterator it = layout_modules_.begin();
 959                 LayoutModuleList::const_iterator en = layout_modules_.end();
 960                 for (; it != en; ++it)
 961                         os << *it << '\n';
 962                 os << "\\end_modules" << '\n';
 963         }
 964
 965         // includeonly
 966         if (!included_children_.empty()) {
 967                 os << "\\begin_includeonly" << '\n';
 968                 list<string>::const_iterator it = included_children_.begin();
 969                 list<string>::const_iterator en = included_children_.end();
 970                 for (; it != en; ++it)
 971                         os << *it << '\n';
 972                 os << "\\end_includeonly" << '\n';
 973         }
 974         os << "\\maintain_unincluded_children "
 975            << convert<string>(maintain_unincluded_children) << '\n';
 976
 977         // local layout information
 978         if (!local_layout.empty()) {
 979                 // remove '\n' from the end
 980                 string const tmplocal = rtrim(local_layout, "\n");
 981                 os << "\\begin_local_layout\n"
 982                    << tmplocal
 983                    << "\n\\end_local_layout\n";
 984         }
 985
 986         // then the text parameters
 987         if (language != ignore_language)
 988                 os << "\\language " << language->lang() << '\n';
 989         os << "\\language_package " << lang_package
 990            << "\n\\inputencoding " << inputenc
 991            << "\n\\fontencoding " << fontenc
 992            << "\n\\font_roman " << fonts_roman
 993            << "\n\\font_sans " << fonts_sans
 994            << "\n\\font_typewriter " << fonts_typewriter
 995            << "\n\\font_math " << fonts_math
 996            << "\n\\font_default_family " << fonts_default_family
 997            << "\n\\use_non_tex_fonts " << convert<string>(useNonTeXFonts)
 998            << "\n\\font_sc " << convert<string>(fonts_expert_sc)
 999            << "\n\\font_osf " << convert<string>(fonts_old_figures)
1000            << "\n\\font_sf_scale " << fonts_sans_scale
1001            << "\n\\font_tt_scale " << fonts_typewriter_scale
1002            << '\n';
1003         if (!fonts_cjk.empty()) {
1004                 os << "\\font_cjk " << fonts_cjk << '\n';
1005         }
1006         os << "\\graphics " << graphics_driver << '\n';
1007         os << "\\default_output_format " << default_output_format << '\n';
1008         os << "\\output_sync " << output_sync << '\n';
1009         if (!output_sync_macro.empty())
1010                 os << "\\output_sync_macro \"" << output_sync_macro << "\"\n";
1011         os << "\\bibtex_command " << bibtex_command << '\n';
1012         os << "\\index_command " << index_command << '\n';
1013
1014         if (!float_placement.empty()) {
1015                 os << "\\float_placement " << float_placement << '\n';
1016         }
1017         os << "\\paperfontsize " << fontsize << '\n';
1018
1019         spacing().writeFile(os);
1020         pdfoptions().writeFile(os);
1021
1022         os << "\\papersize " << string_papersize[papersize]
1023            << "\n\\use_geometry " << convert<string>(use_geometry);
1024         vector<string> const & packages = auto_packages();
1025         for (size_t i = 0; i < packages.size(); ++i)
1026                 os << "\n\\use_package " << packages[i] << ' '
1027                    << use_package(packages[i]);
1028
1029         os << "\n\\cite_engine ";
1030
1031         if (!cite_engine_.empty()) {
1032                 LayoutModuleList::const_iterator be = cite_engine_.begin();
1033                 LayoutModuleList::const_iterator en = cite_engine_.end();
1034                 for (LayoutModuleList::const_iterator it = be; it != en; ++it) {
1035                         if (it != be)
1036                                 os << ',';
1037                         os << *it;
1038                 }
1039         } else {
1040                 os << "basic";
1041         }
1042
1043         os << "\n\\cite_engine_type " << citeenginetypetranslator().find(cite_engine_type_)
1044            << "\n\\biblio_style " << biblio_style
1045            << "\n\\use_bibtopic " << convert<string>(use_bibtopic)
1046            << "\n\\use_indices " << convert<string>(use_indices)
1047            << "\n\\paperorientation " << string_orientation[orientation]
1048            << "\n\\suppress_date " << convert<string>(suppress_date)
1049            << "\n\\justification " << convert<string>(justification)
1050            << "\n\\use_refstyle " << use_refstyle
1051            << '\n';
1052         if (isbackgroundcolor == true)
1053                 os << "\\backgroundcolor " << lyx::X11hexname(backgroundcolor) << '\n';
1054         if (isfontcolor == true)
1055                 os << "\\fontcolor " << lyx::X11hexname(fontcolor) << '\n';
1056         if (notefontcolor != lyx::rgbFromHexName("#cccccc"))
1057                 os << "\\notefontcolor " << lyx::X11hexname(notefontcolor) << '\n';
1058         if (boxbgcolor != lyx::rgbFromHexName("#ff0000"))
1059                 os << "\\boxbgcolor " << lyx::X11hexname(boxbgcolor) << '\n';
1060
1061         BranchList::const_iterator it = branchlist().begin();
1062         BranchList::const_iterator end = branchlist().end();
1063         for (; it != end; ++it) {
1064                 os << "\\branch " << to_utf8(it->branch())
1065                    << "\n\\selected " << it->isSelected()
1066                    << "\n\\filename_suffix " << it->hasFileNameSuffix()
1067                    << "\n\\color " << lyx::X11hexname(it->color())
1068                    << "\n\\end_branch"
1069                    << "\n";
1070         }
1071
1072         IndicesList::const_iterator iit = indiceslist().begin();
1073         IndicesList::const_iterator iend = indiceslist().end();
1074         for (; iit != iend; ++iit) {
1075                 os << "\\index " << to_utf8(iit->index())
1076                    << "\n\\shortcut " << to_utf8(iit->shortcut())
1077                    << "\n\\color " << lyx::X11hexname(iit->color())
1078                    << "\n\\end_index"
1079                    << "\n";
1080         }
1081
1082         if (!paperwidth.empty())
1083                 os << "\\paperwidth "
1084                    << VSpace(paperwidth).asLyXCommand() << '\n';
1085         if (!paperheight.empty())
1086                 os << "\\paperheight "
1087                    << VSpace(paperheight).asLyXCommand() << '\n';
1088         if (!leftmargin.empty())
1089                 os << "\\leftmargin "
1090                    << VSpace(leftmargin).asLyXCommand() << '\n';
1091         if (!topmargin.empty())
1092                 os << "\\topmargin "
1093                    << VSpace(topmargin).asLyXCommand() << '\n';
1094         if (!rightmargin.empty())
1095                 os << "\\rightmargin "
1096                    << VSpace(rightmargin).asLyXCommand() << '\n';
1097         if (!bottommargin.empty())
1098                 os << "\\bottommargin "
1099                    << VSpace(bottommargin).asLyXCommand() << '\n';
1100         if (!headheight.empty())
1101                 os << "\\headheight "
1102                    << VSpace(headheight).asLyXCommand() << '\n';
1103         if (!headsep.empty())
1104                 os << "\\headsep "
1105                    << VSpace(headsep).asLyXCommand() << '\n';
1106         if (!footskip.empty())
1107                 os << "\\footskip "
1108                    << VSpace(footskip).asLyXCommand() << '\n';
1109         if (!columnsep.empty())
1110                 os << "\\columnsep "
1111                          << VSpace(columnsep).asLyXCommand() << '\n';
1112         os << "\\secnumdepth " << secnumdepth
1113            << "\n\\tocdepth " << tocdepth
1114            << "\n\\paragraph_separation "
1115            << string_paragraph_separation[paragraph_separation];
1116         if (!paragraph_separation)
1117                 os << "\n\\paragraph_indentation " << getIndentation().asLyXCommand();
1118         else
1119                 os << "\n\\defskip " << getDefSkip().asLyXCommand();
1120         os << "\n\\quotes_language "
1121            << string_quotes_language[quotes_language]
1122            << "\n\\papercolumns " << columns
1123            << "\n\\papersides " << sides
1124            << "\n\\paperpagestyle " << pagestyle << '\n';
1125         if (!listings_params.empty())
1126                 os << "\\listings_params \"" <<
1127                         InsetListingsParams(listings_params).encodedString() << "\"\n";
1128         for (int i = 0; i < 4; ++i) {
1129                 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1130                         if (user_defined_bullet(i).getFont() != -1) {
1131                                 os << "\\bullet " << i << " "
1132                                    << user_defined_bullet(i).getFont() << " "
1133                                    << user_defined_bullet(i).getCharacter() << " "
1134                                    << user_defined_bullet(i).getSize() << "\n";
1135                         }
1136                         else {
1137                                 // FIXME UNICODE
1138                                 os << "\\bulletLaTeX " << i << " \""
1139                                    << lyx::to_ascii(user_defined_bullet(i).getText())
1140                                    << "\"\n";
1141                         }
1142                 }
1143         }
1144
1145         os << "\\tracking_changes " << convert<string>(trackChanges) << '\n'
1146            << "\\output_changes " << convert<string>(outputChanges) << '\n'
1147            << "\\html_math_output " << html_math_output << '\n'
1148            << "\\html_css_as_file " << html_css_as_file << '\n'
1149            << "\\html_be_strict " << convert<string>(html_be_strict) << '\n';
1150
1151         if (html_math_img_scale != 1.0)
1152                 os << "\\html_math_img_scale " << convert<string>(html_math_img_scale) << '\n';
1153         if (!html_latex_start.empty())
1154                 os << "\\html_latex_start " << html_latex_start << '\n';
1155         if (!html_latex_end.empty())
1156                  os << "\\html_latex_end " << html_latex_end << '\n';
1157
1158         os << pimpl_->authorlist;
1159 }
1160
1161
1162 void BufferParams::validate(LaTeXFeatures & features) const
1163 {
1164         features.require(documentClass().requires());
1165
1166         if (columns > 1 && language->rightToLeft())
1167                 features.require("rtloutputdblcol");
1168
1169         if (outputChanges) {
1170                 bool dvipost    = LaTeXFeatures::isAvailable("dvipost");
1171                 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1172                                   LaTeXFeatures::isAvailable("xcolor");
1173
1174                 switch (features.runparams().flavor) {
1175                 case OutputParams::LATEX:
1176                 case OutputParams::DVILUATEX:
1177                         if (dvipost) {
1178                                 features.require("ct-dvipost");
1179                                 features.require("dvipost");
1180                         } else if (xcolorulem) {
1181                                 features.require("ct-xcolor-ulem");
1182                                 features.require("ulem");
1183                                 features.require("xcolor");
1184                         } else {
1185                                 features.require("ct-none");
1186                         }
1187                         break;
1188                 case OutputParams::LUATEX:
1189                 case OutputParams::PDFLATEX:
1190                 case OutputParams::XETEX:
1191                         if (xcolorulem) {
1192                                 features.require("ct-xcolor-ulem");
1193                                 features.require("ulem");
1194                                 features.require("xcolor");
1195                                 // improves color handling in PDF output
1196                                 features.require("pdfcolmk");
1197                         } else {
1198                                 features.require("ct-none");
1199                         }
1200                         break;
1201                 default:
1202                         break;
1203                 }
1204         }
1205
1206         // Floats with 'Here definitely' as default setting.
1207         if (float_placement.find('H') != string::npos)
1208                 features.require("float");
1209
1210         for (PackageMap::const_iterator it = use_packages.begin();
1211              it != use_packages.end(); ++it) {
1212                 if (it->first == "amsmath") {
1213                         // AMS Style is at document level
1214                         if (it->second == package_on ||
1215                             features.isProvided("amsmath"))
1216                                 features.require(it->first);
1217                 } else if (it->second == package_on)
1218                         features.require(it->first);
1219         }
1220
1221         // Document-level line spacing
1222         if (spacing().getSpace() != Spacing::Single && !spacing().isDefault())
1223                 features.require("setspace");
1224
1225         // the bullet shapes are buffer level not paragraph level
1226         // so they are tested here
1227         for (int i = 0; i < 4; ++i) {
1228                 if (user_defined_bullet(i) == ITEMIZE_DEFAULTS[i])
1229                         continue;
1230                 int const font = user_defined_bullet(i).getFont();
1231                 if (font == 0) {
1232                         int const c = user_defined_bullet(i).getCharacter();
1233                         if (c == 16
1234                             || c == 17
1235                             || c == 25
1236                             || c == 26
1237                             || c == 31) {
1238                                 features.require("latexsym");
1239                         }
1240                 } else if (font == 1) {
1241                         features.require("amssymb");
1242                 } else if (font >= 2 && font <= 5) {
1243                         features.require("pifont");
1244                 }
1245         }
1246
1247         if (pdfoptions().use_hyperref) {
1248                 features.require("hyperref");
1249                 // due to interferences with babel and hyperref, the color package has to
1250                 // be loaded after hyperref when hyperref is used with the colorlinks
1251                 // option, see http://www.lyx.org/trac/ticket/5291
1252                 if (pdfoptions().colorlinks)
1253                         features.require("color");
1254         }
1255
1256         // some languages are only available via polyglossia
1257         if (features.runparams().flavor == OutputParams::XETEX
1258             && (features.hasPolyglossiaExclusiveLanguages()
1259                 || useNonTeXFonts))
1260                 features.require("polyglossia");
1261
1262         if (useNonTeXFonts && fonts_math != "auto")
1263                 features.require("unicode-math");
1264
1265         if (!language->requires().empty())
1266                 features.require(language->requires());
1267 }
1268
1269
1270 bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
1271                               FileName const & filepath) const
1272 {
1273         // http://www.tug.org/texmf-dist/doc/latex/base/fixltx2e.pdf
1274         // !! To use the Fix-cm package, load it before \documentclass, and use the command
1275         // \RequirePackage to do so, rather than the normal \usepackage
1276         // Do not try to load any other package before the document class, unless you
1277         // have a thorough understanding of the LATEX internals and know exactly what you
1278         // are doing!
1279         if (features.mustProvide("fix-cm"))
1280                 os << "\\RequirePackage{fix-cm}\n";
1281
1282         os << "\\documentclass";
1283
1284         DocumentClass const & tclass = documentClass();
1285
1286         ostringstream clsoptions; // the document class options.
1287
1288         if (tokenPos(tclass.opt_fontsize(),
1289                      '|', fontsize) >= 0) {
1290                 // only write if existing in list (and not default)
1291                 clsoptions << fontsize << "pt,";
1292         }
1293
1294         // all paper sizes except of A4, A5, B5 and the US sizes need the
1295         // geometry package
1296         bool nonstandard_papersize = papersize != PAPER_DEFAULT
1297                 && papersize != PAPER_USLETTER
1298                 && papersize != PAPER_USLEGAL
1299                 && papersize != PAPER_USEXECUTIVE
1300                 && papersize != PAPER_A4
1301                 && papersize != PAPER_A5
1302                 && papersize != PAPER_B5;
1303
1304         if (!use_geometry) {
1305                 switch (papersize) {
1306                 case PAPER_A4:
1307                         clsoptions << "a4paper,";
1308                         break;
1309                 case PAPER_USLETTER:
1310                         clsoptions << "letterpaper,";
1311                         break;
1312                 case PAPER_A5:
1313                         clsoptions << "a5paper,";
1314                         break;
1315                 case PAPER_B5:
1316                         clsoptions << "b5paper,";
1317                         break;
1318                 case PAPER_USEXECUTIVE:
1319                         clsoptions << "executivepaper,";
1320                         break;
1321                 case PAPER_USLEGAL:
1322                         clsoptions << "legalpaper,";
1323                         break;
1324                 case PAPER_DEFAULT:
1325                 case PAPER_A0:
1326                 case PAPER_A1:
1327                 case PAPER_A2:
1328                 case PAPER_A3:
1329                 case PAPER_A6:
1330                 case PAPER_B0:
1331                 case PAPER_B1:
1332                 case PAPER_B2:
1333                 case PAPER_B3:
1334                 case PAPER_B4:
1335                 case PAPER_B6:
1336                 case PAPER_C0:
1337                 case PAPER_C1:
1338                 case PAPER_C2:
1339                 case PAPER_C3:
1340                 case PAPER_C4:
1341                 case PAPER_C5:
1342                 case PAPER_C6:
1343                 case PAPER_JISB0:
1344                 case PAPER_JISB1:
1345                 case PAPER_JISB2:
1346                 case PAPER_JISB3:
1347                 case PAPER_JISB4:
1348                 case PAPER_JISB5:
1349                 case PAPER_JISB6:
1350                 case PAPER_CUSTOM:
1351                         break;
1352                 }
1353         }
1354
1355         // if needed
1356         if (sides != tclass.sides()) {
1357                 switch (sides) {
1358                 case OneSide:
1359                         clsoptions << "oneside,";
1360                         break;
1361                 case TwoSides:
1362                         clsoptions << "twoside,";
1363                         break;
1364                 }
1365         }
1366
1367         // if needed
1368         if (columns != tclass.columns()) {
1369                 if (columns == 2)
1370                         clsoptions << "twocolumn,";
1371                 else
1372                         clsoptions << "onecolumn,";
1373         }
1374
1375         if (!use_geometry
1376             && orientation == ORIENTATION_LANDSCAPE)
1377                 clsoptions << "landscape,";
1378
1379         // language should be a parameter to \documentclass
1380         if (language->babel() == "hebrew"
1381             && default_language->babel() != "hebrew")
1382                 // This seems necessary
1383                 features.useLanguage(default_language);
1384
1385         ostringstream language_options;
1386         bool const use_babel = features.useBabel() && !features.isProvided("babel");
1387         bool const use_polyglossia = features.usePolyglossia();
1388         bool const global = lyxrc.language_global_options;
1389         if (use_babel || (use_polyglossia && global)) {
1390                 language_options << features.getBabelLanguages();
1391                 if (!language->babel().empty()) {
1392                         if (!language_options.str().empty())
1393                                 language_options << ',';
1394                         language_options << language->babel();
1395                 }
1396                 if (global && !features.needBabelLangOptions()
1397                     && !language_options.str().empty())
1398                         clsoptions << language_options.str() << ',';
1399         }
1400
1401         // the predefined options from the layout
1402         if (use_default_options && !tclass.options().empty())
1403                 clsoptions << tclass.options() << ',';
1404
1405         // the user-defined options
1406         if (!options.empty()) {
1407                 clsoptions << options << ',';
1408         }
1409
1410         string strOptions(clsoptions.str());
1411         if (!strOptions.empty()) {
1412                 strOptions = rtrim(strOptions, ",");
1413                 // FIXME UNICODE
1414                 os << '[' << from_utf8(strOptions) << ']';
1415         }
1416
1417         os << '{' << from_ascii(tclass.latexname()) << "}\n";
1418         // end of \documentclass defs
1419
1420         // if we use fontspec, we have to load the AMS packages here
1421         string const ams = features.loadAMSPackages();
1422         if (useNonTeXFonts && !ams.empty())
1423                 os << from_ascii(ams);
1424
1425         if (useNonTeXFonts) {
1426                 os << "\\usepackage{fontspec}\n";
1427                 if (features.mustProvide("unicode-math")
1428                     && features.isAvailable("unicode-math"))
1429                         os << "\\usepackage{unicode-math}\n";
1430         }
1431
1432         // font selection must be done before loading fontenc.sty
1433         string const fonts = loadFonts(features);
1434         if (!fonts.empty())
1435                 os << from_utf8(fonts);
1436
1437         if (fonts_default_family != "default")
1438                 os << "\\renewcommand{\\familydefault}{\\"
1439                    << from_ascii(fonts_default_family) << "}\n";
1440
1441         // set font encoding
1442         // for arabic_arabi and farsi we also need to load the LAE and
1443         // LFE encoding
1444         // XeTeX and LuaTeX (with OS fonts) work without fontenc
1445         if (font_encoding() != "default" && language->lang() != "japanese"
1446             && !useNonTeXFonts && !features.isProvided("fontenc")) {
1447                 size_t fars = language_options.str().find("farsi");
1448                 size_t arab = language_options.str().find("arabic");
1449                 if (language->lang() == "arabic_arabi"
1450                         || language->lang() == "farsi" || fars != string::npos
1451                         || arab != string::npos) {
1452                         os << "\\usepackage[" << from_ascii(font_encoding())
1453                            << ",LFE,LAE]{fontenc}\n";
1454                 } else {
1455                         os << "\\usepackage[" << from_ascii(font_encoding())
1456                            << "]{fontenc}\n";
1457                 }
1458         }
1459
1460         // handle inputenc etc.
1461         writeEncodingPreamble(os, features);
1462
1463         // includeonly
1464         if (!features.runparams().includeall && !included_children_.empty()) {
1465                 os << "\\includeonly{";
1466                 list<string>::const_iterator it = included_children_.begin();
1467                 list<string>::const_iterator en = included_children_.end();
1468                 bool first = true;
1469                 for (; it != en; ++it) {
1470                         string incfile = *it;
1471                         FileName inc = makeAbsPath(incfile, filepath.absFileName());
1472                         string mangled = DocFileName(changeExtension(inc.absFileName(), ".tex")).
1473                         mangledFileName();
1474                         if (!features.runparams().nice)
1475                                 incfile = mangled;
1476                         // \includeonly doesn't want an extension
1477                         incfile = changeExtension(incfile, string());
1478                         incfile = support::latex_path(incfile);
1479                         if (!incfile.empty()) {
1480                                 if (!first)
1481                                         os << ",";
1482                                 os << from_utf8(incfile);
1483                         }
1484                         first = false;
1485                 }
1486                 os << "}\n";
1487         }
1488
1489         if (!listings_params.empty() || features.isRequired("listings"))
1490                 os << "\\usepackage{listings}\n";
1491
1492         if (!listings_params.empty()) {
1493                 os << "\\lstset{";
1494                 // do not test validity because listings_params is
1495                 // supposed to be valid
1496                 string par =
1497                         InsetListingsParams(listings_params).separatedParams(true);
1498                 // we can't support all packages, but we should load the color package
1499                 if (par.find("\\color", 0) != string::npos)
1500                         features.require("color");
1501                 os << from_utf8(par)
1502                    << "}\n";
1503         }
1504         if (!features.isProvided("geometry")
1505             && (use_geometry || nonstandard_papersize)) {
1506                 odocstringstream ods;
1507                 if (!getGraphicsDriver("geometry").empty())
1508                         ods << getGraphicsDriver("geometry");
1509                 if (orientation == ORIENTATION_LANDSCAPE)
1510                         ods << ",landscape";
1511                 switch (papersize) {
1512                 case PAPER_CUSTOM:
1513                         if (!paperwidth.empty())
1514                                 ods << ",paperwidth="
1515                                    << from_ascii(paperwidth);
1516                         if (!paperheight.empty())
1517                                 ods << ",paperheight="
1518                                    << from_ascii(paperheight);
1519                         break;
1520                 case PAPER_USLETTER:
1521                         ods << ",letterpaper";
1522                         break;
1523                 case PAPER_USLEGAL:
1524                         ods << ",legalpaper";
1525                         break;
1526                 case PAPER_USEXECUTIVE:
1527                         ods << ",executivepaper";
1528                         break;
1529                 case PAPER_A0:
1530                         ods << ",a0paper";
1531                         break;
1532                 case PAPER_A1:
1533                         ods << ",a1paper";
1534                         break;
1535                 case PAPER_A2:
1536                         ods << ",a2paper";
1537                         break;
1538                 case PAPER_A3:
1539                         ods << ",a3paper";
1540                         break;
1541                 case PAPER_A4:
1542                         ods << ",a4paper";
1543                         break;
1544                 case PAPER_A5:
1545                         ods << ",a5paper";
1546                         break;
1547                 case PAPER_A6:
1548                         ods << ",a6paper";
1549                         break;
1550                 case PAPER_B0:
1551                         ods << ",b0paper";
1552                         break;
1553                 case PAPER_B1:
1554                         ods << ",b1paper";
1555                         break;
1556                 case PAPER_B2:
1557                         ods << ",b2paper";
1558                         break;
1559                 case PAPER_B3:
1560                         ods << ",b3paper";
1561                         break;
1562                 case PAPER_B4:
1563                         ods << ",b4paper";
1564                         break;
1565                 case PAPER_B5:
1566                         ods << ",b5paper";
1567                         break;
1568                 case PAPER_B6:
1569                         ods << ",b6paper";
1570                         break;
1571                 case PAPER_C0:
1572                         ods << ",c0paper";
1573                         break;
1574                 case PAPER_C1:
1575                         ods << ",c1paper";
1576                         break;
1577                 case PAPER_C2:
1578                         ods << ",c2paper";
1579                         break;
1580                 case PAPER_C3:
1581                         ods << ",c3paper";
1582                         break;
1583                 case PAPER_C4:
1584                         ods << ",c4paper";
1585                         break;
1586                 case PAPER_C5:
1587                         ods << ",c5paper";
1588                         break;
1589                 case PAPER_C6:
1590                         ods << ",c6paper";
1591                         break;
1592                 case PAPER_JISB0:
1593                         ods << ",b0j";
1594                         break;
1595                 case PAPER_JISB1:
1596                         ods << ",b1j";
1597                         break;
1598                 case PAPER_JISB2:
1599                         ods << ",b2j";
1600                         break;
1601                 case PAPER_JISB3:
1602                         ods << ",b3j";
1603                         break;
1604                 case PAPER_JISB4:
1605                         ods << ",b4j";
1606                         break;
1607                 case PAPER_JISB5:
1608                         ods << ",b5j";
1609                         break;
1610                 case PAPER_JISB6:
1611                         ods << ",b6j";
1612                         break;
1613                 case PAPER_DEFAULT:
1614                         break;
1615                 }
1616                 docstring const g_options = trim(ods.str(), ",");
1617                 os << "\\usepackage";
1618                 if (!g_options.empty())
1619                         os << '[' << g_options << ']';
1620                 os << "{geometry}\n";
1621                 // output this only if use_geometry is true
1622                 if (use_geometry) {
1623                         os << "\\geometry{verbose";
1624                         if (!topmargin.empty())
1625                                 os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1626                         if (!bottommargin.empty())
1627                                 os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1628                         if (!leftmargin.empty())
1629                                 os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1630                         if (!rightmargin.empty())
1631                                 os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1632                         if (!headheight.empty())
1633                                 os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1634                         if (!headsep.empty())
1635                                 os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1636                         if (!footskip.empty())
1637                                 os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1638                         if (!columnsep.empty())
1639                                 os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
1640                         os << "}\n";
1641                 }
1642         } else if (orientation == ORIENTATION_LANDSCAPE
1643                    || papersize != PAPER_DEFAULT) {
1644                 features.require("papersize");
1645         }
1646
1647         if (tokenPos(tclass.opt_pagestyle(), '|', pagestyle) >= 0) {
1648                 if (pagestyle == "fancy")
1649                         os << "\\usepackage{fancyhdr}\n";
1650                 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1651         }
1652
1653         // only output when the background color is not default
1654         if (isbackgroundcolor == true) {
1655                 // only require color here, the background color will be defined
1656                 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1657                 // package pdfpages
1658                 features.require("color");
1659                 features.require("pagecolor");
1660         }
1661
1662         // only output when the font color is not default
1663         if (isfontcolor == true) {
1664                 // only require color here, the font color will be defined
1665                 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1666                 // package pdfpages
1667                 features.require("color");
1668                 features.require("fontcolor");
1669         }
1670
1671         // Only if class has a ToC hierarchy
1672         if (tclass.hasTocLevels()) {
1673                 if (secnumdepth != tclass.secnumdepth()) {
1674                         os << "\\setcounter{secnumdepth}{"
1675                            << secnumdepth
1676                            << "}\n";
1677                 }
1678                 if (tocdepth != tclass.tocdepth()) {
1679                         os << "\\setcounter{tocdepth}{"
1680                            << tocdepth
1681                            << "}\n";
1682                 }
1683         }
1684
1685         if (paragraph_separation) {
1686                 // when skip separation
1687                 switch (getDefSkip().kind()) {
1688                 case VSpace::SMALLSKIP:
1689                         os << "\\setlength{\\parskip}{\\smallskipamount}\n";
1690                         break;
1691                 case VSpace::MEDSKIP:
1692                         os << "\\setlength{\\parskip}{\\medskipamount}\n";
1693                         break;
1694                 case VSpace::BIGSKIP:
1695                         os << "\\setlength{\\parskip}{\\bigskipamount}\n";
1696                         break;
1697                 case VSpace::LENGTH:
1698                         os << "\\setlength{\\parskip}{"
1699                            << from_utf8(getDefSkip().length().asLatexString())
1700                            << "}\n";
1701                         break;
1702                 default: // should never happen // Then delete it.
1703                         os << "\\setlength{\\parskip}{\\medskipamount}\n";
1704                         break;
1705                 }
1706                 os << "\\setlength{\\parindent}{0pt}\n";
1707         } else {
1708                 // when separation by indentation
1709                 // only output something when a width is given
1710                 if (getIndentation().asLyXCommand() != "default") {
1711                         os << "\\setlength{\\parindent}{"
1712                            << from_utf8(getIndentation().asLatexCommand())
1713                            << "}\n";
1714                 }
1715         }
1716
1717         // Now insert the LyX specific LaTeX commands...
1718         docstring lyxpreamble;
1719         features.resolveAlternatives();
1720
1721         if (output_sync) {
1722                 if (!output_sync_macro.empty())
1723                         lyxpreamble += from_utf8(output_sync_macro) +"\n";
1724                 else if (features.runparams().flavor == OutputParams::LATEX)
1725                         lyxpreamble += "\\usepackage[active]{srcltx}\n";
1726                 else if (features.runparams().flavor == OutputParams::PDFLATEX)
1727                         lyxpreamble += "\\synctex=-1\n";
1728         }
1729
1730         // due to interferences with babel and hyperref, the color package has to
1731         // be loaded (when it is not already loaded) before babel when hyperref
1732         // is used with the colorlinks option, see
1733         // http://www.lyx.org/trac/ticket/5291
1734         // we decided therefore to load color always before babel, see
1735         // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
1736         lyxpreamble += from_ascii(features.getColorOptions());
1737
1738         // If we use hyperref, jurabib, japanese, or vietnamese, we have to call babel before them.
1739         if (use_babel
1740             && (features.isRequired("jurabib")
1741                 || features.isRequired("hyperref")
1742                 || features.isRequired("vietnamese")
1743                 || features.isRequired("japanese"))) {
1744                         // FIXME UNICODE
1745                         lyxpreamble += from_utf8(features.getBabelPresettings());
1746                         lyxpreamble += from_utf8(babelCall(language_options.str(),
1747                                                            features.needBabelLangOptions())) + '\n';
1748                         lyxpreamble += from_utf8(features.getBabelPostsettings());
1749         }
1750
1751         // The optional packages;
1752         lyxpreamble += from_ascii(features.getPackages());
1753
1754         // Additional Indices
1755         if (features.isRequired("splitidx")) {
1756                 IndicesList::const_iterator iit = indiceslist().begin();
1757                 IndicesList::const_iterator iend = indiceslist().end();
1758                 for (; iit != iend; ++iit) {
1759                         pair<docstring, docstring> indexname_latex =
1760                                 features.runparams().encoding->latexString(iit->index(),
1761                                                                            features.runparams().dryrun);
1762                         if (!indexname_latex.second.empty()) {
1763                                 // issue a warning about omitted characters
1764                                 // FIXME: should be passed to the error dialog
1765                                 frontend::Alert::warning(_("Uncodable characters"),
1766                                         bformat(_("The following characters that are used in an index name are not\n"
1767                                                   "representable in the current encoding and therefore have been omitted:\n%1$s."),
1768                                                 indexname_latex.second));
1769                         }
1770                         lyxpreamble += "\\newindex[";
1771                         lyxpreamble += indexname_latex.first;
1772                         lyxpreamble += "]{";
1773                         lyxpreamble += escape(iit->shortcut());
1774                         lyxpreamble += "}\n";
1775                 }
1776         }
1777
1778         // Line spacing
1779         lyxpreamble += from_utf8(spacing().writePreamble(features.isProvided("SetSpace")));
1780
1781         // PDF support.
1782         // * Hyperref manual: "Make sure it comes last of your loaded
1783         //   packages, to give it a fighting chance of not being over-written,
1784         //   since its job is to redefine many LaTeX commands."
1785         // * Email from Heiko Oberdiek: "It is usually better to load babel
1786         //   before hyperref. Then hyperref has a chance to detect babel.
1787         // * Has to be loaded before the "LyX specific LaTeX commands" to
1788         //   avoid errors with algorithm floats.
1789         // use hyperref explicitly if it is required
1790         if (features.isRequired("hyperref")) {
1791                 // pass what we have to stream here, since we need
1792                 // to access the stream itself in PDFOptions.
1793                 os << lyxpreamble;
1794
1795                 OutputParams tmp_params = features.runparams();
1796                 pdfoptions().writeLaTeX(tmp_params, os,
1797                                         features.isProvided("hyperref"));
1798                 // set back for the rest
1799                 lyxpreamble.clear();
1800                 // correctly break URLs with hyperref and dvi output
1801                 if (features.runparams().flavor == OutputParams::LATEX
1802                     && features.isAvailable("breakurl"))
1803                         lyxpreamble += "\\usepackage{breakurl}\n";
1804         } else if (features.isRequired("nameref"))
1805                 // hyperref loads this automatically
1806                 lyxpreamble += "\\usepackage{nameref}\n";
1807
1808         // bibtopic needs to be loaded after hyperref.
1809         // the dot provides the aux file naming which LyX can detect.
1810         if (features.mustProvide("bibtopic"))
1811                 lyxpreamble += "\\usepackage[dot]{bibtopic}\n";
1812
1813         // Will be surrounded by \makeatletter and \makeatother when not empty
1814         docstring atlyxpreamble;
1815
1816         // Some macros LyX will need
1817         docstring tmppreamble(features.getMacros());
1818
1819         if (!tmppreamble.empty())
1820                 atlyxpreamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1821                         "LyX specific LaTeX commands.\n"
1822                         + tmppreamble + '\n';
1823
1824         // the text class specific preamble
1825         tmppreamble = features.getTClassPreamble();
1826         if (!tmppreamble.empty())
1827                 atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1828                         "Textclass specific LaTeX commands.\n"
1829                         + tmppreamble + '\n';
1830
1831         // suppress date if selected
1832         // use \@ifundefined because we cannot be sure that every document class
1833         // has a \date command
1834         if (suppress_date)
1835                 atlyxpreamble += "\\@ifundefined{date}{}{\\date{}}\n";
1836
1837         /* the user-defined preamble */
1838         if (!containsOnly(preamble, " \n\t"))
1839                 // FIXME UNICODE
1840                 atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1841                         "User specified LaTeX commands.\n"
1842                         + from_utf8(preamble) + '\n';
1843
1844         // subfig loads internally the LaTeX package "caption". As
1845         // caption is a very popular package, users will load it in
1846         // the preamble. Therefore we must load subfig behind the
1847         // user-defined preamble and check if the caption package was
1848         // loaded or not. For the case that caption is loaded before
1849         // subfig, there is the subfig option "caption=false". This
1850         // option also works when a koma-script class is used and
1851         // koma's own caption commands are used instead of caption. We
1852         // use \PassOptionsToPackage here because the user could have
1853         // already loaded subfig in the preamble.
1854         if (features.isRequired("subfig")) {
1855                 atlyxpreamble += "\\@ifundefined{showcaptionsetup}{}{%\n"
1856                         " \\PassOptionsToPackage{caption=false}{subfig}}\n"
1857                         "\\usepackage{subfig}\n";
1858         }
1859
1860         // Itemize bullet settings need to be last in case the user
1861         // defines their own bullets that use a package included
1862         // in the user-defined preamble -- ARRae
1863         // Actually it has to be done much later than that
1864         // since some packages like frenchb make modifications
1865         // at \begin{document} time -- JMarc
1866         docstring bullets_def;
1867         for (int i = 0; i < 4; ++i) {
1868                 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1869                         if (bullets_def.empty())
1870                                 bullets_def += "\\AtBeginDocument{\n";
1871                         bullets_def += "  \\def\\labelitemi";
1872                         switch (i) {
1873                                 // `i' is one less than the item to modify
1874                         case 0:
1875                                 break;
1876                         case 1:
1877                                 bullets_def += 'i';
1878                                 break;
1879                         case 2:
1880                                 bullets_def += "ii";
1881                                 break;
1882                         case 3:
1883                                 bullets_def += 'v';
1884                                 break;
1885                         }
1886                         bullets_def += '{' +
1887                                 user_defined_bullet(i).getText()
1888                                 + "}\n";
1889                 }
1890         }
1891
1892         if (!bullets_def.empty())
1893                 atlyxpreamble += bullets_def + "}\n\n";
1894
1895         if (!atlyxpreamble.empty())
1896                 lyxpreamble += "\n\\makeatletter\n"
1897                         + atlyxpreamble + "\\makeatother\n\n";
1898
1899         // We try to load babel late, in case it interferes with other packages.
1900         // Jurabib and Hyperref have to be called after babel, though.
1901         if (use_babel && !features.isRequired("jurabib")
1902             && !features.isRequired("hyperref")
1903             && !features.isRequired("vietnamese")
1904             && !features.isRequired("japanese")) {
1905                 // FIXME UNICODE
1906                 lyxpreamble += from_utf8(features.getBabelPresettings());
1907                 lyxpreamble += from_utf8(babelCall(language_options.str(),
1908                                                    features.needBabelLangOptions())) + '\n';
1909                 lyxpreamble += from_utf8(features.getBabelPostsettings());
1910         }
1911
1912         // xunicode needs to be loaded at least after amsmath, amssymb,
1913         // esint and the other packages that provide special glyphs
1914         if (features.runparams().flavor == OutputParams::XETEX)
1915                 lyxpreamble += "\\usepackage{xunicode}\n";
1916
1917         // Polyglossia must be loaded last
1918         if (use_polyglossia) {
1919                 // call the package
1920                 lyxpreamble += "\\usepackage{polyglossia}\n";
1921                 // set the main language
1922                 lyxpreamble += "\\setdefaultlanguage";
1923                 if (!language->polyglossiaOpts().empty())
1924                         lyxpreamble += "[" + from_ascii(language->polyglossiaOpts()) + "]";
1925                 lyxpreamble += "{" + from_ascii(language->polyglossia()) + "}\n";
1926                 // now setup the other languages
1927                 std::map<std::string, std::string> const polylangs =
1928                         features.getPolyglossiaLanguages();
1929                 for (std::map<std::string, std::string>::const_iterator mit = polylangs.begin();
1930                      mit != polylangs.end() ; ++mit) {
1931                         lyxpreamble += "\\setotherlanguage";
1932                         if (!mit->second.empty())
1933                                 lyxpreamble += "[" + from_ascii(mit->second) + "]";
1934                         lyxpreamble += "{" + from_ascii(mit->first) + "}\n";
1935                 }
1936         }
1937
1938         // Load custom language package here
1939         if (features.langPackage() == LaTeXFeatures::LANG_PACK_CUSTOM) {
1940                 if (lang_package == "default")
1941                         lyxpreamble += from_utf8(lyxrc.language_custom_package);
1942                 else
1943                         lyxpreamble += from_utf8(lang_package);
1944                 lyxpreamble += '\n';
1945         }
1946
1947         docstring const i18npreamble =
1948                 features.getTClassI18nPreamble(use_babel, use_polyglossia);
1949         if (!i18npreamble.empty())
1950                 lyxpreamble += i18npreamble + '\n';
1951
1952         os << lyxpreamble;
1953
1954         return use_babel;
1955 }
1956
1957
1958 void BufferParams::useClassDefaults()
1959 {
1960         DocumentClass const & tclass = documentClass();
1961
1962         sides = tclass.sides();
1963         columns = tclass.columns();
1964         pagestyle = tclass.pagestyle();
1965         use_default_options = true;
1966         // Only if class has a ToC hierarchy
1967         if (tclass.hasTocLevels()) {
1968                 secnumdepth = tclass.secnumdepth();
1969                 tocdepth = tclass.tocdepth();
1970         }
1971 }
1972
1973
1974 bool BufferParams::hasClassDefaults() const
1975 {
1976         DocumentClass const & tclass = documentClass();
1977
1978         return sides == tclass.sides()
1979                 && columns == tclass.columns()
1980                 && pagestyle == tclass.pagestyle()
1981                 && use_default_options
1982                 && secnumdepth == tclass.secnumdepth()
1983                 && tocdepth == tclass.tocdepth();
1984 }
1985
1986
1987 DocumentClass const & BufferParams::documentClass() const
1988 {
1989         return *doc_class_.get();
1990 }
1991
1992
1993 DocumentClassConstPtr BufferParams::documentClassPtr() const
1994 {
1995         return doc_class_;
1996 }
1997
1998
1999 void BufferParams::setDocumentClass(DocumentClassConstPtr tc)
2000 {
2001         // evil, but this function is evil
2002         doc_class_ = const_pointer_cast<DocumentClass>(tc);
2003 }
2004
2005
2006 bool BufferParams::setBaseClass(string const & classname)
2007 {
2008         LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
2009         LayoutFileList & bcl = LayoutFileList::get();
2010         if (!bcl.haveClass(classname)) {
2011                 docstring s =
2012                         bformat(_("The layout file:\n"
2013                                 "%1$s\n"
2014                                 "could not be found. A default textclass with default\n"
2015                                 "layouts will be used. LyX will not be able to produce\n"
2016                                 "correct output."),
2017                         from_utf8(classname));
2018                 frontend::Alert::error(_("Document class not found"), s);
2019                 bcl.addEmptyClass(classname);
2020         }
2021
2022         bool const success = bcl[classname].load();
2023         if (!success) {
2024                 docstring s =
2025                         bformat(_("Due to some error in it, the layout file:\n"
2026                                 "%1$s\n"
2027                                 "could not be loaded. A default textclass with default\n"
2028                                 "layouts will be used. LyX will not be able to produce\n"
2029                                 "correct output."),
2030                         from_utf8(classname));
2031                 frontend::Alert::error(_("Could not load class"), s);
2032                 bcl.addEmptyClass(classname);
2033         }
2034
2035         pimpl_->baseClass_ = classname;
2036         layout_modules_.adaptToBaseClass(baseClass(), removed_modules_);
2037         return true;
2038 }
2039
2040
2041 LayoutFile const * BufferParams::baseClass() const
2042 {
2043         if (LayoutFileList::get().haveClass(pimpl_->baseClass_))
2044                 return &(LayoutFileList::get()[pimpl_->baseClass_]);
2045         else
2046                 return 0;
2047 }
2048
2049
2050 LayoutFileIndex const & BufferParams::baseClassID() const
2051 {
2052         return pimpl_->baseClass_;
2053 }
2054
2055
2056 void BufferParams::makeDocumentClass()
2057 {
2058         if (!baseClass())
2059                 return;
2060
2061         LayoutModuleList mods;
2062         LayoutModuleList::iterator it;
2063         LayoutModuleList::iterator en;
2064
2065         it = layout_modules_.begin();
2066         en = layout_modules_.end();
2067         for (; it != en; ++it)
2068                 mods.push_back(*it);
2069         it = cite_engine_.begin();
2070         en = cite_engine_.end();
2071         for (; it != en; ++it)
2072                 mods.push_back(*it);
2073         doc_class_ = getDocumentClass(*baseClass(), mods);
2074
2075         if (!local_layout.empty()) {
2076                 TextClass::ReturnValues success =
2077                         doc_class_->read(local_layout, TextClass::MODULE);
2078                 if (success != TextClass::OK && success != TextClass::OK_OLDFORMAT) {
2079                         docstring const msg = _("Error reading internal layout information");
2080                         frontend::Alert::warning(_("Read Error"), msg);
2081                 }
2082         }
2083 }
2084
2085
2086 bool BufferParams::moduleCanBeAdded(string const & modName) const
2087 {
2088         return cite_engine_.moduleCanBeAdded(modName, baseClass()) &&
2089                 layout_modules_.moduleCanBeAdded(modName, baseClass());
2090 }
2091
2092
2093 bool BufferParams::addLayoutModule(string const & modName)
2094 {
2095         LayoutModuleList::const_iterator it = layout_modules_.begin();
2096         LayoutModuleList::const_iterator end = layout_modules_.end();
2097         for (; it != end; ++it)
2098                 if (*it == modName)
2099                         return false;
2100         layout_modules_.push_back(modName);
2101         return true;
2102 }
2103
2104
2105 string BufferParams::bufferFormat() const
2106 {
2107         string format = documentClass().outputFormat();
2108         if (format == "latex") {
2109                 if (useNonTeXFonts)
2110                         return "xetex";
2111                 if (encoding().package() == Encoding::japanese)
2112                         return "platex";
2113         }
2114         return format;
2115 }
2116
2117
2118 bool BufferParams::isExportable(string const & format) const
2119 {
2120         vector<string> backs = backends();
2121         for (vector<string>::const_iterator it = backs.begin();
2122              it != backs.end(); ++it)
2123                 if (theConverters().isReachable(*it, format))
2124                         return true;
2125         return false;
2126 }
2127
2128
2129 namespace {
2130 bool formatSorter(Format const * lhs, Format const * rhs) {
2131         return _(lhs->prettyname()) < _(rhs->prettyname());
2132 }
2133 }
2134
2135
2136 vector<Format const *> BufferParams::exportableFormats(bool only_viewable) const
2137 {
2138         vector<string> const backs = backends();
2139         set<string> excludes;
2140         if (useNonTeXFonts) {
2141                 excludes.insert("latex");
2142                 excludes.insert("pdflatex");
2143         }
2144         vector<Format const *> result =
2145                 theConverters().getReachable(backs[0], only_viewable, true, excludes);
2146         for (vector<string>::const_iterator it = backs.begin() + 1;
2147              it != backs.end(); ++it) {
2148                 vector<Format const *>  r =
2149                         theConverters().getReachable(*it, only_viewable, false, excludes);
2150                 result.insert(result.end(), r.begin(), r.end());
2151         }
2152         sort(result.begin(), result.end(), formatSorter);
2153         return result;
2154 }
2155
2156
2157 bool BufferParams::isExportableFormat(string const & format) const
2158 {
2159         typedef vector<Format const *> Formats;
2160         Formats formats;
2161         formats = exportableFormats(true);
2162         Formats::const_iterator fit = formats.begin();
2163         Formats::const_iterator end = formats.end();
2164         for (; fit != end ; ++fit) {
2165                 if ((*fit)->name() == format)
2166                         return true;
2167         }
2168         return false;
2169 }
2170
2171
2172 vector<string> BufferParams::backends() const
2173 {
2174         vector<string> v;
2175         string const buffmt = bufferFormat();
2176
2177         // FIXME: Don't hardcode format names here, but use a flag
2178         if (buffmt == "latex") {
2179                 if (!useNonTeXFonts) {
2180                         v.push_back("pdflatex");
2181                         v.push_back("latex");
2182                 }
2183                 v.push_back("luatex");
2184                 v.push_back("dviluatex");
2185                 v.push_back("xetex");
2186         } else if (buffmt == "xetex") {
2187                 v.push_back("xetex");
2188                 v.push_back("luatex");
2189                 v.push_back("dviluatex");
2190         } else
2191                 v.push_back(buffmt);
2192
2193         v.push_back("xhtml");
2194         v.push_back("text");
2195         v.push_back("lyx");
2196         return v;
2197 }
2198
2199
2200 OutputParams::FLAVOR BufferParams::getOutputFlavor(string const format) const
2201 {
2202         string const dformat = (format.empty() || format == "default") ?
2203                 getDefaultOutputFormat() : format;
2204         DefaultFlavorCache::const_iterator it =
2205                 default_flavors_.find(dformat);
2206
2207         if (it != default_flavors_.end())
2208                 return it->second;
2209
2210         OutputParams::FLAVOR result = OutputParams::LATEX;
2211
2212         // FIXME It'd be better not to hardcode this, but to do
2213         //       something with formats.
2214         if (dformat == "xhtml")
2215                 result = OutputParams::HTML;
2216         else if (dformat == "text")
2217                 result = OutputParams::TEXT;
2218         else if (dformat == "lyx")
2219                 result = OutputParams::LYX;
2220         else if (dformat == "pdflatex")
2221                 result = OutputParams::PDFLATEX;
2222         else if (dformat == "xetex")
2223                 result = OutputParams::XETEX;
2224         else if (dformat == "luatex")
2225                 result = OutputParams::LUATEX;
2226         else if (dformat == "dviluatex")
2227                 result = OutputParams::DVILUATEX;
2228         else {
2229                 // Try to determine flavor of default output format
2230                 vector<string> backs = backends();
2231                 if (find(backs.begin(), backs.end(), dformat) == backs.end()) {
2232                         // Get shortest path to format
2233                         Graph::EdgePath path;
2234                         for (vector<string>::const_iterator it = backs.begin();
2235                             it != backs.end(); ++it) {
2236                                 Graph::EdgePath p = theConverters().getPath(*it, dformat);
2237                                 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2238                                         path = p;
2239                                 }
2240                         }
2241                         if (!path.empty())
2242                                 result = theConverters().getFlavor(path);
2243                 }
2244         }
2245         // cache this flavor
2246         default_flavors_[dformat] = result;
2247         return result;
2248 }
2249
2250
2251 string BufferParams::getDefaultOutputFormat() const
2252 {
2253         if (!default_output_format.empty()
2254             && default_output_format != "default")
2255                 return default_output_format;
2256         if (isDocBook()
2257             || useNonTeXFonts
2258             || encoding().package() == Encoding::japanese) {
2259                 vector<Format const *> const formats = exportableFormats(true);
2260                 if (formats.empty())
2261                         return string();
2262                 // return the first we find
2263                 return formats.front()->name();
2264         }
2265         return lyxrc.default_view_format;
2266 }
2267
2268 Font const BufferParams::getFont() const
2269 {
2270         FontInfo f = documentClass().defaultfont();
2271         if (fonts_default_family == "rmdefault")
2272                 f.setFamily(ROMAN_FAMILY);
2273         else if (fonts_default_family == "sfdefault")
2274                 f.setFamily(SANS_FAMILY);
2275         else if (fonts_default_family == "ttdefault")
2276                 f.setFamily(TYPEWRITER_FAMILY);
2277         return Font(f, language);
2278 }
2279
2280
2281 InsetQuotes::QuoteLanguage BufferParams::getQuoteStyle(string const qs) const
2282 {
2283         return quoteslangtranslator().find(qs);
2284 }
2285
2286
2287 bool BufferParams::isLatex() const
2288 {
2289         return documentClass().outputType() == LATEX;
2290 }
2291
2292
2293 bool BufferParams::isLiterate() const
2294 {
2295         return documentClass().outputType() == LITERATE;
2296 }
2297
2298
2299 bool BufferParams::isDocBook() const
2300 {
2301         return documentClass().outputType() == DOCBOOK;
2302 }
2303
2304
2305 void BufferParams::readPreamble(Lexer & lex)
2306 {
2307         if (lex.getString() != "\\begin_preamble")
2308                 lyxerr << "Error (BufferParams::readPreamble):"
2309                         "consistency check failed." << endl;
2310
2311         preamble = lex.getLongString("\\end_preamble");
2312 }
2313
2314
2315 void BufferParams::readLocalLayout(Lexer & lex)
2316 {
2317         if (lex.getString() != "\\begin_local_layout")
2318                 lyxerr << "Error (BufferParams::readLocalLayout):"
2319                         "consistency check failed." << endl;
2320
2321         local_layout = lex.getLongString("\\end_local_layout");
2322 }
2323
2324
2325 bool BufferParams::setLanguage(string const & lang)
2326 {
2327         Language const *new_language = languages.getLanguage(lang);
2328         if (!new_language) {
2329                 // Language lang was not found
2330                 return false;
2331         }
2332         language = new_language;
2333         return true;
2334 }
2335
2336
2337 void BufferParams::readLanguage(Lexer & lex)
2338 {
2339         if (!lex.next()) return;
2340
2341         string const tmptok = lex.getString();
2342
2343         // check if tmptok is part of tex_babel in tex-defs.h
2344         if (!setLanguage(tmptok)) {
2345                 // Language tmptok was not found
2346                 language = default_language;
2347                 lyxerr << "Warning: Setting language `"
2348                        << tmptok << "' to `" << language->lang()
2349                        << "'." << endl;
2350         }
2351 }
2352
2353
2354 void BufferParams::readGraphicsDriver(Lexer & lex)
2355 {
2356         if (!lex.next())
2357                 return;
2358
2359         string const tmptok = lex.getString();
2360         // check if tmptok is part of tex_graphics in tex_defs.h
2361         int n = 0;
2362         while (true) {
2363                 string const test = tex_graphics[n++];
2364
2365                 if (test == tmptok) {
2366                         graphics_driver = tmptok;
2367                         break;
2368                 }
2369                 if (test.empty()) {
2370                         lex.printError(
2371                                 "Warning: graphics driver `$$Token' not recognized!\n"
2372                                 "         Setting graphics driver to `default'.\n");
2373                         graphics_driver = "default";
2374                         break;
2375                 }
2376         }
2377 }
2378
2379
2380 void BufferParams::readBullets(Lexer & lex)
2381 {
2382         if (!lex.next())
2383                 return;
2384
2385         int const index = lex.getInteger();
2386         lex.next();
2387         int temp_int = lex.getInteger();
2388         user_defined_bullet(index).setFont(temp_int);
2389         temp_bullet(index).setFont(temp_int);
2390         lex >> temp_int;
2391         user_defined_bullet(index).setCharacter(temp_int);
2392         temp_bullet(index).setCharacter(temp_int);
2393         lex >> temp_int;
2394         user_defined_bullet(index).setSize(temp_int);
2395         temp_bullet(index).setSize(temp_int);
2396 }
2397
2398
2399 void BufferParams::readBulletsLaTeX(Lexer & lex)
2400 {
2401         // The bullet class should be able to read this.
2402         if (!lex.next())
2403                 return;
2404         int const index = lex.getInteger();
2405         lex.next(true);
2406         docstring const temp_str = lex.getDocString();
2407
2408         user_defined_bullet(index).setText(temp_str);
2409         temp_bullet(index).setText(temp_str);
2410 }
2411
2412
2413 void BufferParams::readModules(Lexer & lex)
2414 {
2415         if (!lex.eatLine()) {
2416                 lyxerr << "Error (BufferParams::readModules):"
2417                                 "Unexpected end of input." << endl;
2418                 return;
2419         }
2420         while (true) {
2421                 string mod = lex.getString();
2422                 if (mod == "\\end_modules")
2423                         break;
2424                 addLayoutModule(mod);
2425                 lex.eatLine();
2426         }
2427 }
2428
2429
2430 void BufferParams::readRemovedModules(Lexer & lex)
2431 {
2432         if (!lex.eatLine()) {
2433                 lyxerr << "Error (BufferParams::readRemovedModules):"
2434                                 "Unexpected end of input." << endl;
2435                 return;
2436         }
2437         while (true) {
2438                 string mod = lex.getString();
2439                 if (mod == "\\end_removed_modules")
2440                         break;
2441                 removed_modules_.push_back(mod);
2442                 lex.eatLine();
2443         }
2444         // now we want to remove any removed modules that were previously
2445         // added. normally, that will be because default modules were added in
2446         // setBaseClass(), which gets called when \textclass is read at the
2447         // start of the read.
2448         list<string>::const_iterator rit = removed_modules_.begin();
2449         list<string>::const_iterator const ren = removed_modules_.end();
2450         for (; rit != ren; ++rit) {
2451                 LayoutModuleList::iterator const mit = layout_modules_.begin();
2452                 LayoutModuleList::iterator const men = layout_modules_.end();
2453                 LayoutModuleList::iterator found = find(mit, men, *rit);
2454                 if (found == men)
2455                         continue;
2456                 layout_modules_.erase(found);
2457         }
2458 }
2459
2460
2461 void BufferParams::readIncludeonly(Lexer & lex)
2462 {
2463         if (!lex.eatLine()) {
2464                 lyxerr << "Error (BufferParams::readIncludeonly):"
2465                                 "Unexpected end of input." << endl;
2466                 return;
2467         }
2468         while (true) {
2469                 string child = lex.getString();
2470                 if (child == "\\end_includeonly")
2471                         break;
2472                 included_children_.push_back(child);
2473                 lex.eatLine();
2474         }
2475 }
2476
2477
2478 string BufferParams::paperSizeName(PapersizePurpose purpose) const
2479 {
2480         switch (papersize) {
2481         case PAPER_DEFAULT:
2482                 // could be anything, so don't guess
2483                 return string();
2484         case PAPER_CUSTOM: {
2485                 if (purpose == XDVI && !paperwidth.empty() &&
2486                     !paperheight.empty()) {
2487                         // heightxwidth<unit>
2488                         string first = paperwidth;
2489                         string second = paperheight;
2490                         if (orientation == ORIENTATION_LANDSCAPE)
2491                                 first.swap(second);
2492                         // cut off unit.
2493                         return first.erase(first.length() - 2)
2494                                 + "x" + second;
2495                 }
2496                 return string();
2497         }
2498         case PAPER_A0:
2499                 // dvips and dvipdfm do not know this
2500                 if (purpose == DVIPS || purpose == DVIPDFM)
2501                         return string();
2502                 return "a0";
2503         case PAPER_A1:
2504                 if (purpose == DVIPS || purpose == DVIPDFM)
2505                         return string();
2506                 return "a1";
2507         case PAPER_A2:
2508                 if (purpose == DVIPS || purpose == DVIPDFM)
2509                         return string();
2510                 return "a2";
2511         case PAPER_A3:
2512                 return "a3";
2513         case PAPER_A4:
2514                 return "a4";
2515         case PAPER_A5:
2516                 return "a5";
2517         case PAPER_A6:
2518                 if (purpose == DVIPS || purpose == DVIPDFM)
2519                         return string();
2520                 return "a6";
2521         case PAPER_B0:
2522                 if (purpose == DVIPS || purpose == DVIPDFM)
2523                         return string();
2524                 return "b0";
2525         case PAPER_B1:
2526                 if (purpose == DVIPS || purpose == DVIPDFM)
2527                         return string();
2528                 return "b1";
2529         case PAPER_B2:
2530                 if (purpose == DVIPS || purpose == DVIPDFM)
2531                         return string();
2532                 return "b2";
2533         case PAPER_B3:
2534                 if (purpose == DVIPS || purpose == DVIPDFM)
2535                         return string();
2536                 return "b3";
2537         case PAPER_B4:
2538                 // dvipdfm does not know this
2539                 if (purpose == DVIPDFM)
2540                         return string();
2541                 return "b4";
2542         case PAPER_B5:
2543                 if (purpose == DVIPDFM)
2544                         return string();
2545                 return "b5";
2546         case PAPER_B6:
2547                 if (purpose == DVIPS || purpose == DVIPDFM)
2548                         return string();
2549                 return "b6";
2550         case PAPER_C0:
2551                 if (purpose == DVIPS || purpose == DVIPDFM)
2552                         return string();
2553                 return "c0";
2554         case PAPER_C1:
2555                 if (purpose == DVIPS || purpose == DVIPDFM)
2556                         return string();
2557                 return "c1";
2558         case PAPER_C2:
2559                 if (purpose == DVIPS || purpose == DVIPDFM)
2560                         return string();
2561                 return "c2";
2562         case PAPER_C3:
2563                 if (purpose == DVIPS || purpose == DVIPDFM)
2564                         return string();
2565                 return "c3";
2566         case PAPER_C4:
2567                 if (purpose == DVIPS || purpose == DVIPDFM)
2568                         return string();
2569                 return "c4";
2570         case PAPER_C5:
2571                 if (purpose == DVIPS || purpose == DVIPDFM)
2572                         return string();
2573                 return "c5";
2574         case PAPER_C6:
2575                 if (purpose == DVIPS || purpose == DVIPDFM)
2576                         return string();
2577                 return "c6";
2578         case PAPER_JISB0:
2579                 if (purpose == DVIPS || purpose == DVIPDFM)
2580                         return string();
2581                 return "jisb0";
2582         case PAPER_JISB1:
2583                 if (purpose == DVIPS || purpose == DVIPDFM)
2584                         return string();
2585                 return "jisb1";
2586         case PAPER_JISB2:
2587                 if (purpose == DVIPS || purpose == DVIPDFM)
2588                         return string();
2589                 return "jisb2";
2590         case PAPER_JISB3:
2591                 if (purpose == DVIPS || purpose == DVIPDFM)
2592                         return string();
2593                 return "jisb3";
2594         case PAPER_JISB4:
2595                 if (purpose == DVIPS || purpose == DVIPDFM)
2596                         return string();
2597                 return "jisb4";
2598         case PAPER_JISB5:
2599                 if (purpose == DVIPS || purpose == DVIPDFM)
2600                         return string();
2601                 return "jisb5";
2602         case PAPER_JISB6:
2603                 if (purpose == DVIPS || purpose == DVIPDFM)
2604                         return string();
2605                 return "jisb6";
2606         case PAPER_USEXECUTIVE:
2607                 // dvipdfm does not know this
2608                 if (purpose == DVIPDFM)
2609                         return string();
2610                 return "foolscap";
2611         case PAPER_USLEGAL:
2612                 return "legal";
2613         case PAPER_USLETTER:
2614         default:
2615                 if (purpose == XDVI)
2616                         return "us";
2617                 return "letter";
2618         }
2619 }
2620
2621
2622 string const BufferParams::dvips_options() const
2623 {
2624         string result;
2625
2626         // If the class loads the geometry package, we do not know which
2627         // paper size is used, since we do not set it (bug 7013).
2628         // Therefore we must not specify any argument here.
2629         // dvips gets the correct paper size via DVI specials in this case
2630         // (if the class uses the geometry package correctly).
2631         if (documentClass().provides("geometry"))
2632                 return result;
2633
2634         if (use_geometry
2635             && papersize == PAPER_CUSTOM
2636             && !lyxrc.print_paper_dimension_flag.empty()
2637             && !paperwidth.empty()
2638             && !paperheight.empty()) {
2639                 // using a custom papersize
2640                 result = lyxrc.print_paper_dimension_flag;
2641                 result += ' ' + paperwidth;
2642                 result += ',' + paperheight;
2643         } else {
2644                 string const paper_option = paperSizeName(DVIPS);
2645                 if (!paper_option.empty() && (paper_option != "letter" ||
2646                     orientation != ORIENTATION_LANDSCAPE)) {
2647                         // dvips won't accept -t letter -t landscape.
2648                         // In all other cases, include the paper size
2649                         // explicitly.
2650                         result = lyxrc.print_paper_flag;
2651                         result += ' ' + paper_option;
2652                 }
2653         }
2654         if (orientation == ORIENTATION_LANDSCAPE &&
2655             papersize != PAPER_CUSTOM)
2656                 result += ' ' + lyxrc.print_landscape_flag;
2657         return result;
2658 }
2659
2660
2661 string const BufferParams::font_encoding() const
2662 {
2663         return (fontenc == "global") ? lyxrc.fontenc : fontenc;
2664 }
2665
2666
2667 string BufferParams::babelCall(string const & lang_opts, bool const langoptions) const
2668 {
2669         // suppress the babel call if there is no BabelName defined
2670         // for the document language in the lib/languages file and if no
2671         // other languages are used (lang_opts is then empty)
2672         if (lang_opts.empty())
2673                 return string();
2674         // either a specific language (AsBabelOptions setting in
2675         // lib/languages) or the prefs require the languages to
2676         // be submitted to babel itself (not the class).
2677         if (langoptions)
2678                 return "\\usepackage[" + lang_opts + "]{babel}";
2679         return "\\usepackage{babel}";
2680 }
2681
2682
2683 docstring BufferParams::getGraphicsDriver(string const & package) const
2684 {
2685         docstring result;
2686
2687         if (package == "geometry") {
2688                 if (graphics_driver == "dvips"
2689                     || graphics_driver == "dvipdfm"
2690                     || graphics_driver == "pdftex"
2691                     || graphics_driver == "vtex")
2692                         result = from_ascii(graphics_driver);
2693                 else if (graphics_driver == "dvipdfmx")
2694                         result = from_ascii("dvipdfm");
2695         }
2696
2697         return result;
2698 }
2699
2700
2701 void BufferParams::writeEncodingPreamble(otexstream & os,
2702                                          LaTeXFeatures & features) const
2703 {
2704         // XeTeX does not need this
2705         if (features.runparams().flavor == OutputParams::XETEX)
2706                 return;
2707         // LuaTeX neither, but with tex fonts, we need to load
2708         // the luainputenc package.
2709         if (features.runparams().flavor == OutputParams::LUATEX
2710                 || features.runparams().flavor == OutputParams::DVILUATEX) {
2711                 if (!useNonTeXFonts && inputenc != "default"
2712                     && ((inputenc == "auto" && language->encoding()->package() == Encoding::inputenc)
2713                         || (inputenc != "auto" && encoding().package() == Encoding::inputenc))) {
2714                         os << "\\usepackage[utf8]{luainputenc}\n";
2715                 }
2716                 return;
2717         }
2718         if (inputenc == "auto") {
2719                 string const doc_encoding =
2720                         language->encoding()->latexName();
2721                 Encoding::Package const package =
2722                         language->encoding()->package();
2723
2724                 // Create a list with all the input encodings used
2725                 // in the document
2726                 set<string> encodings =
2727                         features.getEncodingSet(doc_encoding);
2728
2729                 // If the "japanese" package (i.e. pLaTeX) is used,
2730                 // inputenc must be omitted.
2731                 // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
2732                 if ((!encodings.empty() || package == Encoding::inputenc)
2733                     && !features.isRequired("japanese")) {
2734                         os << "\\usepackage[";
2735                         set<string>::const_iterator it = encodings.begin();
2736                         set<string>::const_iterator const end = encodings.end();
2737                         if (it != end) {
2738                                 os << from_ascii(*it);
2739                                 ++it;
2740                         }
2741                         for (; it != end; ++it)
2742                                 os << ',' << from_ascii(*it);
2743                         if (package == Encoding::inputenc) {
2744                                 if (!encodings.empty())
2745                                         os << ',';
2746                                 os << from_ascii(doc_encoding);
2747                         }
2748                         os << "]{inputenc}\n";
2749                 }
2750                 if (package == Encoding::CJK || features.mustProvide("CJK")) {
2751                         if (language->encoding()->name() == "utf8-cjk"
2752                             && LaTeXFeatures::isAvailable("CJKutf8"))
2753                                 os << "\\usepackage{CJKutf8}\n";
2754                         else
2755                                 os << "\\usepackage{CJK}\n";
2756                 }
2757         } else if (inputenc != "default") {
2758                 switch (encoding().package()) {
2759                 case Encoding::none:
2760                 case Encoding::japanese:
2761                         break;
2762                 case Encoding::inputenc:
2763                         // do not load inputenc if japanese is used
2764                         if (features.isRequired("japanese"))
2765                                 break;
2766                         os << "\\usepackage[" << from_ascii(inputenc)
2767                            << "]{inputenc}\n";
2768                         break;
2769                 case Encoding::CJK:
2770                         if (encoding().name() == "utf8-cjk"
2771                             && LaTeXFeatures::isAvailable("CJKutf8"))
2772                                 os << "\\usepackage{CJKutf8}\n";
2773                         else
2774                                 os << "\\usepackage{CJK}\n";
2775                         break;
2776                 }
2777         }
2778 }
2779
2780
2781 string const BufferParams::parseFontName(string const & name) const
2782 {
2783         string mangled = name;
2784         size_t const idx = mangled.find('[');
2785         if (idx == string::npos || idx == 0)
2786                 return mangled;
2787         else
2788                 return mangled.substr(0, idx - 1);
2789 }
2790
2791
2792 string const BufferParams::loadFonts(LaTeXFeatures & features) const
2793 {
2794         if (fonts_roman == "default" && fonts_sans == "default"
2795             && fonts_typewriter == "default"
2796             && (fonts_math == "default" || fonts_math == "auto"))
2797                 //nothing to do
2798                 return string();
2799
2800         ostringstream os;
2801
2802         /* Fontspec (XeTeX, LuaTeX): we provide GUI support for oldstyle
2803          * numbers (Numbers=OldStyle) and sf/tt scaling. The Ligatures=TeX/
2804          * Mapping=tex-text option assures TeX ligatures (such as "--")
2805          * are resolved. Note that tt does not use these ligatures.
2806          * TODO:
2807          *    -- add more GUI options?
2808          *    -- add more fonts (fonts for other scripts)
2809          *    -- if there's a way to find out if a font really supports
2810          *       OldStyle, enable/disable the widget accordingly.
2811         */
2812         if (useNonTeXFonts && features.isAvailable("fontspec")) {
2813                 // "Mapping=tex-text" and "Ligatures=TeX" are equivalent.
2814                 // However, until v.2 (2010/07/11) fontspec only knew
2815                 // Mapping=tex-text (for XeTeX only); then "Ligatures=TeX"
2816                 // was introduced for both XeTeX and LuaTeX (LuaTeX
2817                 // didn't understand "Mapping=tex-text", while XeTeX
2818                 // understood both. With most recent versions, both
2819                 // variants are understood by both engines. However,
2820                 // we want to provide support for at least TeXLive 2009
2821                 // (for XeTeX; LuaTeX is only supported as of v.2)
2822                 string const texmapping =
2823                         (features.runparams().flavor == OutputParams::XETEX) ?
2824                         "Mapping=tex-text" : "Ligatures=TeX";
2825                 if (fonts_roman != "default") {
2826                         os << "\\setmainfont[" << texmapping;
2827                         if (fonts_old_figures)
2828                                 os << ",Numbers=OldStyle";
2829                         os << "]{" << parseFontName(fonts_roman) << "}\n";
2830                 }
2831                 if (fonts_sans != "default") {
2832                         string const sans = parseFontName(fonts_sans);
2833                         if (fonts_sans_scale != 100)
2834                                 os << "\\setsansfont[Scale="
2835                                    << float(fonts_sans_scale) / 100
2836                                    << "," << texmapping << "]{"
2837                                    << sans << "}\n";
2838                         else
2839                                 os << "\\setsansfont[" << texmapping << "]{"
2840                                    << sans << "}\n";
2841                 }
2842                 if (fonts_typewriter != "default") {
2843                         string const mono = parseFontName(fonts_typewriter);
2844                         if (fonts_typewriter_scale != 100)
2845                                 os << "\\setmonofont[Scale="
2846                                    << float(fonts_typewriter_scale) / 100
2847                                    << "]{"
2848                                    << mono << "}\n";
2849                         else
2850                                 os << "\\setmonofont{"
2851                                    << mono << "}\n";
2852                 }
2853                 return os.str();
2854         }
2855
2856         // Tex Fonts
2857         bool const ot1 = (font_encoding() == "default" || font_encoding() == "OT1");
2858         bool const dryrun = features.runparams().dryrun;
2859         bool const complete = (fonts_sans == "default" && fonts_typewriter == "default");
2860         bool const nomath = (fonts_math == "default");
2861
2862         // ROMAN FONTS
2863         os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_roman)).getLaTeXCode(
2864                 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
2865                 nomath);
2866
2867         // SANS SERIF
2868         os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_sans)).getLaTeXCode(
2869                 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
2870                 nomath, fonts_sans_scale);
2871
2872         // MONOSPACED/TYPEWRITER
2873         os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_typewriter)).getLaTeXCode(
2874                 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
2875                 nomath, fonts_typewriter_scale);
2876
2877         // MATH
2878         os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_math)).getLaTeXCode(
2879                 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
2880                 nomath);
2881
2882         return os.str();
2883 }
2884
2885
2886 Encoding const & BufferParams::encoding() const
2887 {
2888         // FIXME: actually, we should check for the flavor
2889         // or runparams.isFullyUnicode() here:
2890         // This check will not work with XeTeX/LuaTeX and tex fonts.
2891         // Thus we have to reset the encoding in Buffer::makeLaTeXFile.
2892         if (useNonTeXFonts)
2893                 return *(encodings.fromLaTeXName("utf8-plain"));
2894         if (inputenc == "auto" || inputenc == "default")
2895                 return *language->encoding();
2896         Encoding const * const enc = encodings.fromLaTeXName(inputenc);
2897         if (enc)
2898                 return *enc;
2899         LYXERR0("Unknown inputenc value `" << inputenc
2900                << "'. Using `auto' instead.");
2901         return *language->encoding();
2902 }
2903
2904
2905 bool BufferParams::addCiteEngine(string const & engine)
2906 {
2907         LayoutModuleList::const_iterator it = cite_engine_.begin();
2908         LayoutModuleList::const_iterator en = cite_engine_.end();
2909         for (; it != en; ++it)
2910                 if (*it == engine)
2911                         return false;
2912         cite_engine_.push_back(engine);
2913         return true;
2914 }
2915
2916
2917 bool BufferParams::addCiteEngine(vector<string> const & engine)
2918 {
2919         vector<string>::const_iterator it = engine.begin();
2920         vector<string>::const_iterator en = engine.end();
2921         bool ret = true;
2922         for (; it != en; ++it)
2923                 if (!addCiteEngine(*it))
2924                         ret = false;
2925         return ret;
2926 }
2927
2928
2929 string const & BufferParams::defaultBiblioStyle() const
2930 {
2931         return documentClass().defaultBiblioStyle();
2932 }
2933
2934
2935 bool const & BufferParams::fullAuthorList() const
2936 {
2937         return documentClass().fullAuthorList();
2938 }
2939
2940
2941 void BufferParams::setCiteEngine(string const & engine)
2942 {
2943         clearCiteEngine();
2944         addCiteEngine(engine);
2945 }
2946
2947
2948 void BufferParams::setCiteEngine(vector<string> const & engine)
2949 {
2950         clearCiteEngine();
2951         addCiteEngine(engine);
2952 }
2953
2954
2955 vector<string> BufferParams::citeCommands() const
2956 {
2957         static CitationStyle const default_style;
2958         vector<string> commands =
2959                 documentClass().citeCommands(citeEngineType());
2960         if (commands.empty())
2961                 commands.push_back(default_style.cmd);
2962         return commands;
2963 }
2964
2965
2966 vector<CitationStyle> BufferParams::citeStyles() const
2967 {
2968         static CitationStyle const default_style;
2969         vector<CitationStyle> styles =
2970                 documentClass().citeStyles(citeEngineType());
2971         if (styles.empty())
2972                 styles.push_back(default_style);
2973         return styles;
2974 }
2975
2976 } // namespace lyx