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 (!language->requires().empty())
1263                 features.require(language->requires());
1264 }
1265
1266
1267 bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
1268                               FileName const & filepath) const
1269 {
1270         // http://www.tug.org/texmf-dist/doc/latex/base/fixltx2e.pdf
1271         // !! To use the Fix-cm package, load it before \documentclass, and use the command
1272         // \RequirePackage to do so, rather than the normal \usepackage
1273         // Do not try to load any other package before the document class, unless you
1274         // have a thorough understanding of the LATEX internals and know exactly what you
1275         // are doing!
1276         if (features.mustProvide("fix-cm"))
1277                 os << "\\RequirePackage{fix-cm}\n";
1278
1279         os << "\\documentclass";
1280
1281         DocumentClass const & tclass = documentClass();
1282
1283         ostringstream clsoptions; // the document class options.
1284
1285         if (tokenPos(tclass.opt_fontsize(),
1286                      '|', fontsize) >= 0) {
1287                 // only write if existing in list (and not default)
1288                 clsoptions << fontsize << "pt,";
1289         }
1290
1291         // all paper sizes except of A4, A5, B5 and the US sizes need the
1292         // geometry package
1293         bool nonstandard_papersize = papersize != PAPER_DEFAULT
1294                 && papersize != PAPER_USLETTER
1295                 && papersize != PAPER_USLEGAL
1296                 && papersize != PAPER_USEXECUTIVE
1297                 && papersize != PAPER_A4
1298                 && papersize != PAPER_A5
1299                 && papersize != PAPER_B5;
1300
1301         if (!use_geometry) {
1302                 switch (papersize) {
1303                 case PAPER_A4:
1304                         clsoptions << "a4paper,";
1305                         break;
1306                 case PAPER_USLETTER:
1307                         clsoptions << "letterpaper,";
1308                         break;
1309                 case PAPER_A5:
1310                         clsoptions << "a5paper,";
1311                         break;
1312                 case PAPER_B5:
1313                         clsoptions << "b5paper,";
1314                         break;
1315                 case PAPER_USEXECUTIVE:
1316                         clsoptions << "executivepaper,";
1317                         break;
1318                 case PAPER_USLEGAL:
1319                         clsoptions << "legalpaper,";
1320                         break;
1321                 case PAPER_DEFAULT:
1322                 case PAPER_A0:
1323                 case PAPER_A1:
1324                 case PAPER_A2:
1325                 case PAPER_A3:
1326                 case PAPER_A6:
1327                 case PAPER_B0:
1328                 case PAPER_B1:
1329                 case PAPER_B2:
1330                 case PAPER_B3:
1331                 case PAPER_B4:
1332                 case PAPER_B6:
1333                 case PAPER_C0:
1334                 case PAPER_C1:
1335                 case PAPER_C2:
1336                 case PAPER_C3:
1337                 case PAPER_C4:
1338                 case PAPER_C5:
1339                 case PAPER_C6:
1340                 case PAPER_JISB0:
1341                 case PAPER_JISB1:
1342                 case PAPER_JISB2:
1343                 case PAPER_JISB3:
1344                 case PAPER_JISB4:
1345                 case PAPER_JISB5:
1346                 case PAPER_JISB6:
1347                 case PAPER_CUSTOM:
1348                         break;
1349                 }
1350         }
1351
1352         // if needed
1353         if (sides != tclass.sides()) {
1354                 switch (sides) {
1355                 case OneSide:
1356                         clsoptions << "oneside,";
1357                         break;
1358                 case TwoSides:
1359                         clsoptions << "twoside,";
1360                         break;
1361                 }
1362         }
1363
1364         // if needed
1365         if (columns != tclass.columns()) {
1366                 if (columns == 2)
1367                         clsoptions << "twocolumn,";
1368                 else
1369                         clsoptions << "onecolumn,";
1370         }
1371
1372         if (!use_geometry
1373             && orientation == ORIENTATION_LANDSCAPE)
1374                 clsoptions << "landscape,";
1375
1376         // language should be a parameter to \documentclass
1377         if (language->babel() == "hebrew"
1378             && default_language->babel() != "hebrew")
1379                 // This seems necessary
1380                 features.useLanguage(default_language);
1381
1382         ostringstream language_options;
1383         bool const use_babel = features.useBabel() && !features.isProvided("babel");
1384         bool const use_polyglossia = features.usePolyglossia();
1385         bool const global = lyxrc.language_global_options;
1386         if (use_babel || (use_polyglossia && global)) {
1387                 language_options << features.getBabelLanguages();
1388                 if (!language->babel().empty()) {
1389                         if (!language_options.str().empty())
1390                                 language_options << ',';
1391                         language_options << language->babel();
1392                 }
1393                 if (global && !features.needBabelLangOptions()
1394                     && !language_options.str().empty())
1395                         clsoptions << language_options.str() << ',';
1396         }
1397
1398         // the predefined options from the layout
1399         if (use_default_options && !tclass.options().empty())
1400                 clsoptions << tclass.options() << ',';
1401
1402         // the user-defined options
1403         if (!options.empty()) {
1404                 clsoptions << options << ',';
1405         }
1406
1407         string strOptions(clsoptions.str());
1408         if (!strOptions.empty()) {
1409                 strOptions = rtrim(strOptions, ",");
1410                 // FIXME UNICODE
1411                 os << '[' << from_utf8(strOptions) << ']';
1412         }
1413
1414         os << '{' << from_ascii(tclass.latexname()) << "}\n";
1415         // end of \documentclass defs
1416
1417         // if we use fontspec, we have to load the AMS packages here
1418         string const ams = features.loadAMSPackages();
1419         if (useNonTeXFonts && !ams.empty())
1420                 os << from_ascii(ams);
1421
1422         if (useNonTeXFonts)
1423                 os << "\\usepackage{fontspec}\n";
1424
1425         // font selection must be done before loading fontenc.sty
1426         string const fonts = loadFonts(features);
1427         if (!fonts.empty())
1428                 os << from_utf8(fonts);
1429
1430         if (fonts_default_family != "default")
1431                 os << "\\renewcommand{\\familydefault}{\\"
1432                    << from_ascii(fonts_default_family) << "}\n";
1433
1434         // set font encoding
1435         // for arabic_arabi and farsi we also need to load the LAE and
1436         // LFE encoding
1437         // XeTeX and LuaTeX (with OS fonts) work without fontenc
1438         if (font_encoding() != "default" && language->lang() != "japanese"
1439             && !useNonTeXFonts && !features.isProvided("fontenc")) {
1440                 size_t fars = language_options.str().find("farsi");
1441                 size_t arab = language_options.str().find("arabic");
1442                 if (language->lang() == "arabic_arabi"
1443                         || language->lang() == "farsi" || fars != string::npos
1444                         || arab != string::npos) {
1445                         os << "\\usepackage[" << from_ascii(font_encoding())
1446                            << ",LFE,LAE]{fontenc}\n";
1447                 } else {
1448                         os << "\\usepackage[" << from_ascii(font_encoding())
1449                            << "]{fontenc}\n";
1450                 }
1451         }
1452
1453         // handle inputenc etc.
1454         writeEncodingPreamble(os, features);
1455
1456         // includeonly
1457         if (!features.runparams().includeall && !included_children_.empty()) {
1458                 os << "\\includeonly{";
1459                 list<string>::const_iterator it = included_children_.begin();
1460                 list<string>::const_iterator en = included_children_.end();
1461                 bool first = true;
1462                 for (; it != en; ++it) {
1463                         string incfile = *it;
1464                         FileName inc = makeAbsPath(incfile, filepath.absFileName());
1465                         string mangled = DocFileName(changeExtension(inc.absFileName(), ".tex")).
1466                         mangledFileName();
1467                         if (!features.runparams().nice)
1468                                 incfile = mangled;
1469                         // \includeonly doesn't want an extension
1470                         incfile = changeExtension(incfile, string());
1471                         incfile = support::latex_path(incfile);
1472                         if (!incfile.empty()) {
1473                                 if (!first)
1474                                         os << ",";
1475                                 os << from_utf8(incfile);
1476                         }
1477                         first = false;
1478                 }
1479                 os << "}\n";
1480         }
1481
1482         if (!listings_params.empty() || features.isRequired("listings"))
1483                 os << "\\usepackage{listings}\n";
1484
1485         if (!listings_params.empty()) {
1486                 os << "\\lstset{";
1487                 // do not test validity because listings_params is
1488                 // supposed to be valid
1489                 string par =
1490                         InsetListingsParams(listings_params).separatedParams(true);
1491                 // we can't support all packages, but we should load the color package
1492                 if (par.find("\\color", 0) != string::npos)
1493                         features.require("color");
1494                 os << from_utf8(par)
1495                    << "}\n";
1496         }
1497         if (!features.isProvided("geometry")
1498             && (use_geometry || nonstandard_papersize)) {
1499                 odocstringstream ods;
1500                 if (!getGraphicsDriver("geometry").empty())
1501                         ods << getGraphicsDriver("geometry");
1502                 if (orientation == ORIENTATION_LANDSCAPE)
1503                         ods << ",landscape";
1504                 switch (papersize) {
1505                 case PAPER_CUSTOM:
1506                         if (!paperwidth.empty())
1507                                 ods << ",paperwidth="
1508                                    << from_ascii(paperwidth);
1509                         if (!paperheight.empty())
1510                                 ods << ",paperheight="
1511                                    << from_ascii(paperheight);
1512                         break;
1513                 case PAPER_USLETTER:
1514                         ods << ",letterpaper";
1515                         break;
1516                 case PAPER_USLEGAL:
1517                         ods << ",legalpaper";
1518                         break;
1519                 case PAPER_USEXECUTIVE:
1520                         ods << ",executivepaper";
1521                         break;
1522                 case PAPER_A0:
1523                         ods << ",a0paper";
1524                         break;
1525                 case PAPER_A1:
1526                         ods << ",a1paper";
1527                         break;
1528                 case PAPER_A2:
1529                         ods << ",a2paper";
1530                         break;
1531                 case PAPER_A3:
1532                         ods << ",a3paper";
1533                         break;
1534                 case PAPER_A4:
1535                         ods << ",a4paper";
1536                         break;
1537                 case PAPER_A5:
1538                         ods << ",a5paper";
1539                         break;
1540                 case PAPER_A6:
1541                         ods << ",a6paper";
1542                         break;
1543                 case PAPER_B0:
1544                         ods << ",b0paper";
1545                         break;
1546                 case PAPER_B1:
1547                         ods << ",b1paper";
1548                         break;
1549                 case PAPER_B2:
1550                         ods << ",b2paper";
1551                         break;
1552                 case PAPER_B3:
1553                         ods << ",b3paper";
1554                         break;
1555                 case PAPER_B4:
1556                         ods << ",b4paper";
1557                         break;
1558                 case PAPER_B5:
1559                         ods << ",b5paper";
1560                         break;
1561                 case PAPER_B6:
1562                         ods << ",b6paper";
1563                         break;
1564                 case PAPER_C0:
1565                         ods << ",c0paper";
1566                         break;
1567                 case PAPER_C1:
1568                         ods << ",c1paper";
1569                         break;
1570                 case PAPER_C2:
1571                         ods << ",c2paper";
1572                         break;
1573                 case PAPER_C3:
1574                         ods << ",c3paper";
1575                         break;
1576                 case PAPER_C4:
1577                         ods << ",c4paper";
1578                         break;
1579                 case PAPER_C5:
1580                         ods << ",c5paper";
1581                         break;
1582                 case PAPER_C6:
1583                         ods << ",c6paper";
1584                         break;
1585                 case PAPER_JISB0:
1586                         ods << ",b0j";
1587                         break;
1588                 case PAPER_JISB1:
1589                         ods << ",b1j";
1590                         break;
1591                 case PAPER_JISB2:
1592                         ods << ",b2j";
1593                         break;
1594                 case PAPER_JISB3:
1595                         ods << ",b3j";
1596                         break;
1597                 case PAPER_JISB4:
1598                         ods << ",b4j";
1599                         break;
1600                 case PAPER_JISB5:
1601                         ods << ",b5j";
1602                         break;
1603                 case PAPER_JISB6:
1604                         ods << ",b6j";
1605                         break;
1606                 case PAPER_DEFAULT:
1607                         break;
1608                 }
1609                 docstring const g_options = trim(ods.str(), ",");
1610                 os << "\\usepackage";
1611                 if (!g_options.empty())
1612                         os << '[' << g_options << ']';
1613                 os << "{geometry}\n";
1614                 // output this only if use_geometry is true
1615                 if (use_geometry) {
1616                         os << "\\geometry{verbose";
1617                         if (!topmargin.empty())
1618                                 os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1619                         if (!bottommargin.empty())
1620                                 os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1621                         if (!leftmargin.empty())
1622                                 os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1623                         if (!rightmargin.empty())
1624                                 os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1625                         if (!headheight.empty())
1626                                 os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1627                         if (!headsep.empty())
1628                                 os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1629                         if (!footskip.empty())
1630                                 os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1631                         if (!columnsep.empty())
1632                                 os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
1633                         os << "}\n";
1634                 }
1635         } else if (orientation == ORIENTATION_LANDSCAPE
1636                    || papersize != PAPER_DEFAULT) {
1637                 features.require("papersize");
1638         }
1639
1640         if (tokenPos(tclass.opt_pagestyle(), '|', pagestyle) >= 0) {
1641                 if (pagestyle == "fancy")
1642                         os << "\\usepackage{fancyhdr}\n";
1643                 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1644         }
1645
1646         // only output when the background color is not default
1647         if (isbackgroundcolor == true) {
1648                 // only require color here, the background color will be defined
1649                 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1650                 // package pdfpages
1651                 features.require("color");
1652                 features.require("pagecolor");
1653         }
1654
1655         // only output when the font color is not default
1656         if (isfontcolor == true) {
1657                 // only require color here, the font color will be defined
1658                 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1659                 // package pdfpages
1660                 features.require("color");
1661                 features.require("fontcolor");
1662         }
1663
1664         // Only if class has a ToC hierarchy
1665         if (tclass.hasTocLevels()) {
1666                 if (secnumdepth != tclass.secnumdepth()) {
1667                         os << "\\setcounter{secnumdepth}{"
1668                            << secnumdepth
1669                            << "}\n";
1670                 }
1671                 if (tocdepth != tclass.tocdepth()) {
1672                         os << "\\setcounter{tocdepth}{"
1673                            << tocdepth
1674                            << "}\n";
1675                 }
1676         }
1677
1678         if (paragraph_separation) {
1679                 // when skip separation
1680                 switch (getDefSkip().kind()) {
1681                 case VSpace::SMALLSKIP:
1682                         os << "\\setlength{\\parskip}{\\smallskipamount}\n";
1683                         break;
1684                 case VSpace::MEDSKIP:
1685                         os << "\\setlength{\\parskip}{\\medskipamount}\n";
1686                         break;
1687                 case VSpace::BIGSKIP:
1688                         os << "\\setlength{\\parskip}{\\bigskipamount}\n";
1689                         break;
1690                 case VSpace::LENGTH:
1691                         os << "\\setlength{\\parskip}{"
1692                            << from_utf8(getDefSkip().length().asLatexString())
1693                            << "}\n";
1694                         break;
1695                 default: // should never happen // Then delete it.
1696                         os << "\\setlength{\\parskip}{\\medskipamount}\n";
1697                         break;
1698                 }
1699                 os << "\\setlength{\\parindent}{0pt}\n";
1700         } else {
1701                 // when separation by indentation
1702                 // only output something when a width is given
1703                 if (getIndentation().asLyXCommand() != "default") {
1704                         os << "\\setlength{\\parindent}{"
1705                            << from_utf8(getIndentation().asLatexCommand())
1706                            << "}\n";
1707                 }
1708         }
1709
1710         // Now insert the LyX specific LaTeX commands...
1711         docstring lyxpreamble;
1712         features.resolveAlternatives();
1713
1714         if (output_sync) {
1715                 if (!output_sync_macro.empty())
1716                         lyxpreamble += from_utf8(output_sync_macro) +"\n";
1717                 else if (features.runparams().flavor == OutputParams::LATEX)
1718                         lyxpreamble += "\\usepackage[active]{srcltx}\n";
1719                 else if (features.runparams().flavor == OutputParams::PDFLATEX)
1720                         lyxpreamble += "\\synctex=-1\n";
1721         }
1722
1723         // due to interferences with babel and hyperref, the color package has to
1724         // be loaded (when it is not already loaded) before babel when hyperref
1725         // is used with the colorlinks option, see
1726         // http://www.lyx.org/trac/ticket/5291
1727         // we decided therefore to load color always before babel, see
1728         // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
1729         lyxpreamble += from_ascii(features.getColorOptions());
1730
1731         // If we use hyperref, jurabib, japanese, or vietnamese, we have to call babel before them.
1732         if (use_babel
1733             && (features.isRequired("jurabib")
1734                 || features.isRequired("hyperref")
1735                 || features.isRequired("vietnamese")
1736                 || features.isRequired("japanese"))) {
1737                         // FIXME UNICODE
1738                         lyxpreamble += from_utf8(features.getBabelPresettings());
1739                         lyxpreamble += from_utf8(babelCall(language_options.str(),
1740                                                            features.needBabelLangOptions())) + '\n';
1741                         lyxpreamble += from_utf8(features.getBabelPostsettings());
1742         }
1743
1744         // The optional packages;
1745         lyxpreamble += from_ascii(features.getPackages());
1746
1747         // Additional Indices
1748         if (features.isRequired("splitidx")) {
1749                 IndicesList::const_iterator iit = indiceslist().begin();
1750                 IndicesList::const_iterator iend = indiceslist().end();
1751                 for (; iit != iend; ++iit) {
1752                         pair<docstring, docstring> indexname_latex =
1753                                 features.runparams().encoding->latexString(iit->index(),
1754                                                                            features.runparams().dryrun);
1755                         if (!indexname_latex.second.empty()) {
1756                                 // issue a warning about omitted characters
1757                                 // FIXME: should be passed to the error dialog
1758                                 frontend::Alert::warning(_("Uncodable characters"),
1759                                         bformat(_("The following characters that are used in an index name are not\n"
1760                                                   "representable in the current encoding and therefore have been omitted:\n%1$s."),
1761                                                 indexname_latex.second));
1762                         }
1763                         lyxpreamble += "\\newindex[";
1764                         lyxpreamble += indexname_latex.first;
1765                         lyxpreamble += "]{";
1766                         lyxpreamble += escape(iit->shortcut());
1767                         lyxpreamble += "}\n";
1768                 }
1769         }
1770
1771         // Line spacing
1772         lyxpreamble += from_utf8(spacing().writePreamble(features.isProvided("SetSpace")));
1773
1774         // PDF support.
1775         // * Hyperref manual: "Make sure it comes last of your loaded
1776         //   packages, to give it a fighting chance of not being over-written,
1777         //   since its job is to redefine many LaTeX commands."
1778         // * Email from Heiko Oberdiek: "It is usually better to load babel
1779         //   before hyperref. Then hyperref has a chance to detect babel.
1780         // * Has to be loaded before the "LyX specific LaTeX commands" to
1781         //   avoid errors with algorithm floats.
1782         // use hyperref explicitly if it is required
1783         if (features.isRequired("hyperref")) {
1784                 // pass what we have to stream here, since we need
1785                 // to access the stream itself in PDFOptions.
1786                 os << lyxpreamble;
1787
1788                 OutputParams tmp_params = features.runparams();
1789                 pdfoptions().writeLaTeX(tmp_params, os,
1790                                         features.isProvided("hyperref"));
1791                 // set back for the rest
1792                 lyxpreamble.clear();
1793                 // correctly break URLs with hyperref and dvi output
1794                 if (features.runparams().flavor == OutputParams::LATEX
1795                     && features.isAvailable("breakurl"))
1796                         lyxpreamble += "\\usepackage{breakurl}\n";
1797         } else if (features.isRequired("nameref"))
1798                 // hyperref loads this automatically
1799                 lyxpreamble += "\\usepackage{nameref}\n";
1800
1801         // bibtopic needs to be loaded after hyperref.
1802         // the dot provides the aux file naming which LyX can detect.
1803         if (features.mustProvide("bibtopic"))
1804                 lyxpreamble += "\\usepackage[dot]{bibtopic}\n";
1805
1806         // Will be surrounded by \makeatletter and \makeatother when not empty
1807         docstring atlyxpreamble;
1808
1809         // Some macros LyX will need
1810         docstring tmppreamble(features.getMacros());
1811
1812         if (!tmppreamble.empty())
1813                 atlyxpreamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1814                         "LyX specific LaTeX commands.\n"
1815                         + tmppreamble + '\n';
1816
1817         // the text class specific preamble
1818         tmppreamble = features.getTClassPreamble();
1819         if (!tmppreamble.empty())
1820                 atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1821                         "Textclass specific LaTeX commands.\n"
1822                         + tmppreamble + '\n';
1823
1824         // suppress date if selected
1825         // use \@ifundefined because we cannot be sure that every document class
1826         // has a \date command
1827         if (suppress_date)
1828                 atlyxpreamble += "\\@ifundefined{date}{}{\\date{}}\n";
1829
1830         /* the user-defined preamble */
1831         if (!containsOnly(preamble, " \n\t"))
1832                 // FIXME UNICODE
1833                 atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1834                         "User specified LaTeX commands.\n"
1835                         + from_utf8(preamble) + '\n';
1836
1837         // subfig loads internally the LaTeX package "caption". As
1838         // caption is a very popular package, users will load it in
1839         // the preamble. Therefore we must load subfig behind the
1840         // user-defined preamble and check if the caption package was
1841         // loaded or not. For the case that caption is loaded before
1842         // subfig, there is the subfig option "caption=false". This
1843         // option also works when a koma-script class is used and
1844         // koma's own caption commands are used instead of caption. We
1845         // use \PassOptionsToPackage here because the user could have
1846         // already loaded subfig in the preamble.
1847         if (features.isRequired("subfig")) {
1848                 atlyxpreamble += "\\@ifundefined{showcaptionsetup}{}{%\n"
1849                         " \\PassOptionsToPackage{caption=false}{subfig}}\n"
1850                         "\\usepackage{subfig}\n";
1851         }
1852
1853         // Itemize bullet settings need to be last in case the user
1854         // defines their own bullets that use a package included
1855         // in the user-defined preamble -- ARRae
1856         // Actually it has to be done much later than that
1857         // since some packages like frenchb make modifications
1858         // at \begin{document} time -- JMarc
1859         docstring bullets_def;
1860         for (int i = 0; i < 4; ++i) {
1861                 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1862                         if (bullets_def.empty())
1863                                 bullets_def += "\\AtBeginDocument{\n";
1864                         bullets_def += "  \\def\\labelitemi";
1865                         switch (i) {
1866                                 // `i' is one less than the item to modify
1867                         case 0:
1868                                 break;
1869                         case 1:
1870                                 bullets_def += 'i';
1871                                 break;
1872                         case 2:
1873                                 bullets_def += "ii";
1874                                 break;
1875                         case 3:
1876                                 bullets_def += 'v';
1877                                 break;
1878                         }
1879                         bullets_def += '{' +
1880                                 user_defined_bullet(i).getText()
1881                                 + "}\n";
1882                 }
1883         }
1884
1885         if (!bullets_def.empty())
1886                 atlyxpreamble += bullets_def + "}\n\n";
1887
1888         if (!atlyxpreamble.empty())
1889                 lyxpreamble += "\n\\makeatletter\n"
1890                         + atlyxpreamble + "\\makeatother\n\n";
1891
1892         // We try to load babel late, in case it interferes with other packages.
1893         // Jurabib and Hyperref have to be called after babel, though.
1894         if (use_babel && !features.isRequired("jurabib")
1895             && !features.isRequired("hyperref")
1896             && !features.isRequired("vietnamese")
1897             && !features.isRequired("japanese")) {
1898                 // FIXME UNICODE
1899                 lyxpreamble += from_utf8(features.getBabelPresettings());
1900                 lyxpreamble += from_utf8(babelCall(language_options.str(),
1901                                                    features.needBabelLangOptions())) + '\n';
1902                 lyxpreamble += from_utf8(features.getBabelPostsettings());
1903         }
1904
1905         // xunicode needs to be loaded at least after amsmath, amssymb,
1906         // esint and the other packages that provide special glyphs
1907         if (features.runparams().flavor == OutputParams::XETEX)
1908                 lyxpreamble += "\\usepackage{xunicode}\n";
1909
1910         // Polyglossia must be loaded last
1911         if (use_polyglossia) {
1912                 // call the package
1913                 lyxpreamble += "\\usepackage{polyglossia}\n";
1914                 // set the main language
1915                 lyxpreamble += "\\setdefaultlanguage";
1916                 if (!language->polyglossiaOpts().empty())
1917                         lyxpreamble += "[" + from_ascii(language->polyglossiaOpts()) + "]";
1918                 lyxpreamble += "{" + from_ascii(language->polyglossia()) + "}\n";
1919                 // now setup the other languages
1920                 std::map<std::string, std::string> const polylangs =
1921                         features.getPolyglossiaLanguages();
1922                 for (std::map<std::string, std::string>::const_iterator mit = polylangs.begin();
1923                      mit != polylangs.end() ; ++mit) {
1924                         lyxpreamble += "\\setotherlanguage";
1925                         if (!mit->second.empty())
1926                                 lyxpreamble += "[" + from_ascii(mit->second) + "]";
1927                         lyxpreamble += "{" + from_ascii(mit->first) + "}\n";
1928                 }
1929         }
1930
1931         // Load custom language package here
1932         if (features.langPackage() == LaTeXFeatures::LANG_PACK_CUSTOM) {
1933                 if (lang_package == "default")
1934                         lyxpreamble += from_utf8(lyxrc.language_custom_package);
1935                 else
1936                         lyxpreamble += from_utf8(lang_package);
1937                 lyxpreamble += '\n';
1938         }
1939
1940         docstring const i18npreamble =
1941                 features.getTClassI18nPreamble(use_babel, use_polyglossia);
1942         if (!i18npreamble.empty())
1943                 lyxpreamble += i18npreamble + '\n';
1944
1945         os << lyxpreamble;
1946
1947         return use_babel;
1948 }
1949
1950
1951 void BufferParams::useClassDefaults()
1952 {
1953         DocumentClass const & tclass = documentClass();
1954
1955         sides = tclass.sides();
1956         columns = tclass.columns();
1957         pagestyle = tclass.pagestyle();
1958         use_default_options = true;
1959         // Only if class has a ToC hierarchy
1960         if (tclass.hasTocLevels()) {
1961                 secnumdepth = tclass.secnumdepth();
1962                 tocdepth = tclass.tocdepth();
1963         }
1964 }
1965
1966
1967 bool BufferParams::hasClassDefaults() const
1968 {
1969         DocumentClass const & tclass = documentClass();
1970
1971         return sides == tclass.sides()
1972                 && columns == tclass.columns()
1973                 && pagestyle == tclass.pagestyle()
1974                 && use_default_options
1975                 && secnumdepth == tclass.secnumdepth()
1976                 && tocdepth == tclass.tocdepth();
1977 }
1978
1979
1980 DocumentClass const & BufferParams::documentClass() const
1981 {
1982         return *doc_class_.get();
1983 }
1984
1985
1986 DocumentClassConstPtr BufferParams::documentClassPtr() const
1987 {
1988         return doc_class_;
1989 }
1990
1991
1992 void BufferParams::setDocumentClass(DocumentClassConstPtr tc)
1993 {
1994         // evil, but this function is evil
1995         doc_class_ = const_pointer_cast<DocumentClass>(tc);
1996 }
1997
1998
1999 bool BufferParams::setBaseClass(string const & classname)
2000 {
2001         LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
2002         LayoutFileList & bcl = LayoutFileList::get();
2003         if (!bcl.haveClass(classname)) {
2004                 docstring s =
2005                         bformat(_("The layout file:\n"
2006                                 "%1$s\n"
2007                                 "could not be found. A default textclass with default\n"
2008                                 "layouts will be used. LyX will not be able to produce\n"
2009                                 "correct output."),
2010                         from_utf8(classname));
2011                 frontend::Alert::error(_("Document class not found"), s);
2012                 bcl.addEmptyClass(classname);
2013         }
2014
2015         bool const success = bcl[classname].load();
2016         if (!success) {
2017                 docstring s =
2018                         bformat(_("Due to some error in it, the layout file:\n"
2019                                 "%1$s\n"
2020                                 "could not be loaded. A default textclass with default\n"
2021                                 "layouts will be used. LyX will not be able to produce\n"
2022                                 "correct output."),
2023                         from_utf8(classname));
2024                 frontend::Alert::error(_("Could not load class"), s);
2025                 bcl.addEmptyClass(classname);
2026         }
2027
2028         pimpl_->baseClass_ = classname;
2029         layout_modules_.adaptToBaseClass(baseClass(), removed_modules_);
2030         return true;
2031 }
2032
2033
2034 LayoutFile const * BufferParams::baseClass() const
2035 {
2036         if (LayoutFileList::get().haveClass(pimpl_->baseClass_))
2037                 return &(LayoutFileList::get()[pimpl_->baseClass_]);
2038         else
2039                 return 0;
2040 }
2041
2042
2043 LayoutFileIndex const & BufferParams::baseClassID() const
2044 {
2045         return pimpl_->baseClass_;
2046 }
2047
2048
2049 void BufferParams::makeDocumentClass()
2050 {
2051         if (!baseClass())
2052                 return;
2053
2054         LayoutModuleList mods;
2055         LayoutModuleList::iterator it;
2056         LayoutModuleList::iterator en;
2057
2058         it = layout_modules_.begin();
2059         en = layout_modules_.end();
2060         for (; it != en; ++it)
2061                 mods.push_back(*it);
2062         it = cite_engine_.begin();
2063         en = cite_engine_.end();
2064         for (; it != en; ++it)
2065                 mods.push_back(*it);
2066         doc_class_ = getDocumentClass(*baseClass(), mods);
2067
2068         if (!local_layout.empty()) {
2069                 TextClass::ReturnValues success =
2070                         doc_class_->read(local_layout, TextClass::MODULE);
2071                 if (success != TextClass::OK && success != TextClass::OK_OLDFORMAT) {
2072                         docstring const msg = _("Error reading internal layout information");
2073                         frontend::Alert::warning(_("Read Error"), msg);
2074                 }
2075         }
2076 }
2077
2078
2079 bool BufferParams::moduleCanBeAdded(string const & modName) const
2080 {
2081         return cite_engine_.moduleCanBeAdded(modName, baseClass()) &&
2082                 layout_modules_.moduleCanBeAdded(modName, baseClass());
2083 }
2084
2085
2086 bool BufferParams::addLayoutModule(string const & modName)
2087 {
2088         LayoutModuleList::const_iterator it = layout_modules_.begin();
2089         LayoutModuleList::const_iterator end = layout_modules_.end();
2090         for (; it != end; ++it)
2091                 if (*it == modName)
2092                         return false;
2093         layout_modules_.push_back(modName);
2094         return true;
2095 }
2096
2097
2098 string BufferParams::bufferFormat() const
2099 {
2100         string format = documentClass().outputFormat();
2101         if (format == "latex") {
2102                 if (useNonTeXFonts)
2103                         return "xetex";
2104                 if (encoding().package() == Encoding::japanese)
2105                         return "platex";
2106         }
2107         return format;
2108 }
2109
2110
2111 bool BufferParams::isExportable(string const & format) const
2112 {
2113         vector<string> backs = backends();
2114         for (vector<string>::const_iterator it = backs.begin();
2115              it != backs.end(); ++it)
2116                 if (theConverters().isReachable(*it, format))
2117                         return true;
2118         return false;
2119 }
2120
2121
2122 namespace {
2123 bool formatSorter(Format const * lhs, Format const * rhs) {
2124         return _(lhs->prettyname()) < _(rhs->prettyname());
2125 }
2126 }
2127
2128
2129 vector<Format const *> BufferParams::exportableFormats(bool only_viewable) const
2130 {
2131         vector<string> const backs = backends();
2132         set<string> excludes;
2133         if (useNonTeXFonts) {
2134                 excludes.insert("latex");
2135                 excludes.insert("pdflatex");
2136         }
2137         vector<Format const *> result =
2138                 theConverters().getReachable(backs[0], only_viewable, true, excludes);
2139         for (vector<string>::const_iterator it = backs.begin() + 1;
2140              it != backs.end(); ++it) {
2141                 vector<Format const *>  r =
2142                         theConverters().getReachable(*it, only_viewable, false, excludes);
2143                 result.insert(result.end(), r.begin(), r.end());
2144         }
2145         sort(result.begin(), result.end(), formatSorter);
2146         return result;
2147 }
2148
2149
2150 bool BufferParams::isExportableFormat(string const & format) const
2151 {
2152         typedef vector<Format const *> Formats;
2153         Formats formats;
2154         formats = exportableFormats(true);
2155         Formats::const_iterator fit = formats.begin();
2156         Formats::const_iterator end = formats.end();
2157         for (; fit != end ; ++fit) {
2158                 if ((*fit)->name() == format)
2159                         return true;
2160         }
2161         return false;
2162 }
2163
2164
2165 vector<string> BufferParams::backends() const
2166 {
2167         vector<string> v;
2168         string const buffmt = bufferFormat();
2169
2170         // FIXME: Don't hardcode format names here, but use a flag
2171         if (buffmt == "latex") {
2172                 if (!useNonTeXFonts) {
2173                         v.push_back("pdflatex");
2174                         v.push_back("latex");
2175                 }
2176                 v.push_back("luatex");
2177                 v.push_back("dviluatex");
2178                 v.push_back("xetex");
2179         } else if (buffmt == "xetex") {
2180                 v.push_back("xetex");
2181                 v.push_back("luatex");
2182                 v.push_back("dviluatex");
2183         } else
2184                 v.push_back(buffmt);
2185
2186         v.push_back("xhtml");
2187         v.push_back("text");
2188         v.push_back("lyx");
2189         return v;
2190 }
2191
2192
2193 OutputParams::FLAVOR BufferParams::getOutputFlavor(string const format) const
2194 {
2195         string const dformat = (format.empty() || format == "default") ?
2196                 getDefaultOutputFormat() : format;
2197         DefaultFlavorCache::const_iterator it =
2198                 default_flavors_.find(dformat);
2199
2200         if (it != default_flavors_.end())
2201                 return it->second;
2202
2203         OutputParams::FLAVOR result = OutputParams::LATEX;
2204
2205         // FIXME It'd be better not to hardcode this, but to do
2206         //       something with formats.
2207         if (dformat == "xhtml")
2208                 result = OutputParams::HTML;
2209         else if (dformat == "text")
2210                 result = OutputParams::TEXT;
2211         else if (dformat == "lyx")
2212                 result = OutputParams::LYX;
2213         else if (dformat == "pdflatex")
2214                 result = OutputParams::PDFLATEX;
2215         else if (dformat == "xetex")
2216                 result = OutputParams::XETEX;
2217         else if (dformat == "luatex")
2218                 result = OutputParams::LUATEX;
2219         else if (dformat == "dviluatex")
2220                 result = OutputParams::DVILUATEX;
2221         else {
2222                 // Try to determine flavor of default output format
2223                 vector<string> backs = backends();
2224                 if (find(backs.begin(), backs.end(), dformat) == backs.end()) {
2225                         // Get shortest path to format
2226                         Graph::EdgePath path;
2227                         for (vector<string>::const_iterator it = backs.begin();
2228                             it != backs.end(); ++it) {
2229                                 Graph::EdgePath p = theConverters().getPath(*it, dformat);
2230                                 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2231                                         path = p;
2232                                 }
2233                         }
2234                         if (!path.empty())
2235                                 result = theConverters().getFlavor(path);
2236                 }
2237         }
2238         // cache this flavor
2239         default_flavors_[dformat] = result;
2240         return result;
2241 }
2242
2243
2244 string BufferParams::getDefaultOutputFormat() const
2245 {
2246         if (!default_output_format.empty()
2247             && default_output_format != "default")
2248                 return default_output_format;
2249         if (isDocBook()
2250             || useNonTeXFonts
2251             || encoding().package() == Encoding::japanese) {
2252                 vector<Format const *> const formats = exportableFormats(true);
2253                 if (formats.empty())
2254                         return string();
2255                 // return the first we find
2256                 return formats.front()->name();
2257         }
2258         return lyxrc.default_view_format;
2259 }
2260
2261 Font const BufferParams::getFont() const
2262 {
2263         FontInfo f = documentClass().defaultfont();
2264         if (fonts_default_family == "rmdefault")
2265                 f.setFamily(ROMAN_FAMILY);
2266         else if (fonts_default_family == "sfdefault")
2267                 f.setFamily(SANS_FAMILY);
2268         else if (fonts_default_family == "ttdefault")
2269                 f.setFamily(TYPEWRITER_FAMILY);
2270         return Font(f, language);
2271 }
2272
2273
2274 InsetQuotes::QuoteLanguage BufferParams::getQuoteStyle(string const qs) const
2275 {
2276         return quoteslangtranslator().find(qs);
2277 }
2278
2279
2280 bool BufferParams::isLatex() const
2281 {
2282         return documentClass().outputType() == LATEX;
2283 }
2284
2285
2286 bool BufferParams::isLiterate() const
2287 {
2288         return documentClass().outputType() == LITERATE;
2289 }
2290
2291
2292 bool BufferParams::isDocBook() const
2293 {
2294         return documentClass().outputType() == DOCBOOK;
2295 }
2296
2297
2298 void BufferParams::readPreamble(Lexer & lex)
2299 {
2300         if (lex.getString() != "\\begin_preamble")
2301                 lyxerr << "Error (BufferParams::readPreamble):"
2302                         "consistency check failed." << endl;
2303
2304         preamble = lex.getLongString("\\end_preamble");
2305 }
2306
2307
2308 void BufferParams::readLocalLayout(Lexer & lex)
2309 {
2310         if (lex.getString() != "\\begin_local_layout")
2311                 lyxerr << "Error (BufferParams::readLocalLayout):"
2312                         "consistency check failed." << endl;
2313
2314         local_layout = lex.getLongString("\\end_local_layout");
2315 }
2316
2317
2318 bool BufferParams::setLanguage(string const & lang)
2319 {
2320         Language const *new_language = languages.getLanguage(lang);
2321         if (!new_language) {
2322                 // Language lang was not found
2323                 return false;
2324         }
2325         language = new_language;
2326         return true;
2327 }
2328
2329
2330 void BufferParams::readLanguage(Lexer & lex)
2331 {
2332         if (!lex.next()) return;
2333
2334         string const tmptok = lex.getString();
2335
2336         // check if tmptok is part of tex_babel in tex-defs.h
2337         if (!setLanguage(tmptok)) {
2338                 // Language tmptok was not found
2339                 language = default_language;
2340                 lyxerr << "Warning: Setting language `"
2341                        << tmptok << "' to `" << language->lang()
2342                        << "'." << endl;
2343         }
2344 }
2345
2346
2347 void BufferParams::readGraphicsDriver(Lexer & lex)
2348 {
2349         if (!lex.next())
2350                 return;
2351
2352         string const tmptok = lex.getString();
2353         // check if tmptok is part of tex_graphics in tex_defs.h
2354         int n = 0;
2355         while (true) {
2356                 string const test = tex_graphics[n++];
2357
2358                 if (test == tmptok) {
2359                         graphics_driver = tmptok;
2360                         break;
2361                 }
2362                 if (test.empty()) {
2363                         lex.printError(
2364                                 "Warning: graphics driver `$$Token' not recognized!\n"
2365                                 "         Setting graphics driver to `default'.\n");
2366                         graphics_driver = "default";
2367                         break;
2368                 }
2369         }
2370 }
2371
2372
2373 void BufferParams::readBullets(Lexer & lex)
2374 {
2375         if (!lex.next())
2376                 return;
2377
2378         int const index = lex.getInteger();
2379         lex.next();
2380         int temp_int = lex.getInteger();
2381         user_defined_bullet(index).setFont(temp_int);
2382         temp_bullet(index).setFont(temp_int);
2383         lex >> temp_int;
2384         user_defined_bullet(index).setCharacter(temp_int);
2385         temp_bullet(index).setCharacter(temp_int);
2386         lex >> temp_int;
2387         user_defined_bullet(index).setSize(temp_int);
2388         temp_bullet(index).setSize(temp_int);
2389 }
2390
2391
2392 void BufferParams::readBulletsLaTeX(Lexer & lex)
2393 {
2394         // The bullet class should be able to read this.
2395         if (!lex.next())
2396                 return;
2397         int const index = lex.getInteger();
2398         lex.next(true);
2399         docstring const temp_str = lex.getDocString();
2400
2401         user_defined_bullet(index).setText(temp_str);
2402         temp_bullet(index).setText(temp_str);
2403 }
2404
2405
2406 void BufferParams::readModules(Lexer & lex)
2407 {
2408         if (!lex.eatLine()) {
2409                 lyxerr << "Error (BufferParams::readModules):"
2410                                 "Unexpected end of input." << endl;
2411                 return;
2412         }
2413         while (true) {
2414                 string mod = lex.getString();
2415                 if (mod == "\\end_modules")
2416                         break;
2417                 addLayoutModule(mod);
2418                 lex.eatLine();
2419         }
2420 }
2421
2422
2423 void BufferParams::readRemovedModules(Lexer & lex)
2424 {
2425         if (!lex.eatLine()) {
2426                 lyxerr << "Error (BufferParams::readRemovedModules):"
2427                                 "Unexpected end of input." << endl;
2428                 return;
2429         }
2430         while (true) {
2431                 string mod = lex.getString();
2432                 if (mod == "\\end_removed_modules")
2433                         break;
2434                 removed_modules_.push_back(mod);
2435                 lex.eatLine();
2436         }
2437         // now we want to remove any removed modules that were previously
2438         // added. normally, that will be because default modules were added in
2439         // setBaseClass(), which gets called when \textclass is read at the
2440         // start of the read.
2441         list<string>::const_iterator rit = removed_modules_.begin();
2442         list<string>::const_iterator const ren = removed_modules_.end();
2443         for (; rit != ren; ++rit) {
2444                 LayoutModuleList::iterator const mit = layout_modules_.begin();
2445                 LayoutModuleList::iterator const men = layout_modules_.end();
2446                 LayoutModuleList::iterator found = find(mit, men, *rit);
2447                 if (found == men)
2448                         continue;
2449                 layout_modules_.erase(found);
2450         }
2451 }
2452
2453
2454 void BufferParams::readIncludeonly(Lexer & lex)
2455 {
2456         if (!lex.eatLine()) {
2457                 lyxerr << "Error (BufferParams::readIncludeonly):"
2458                                 "Unexpected end of input." << endl;
2459                 return;
2460         }
2461         while (true) {
2462                 string child = lex.getString();
2463                 if (child == "\\end_includeonly")
2464                         break;
2465                 included_children_.push_back(child);
2466                 lex.eatLine();
2467         }
2468 }
2469
2470
2471 string BufferParams::paperSizeName(PapersizePurpose purpose) const
2472 {
2473         switch (papersize) {
2474         case PAPER_DEFAULT:
2475                 // could be anything, so don't guess
2476                 return string();
2477         case PAPER_CUSTOM: {
2478                 if (purpose == XDVI && !paperwidth.empty() &&
2479                     !paperheight.empty()) {
2480                         // heightxwidth<unit>
2481                         string first = paperwidth;
2482                         string second = paperheight;
2483                         if (orientation == ORIENTATION_LANDSCAPE)
2484                                 first.swap(second);
2485                         // cut off unit.
2486                         return first.erase(first.length() - 2)
2487                                 + "x" + second;
2488                 }
2489                 return string();
2490         }
2491         case PAPER_A0:
2492                 // dvips and dvipdfm do not know this
2493                 if (purpose == DVIPS || purpose == DVIPDFM)
2494                         return string();
2495                 return "a0";
2496         case PAPER_A1:
2497                 if (purpose == DVIPS || purpose == DVIPDFM)
2498                         return string();
2499                 return "a1";
2500         case PAPER_A2:
2501                 if (purpose == DVIPS || purpose == DVIPDFM)
2502                         return string();
2503                 return "a2";
2504         case PAPER_A3:
2505                 return "a3";
2506         case PAPER_A4:
2507                 return "a4";
2508         case PAPER_A5:
2509                 return "a5";
2510         case PAPER_A6:
2511                 if (purpose == DVIPS || purpose == DVIPDFM)
2512                         return string();
2513                 return "a6";
2514         case PAPER_B0:
2515                 if (purpose == DVIPS || purpose == DVIPDFM)
2516                         return string();
2517                 return "b0";
2518         case PAPER_B1:
2519                 if (purpose == DVIPS || purpose == DVIPDFM)
2520                         return string();
2521                 return "b1";
2522         case PAPER_B2:
2523                 if (purpose == DVIPS || purpose == DVIPDFM)
2524                         return string();
2525                 return "b2";
2526         case PAPER_B3:
2527                 if (purpose == DVIPS || purpose == DVIPDFM)
2528                         return string();
2529                 return "b3";
2530         case PAPER_B4:
2531                 // dvipdfm does not know this
2532                 if (purpose == DVIPDFM)
2533                         return string();
2534                 return "b4";
2535         case PAPER_B5:
2536                 if (purpose == DVIPDFM)
2537                         return string();
2538                 return "b5";
2539         case PAPER_B6:
2540                 if (purpose == DVIPS || purpose == DVIPDFM)
2541                         return string();
2542                 return "b6";
2543         case PAPER_C0:
2544                 if (purpose == DVIPS || purpose == DVIPDFM)
2545                         return string();
2546                 return "c0";
2547         case PAPER_C1:
2548                 if (purpose == DVIPS || purpose == DVIPDFM)
2549                         return string();
2550                 return "c1";
2551         case PAPER_C2:
2552                 if (purpose == DVIPS || purpose == DVIPDFM)
2553                         return string();
2554                 return "c2";
2555         case PAPER_C3:
2556                 if (purpose == DVIPS || purpose == DVIPDFM)
2557                         return string();
2558                 return "c3";
2559         case PAPER_C4:
2560                 if (purpose == DVIPS || purpose == DVIPDFM)
2561                         return string();
2562                 return "c4";
2563         case PAPER_C5:
2564                 if (purpose == DVIPS || purpose == DVIPDFM)
2565                         return string();
2566                 return "c5";
2567         case PAPER_C6:
2568                 if (purpose == DVIPS || purpose == DVIPDFM)
2569                         return string();
2570                 return "c6";
2571         case PAPER_JISB0:
2572                 if (purpose == DVIPS || purpose == DVIPDFM)
2573                         return string();
2574                 return "jisb0";
2575         case PAPER_JISB1:
2576                 if (purpose == DVIPS || purpose == DVIPDFM)
2577                         return string();
2578                 return "jisb1";
2579         case PAPER_JISB2:
2580                 if (purpose == DVIPS || purpose == DVIPDFM)
2581                         return string();
2582                 return "jisb2";
2583         case PAPER_JISB3:
2584                 if (purpose == DVIPS || purpose == DVIPDFM)
2585                         return string();
2586                 return "jisb3";
2587         case PAPER_JISB4:
2588                 if (purpose == DVIPS || purpose == DVIPDFM)
2589                         return string();
2590                 return "jisb4";
2591         case PAPER_JISB5:
2592                 if (purpose == DVIPS || purpose == DVIPDFM)
2593                         return string();
2594                 return "jisb5";
2595         case PAPER_JISB6:
2596                 if (purpose == DVIPS || purpose == DVIPDFM)
2597                         return string();
2598                 return "jisb6";
2599         case PAPER_USEXECUTIVE:
2600                 // dvipdfm does not know this
2601                 if (purpose == DVIPDFM)
2602                         return string();
2603                 return "foolscap";
2604         case PAPER_USLEGAL:
2605                 return "legal";
2606         case PAPER_USLETTER:
2607         default:
2608                 if (purpose == XDVI)
2609                         return "us";
2610                 return "letter";
2611         }
2612 }
2613
2614
2615 string const BufferParams::dvips_options() const
2616 {
2617         string result;
2618
2619         // If the class loads the geometry package, we do not know which
2620         // paper size is used, since we do not set it (bug 7013).
2621         // Therefore we must not specify any argument here.
2622         // dvips gets the correct paper size via DVI specials in this case
2623         // (if the class uses the geometry package correctly).
2624         if (documentClass().provides("geometry"))
2625                 return result;
2626
2627         if (use_geometry
2628             && papersize == PAPER_CUSTOM
2629             && !lyxrc.print_paper_dimension_flag.empty()
2630             && !paperwidth.empty()
2631             && !paperheight.empty()) {
2632                 // using a custom papersize
2633                 result = lyxrc.print_paper_dimension_flag;
2634                 result += ' ' + paperwidth;
2635                 result += ',' + paperheight;
2636         } else {
2637                 string const paper_option = paperSizeName(DVIPS);
2638                 if (!paper_option.empty() && (paper_option != "letter" ||
2639                     orientation != ORIENTATION_LANDSCAPE)) {
2640                         // dvips won't accept -t letter -t landscape.
2641                         // In all other cases, include the paper size
2642                         // explicitly.
2643                         result = lyxrc.print_paper_flag;
2644                         result += ' ' + paper_option;
2645                 }
2646         }
2647         if (orientation == ORIENTATION_LANDSCAPE &&
2648             papersize != PAPER_CUSTOM)
2649                 result += ' ' + lyxrc.print_landscape_flag;
2650         return result;
2651 }
2652
2653
2654 string const BufferParams::font_encoding() const
2655 {
2656         return (fontenc == "global") ? lyxrc.fontenc : fontenc;
2657 }
2658
2659
2660 string BufferParams::babelCall(string const & lang_opts, bool const langoptions) const
2661 {
2662         // suppress the babel call if there is no BabelName defined
2663         // for the document language in the lib/languages file and if no
2664         // other languages are used (lang_opts is then empty)
2665         if (lang_opts.empty())
2666                 return string();
2667         // either a specific language (AsBabelOptions setting in
2668         // lib/languages) or the prefs require the languages to
2669         // be submitted to babel itself (not the class).
2670         if (langoptions)
2671                 return "\\usepackage[" + lang_opts + "]{babel}";
2672         return "\\usepackage{babel}";
2673 }
2674
2675
2676 docstring BufferParams::getGraphicsDriver(string const & package) const
2677 {
2678         docstring result;
2679
2680         if (package == "geometry") {
2681                 if (graphics_driver == "dvips"
2682                     || graphics_driver == "dvipdfm"
2683                     || graphics_driver == "pdftex"
2684                     || graphics_driver == "vtex")
2685                         result = from_ascii(graphics_driver);
2686                 else if (graphics_driver == "dvipdfmx")
2687                         result = from_ascii("dvipdfm");
2688         }
2689
2690         return result;
2691 }
2692
2693
2694 void BufferParams::writeEncodingPreamble(otexstream & os,
2695                                          LaTeXFeatures & features) const
2696 {
2697         // XeTeX does not need this
2698         if (features.runparams().flavor == OutputParams::XETEX)
2699                 return;
2700         // LuaTeX neither, but with tex fonts, we need to load
2701         // the luainputenc package.
2702         if (features.runparams().flavor == OutputParams::LUATEX
2703                 || features.runparams().flavor == OutputParams::DVILUATEX) {
2704                 if (!useNonTeXFonts && inputenc != "default"
2705                     && ((inputenc == "auto" && language->encoding()->package() == Encoding::inputenc)
2706                         || (inputenc != "auto" && encoding().package() == Encoding::inputenc))) {
2707                         os << "\\usepackage[utf8]{luainputenc}\n";
2708                 }
2709                 return;
2710         }
2711         if (inputenc == "auto") {
2712                 string const doc_encoding =
2713                         language->encoding()->latexName();
2714                 Encoding::Package const package =
2715                         language->encoding()->package();
2716
2717                 // Create a list with all the input encodings used
2718                 // in the document
2719                 set<string> encodings =
2720                         features.getEncodingSet(doc_encoding);
2721
2722                 // If the "japanese" package (i.e. pLaTeX) is used,
2723                 // inputenc must be omitted.
2724                 // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
2725                 if ((!encodings.empty() || package == Encoding::inputenc)
2726                     && !features.isRequired("japanese")) {
2727                         os << "\\usepackage[";
2728                         set<string>::const_iterator it = encodings.begin();
2729                         set<string>::const_iterator const end = encodings.end();
2730                         if (it != end) {
2731                                 os << from_ascii(*it);
2732                                 ++it;
2733                         }
2734                         for (; it != end; ++it)
2735                                 os << ',' << from_ascii(*it);
2736                         if (package == Encoding::inputenc) {
2737                                 if (!encodings.empty())
2738                                         os << ',';
2739                                 os << from_ascii(doc_encoding);
2740                         }
2741                         os << "]{inputenc}\n";
2742                 }
2743                 if (package == Encoding::CJK || features.mustProvide("CJK")) {
2744                         if (language->encoding()->name() == "utf8-cjk"
2745                             && LaTeXFeatures::isAvailable("CJKutf8"))
2746                                 os << "\\usepackage{CJKutf8}\n";
2747                         else
2748                                 os << "\\usepackage{CJK}\n";
2749                 }
2750         } else if (inputenc != "default") {
2751                 switch (encoding().package()) {
2752                 case Encoding::none:
2753                 case Encoding::japanese:
2754                         break;
2755                 case Encoding::inputenc:
2756                         // do not load inputenc if japanese is used
2757                         if (features.isRequired("japanese"))
2758                                 break;
2759                         os << "\\usepackage[" << from_ascii(inputenc)
2760                            << "]{inputenc}\n";
2761                         break;
2762                 case Encoding::CJK:
2763                         if (encoding().name() == "utf8-cjk"
2764                             && LaTeXFeatures::isAvailable("CJKutf8"))
2765                                 os << "\\usepackage{CJKutf8}\n";
2766                         else
2767                                 os << "\\usepackage{CJK}\n";
2768                         break;
2769                 }
2770         }
2771 }
2772
2773
2774 string const BufferParams::parseFontName(string const & name) const
2775 {
2776         string mangled = name;
2777         size_t const idx = mangled.find('[');
2778         if (idx == string::npos || idx == 0)
2779                 return mangled;
2780         else
2781                 return mangled.substr(0, idx - 1);
2782 }
2783
2784
2785 string const BufferParams::loadFonts(LaTeXFeatures & features) const
2786 {
2787         if (fonts_roman == "default" && fonts_sans == "default"
2788             && fonts_typewriter == "default"
2789             && (fonts_math == "default" || fonts_math == "auto"))
2790                 //nothing to do
2791                 return string();
2792
2793         ostringstream os;
2794
2795         /* Fontspec (XeTeX, LuaTeX): we provide GUI support for oldstyle
2796          * numbers (Numbers=OldStyle) and sf/tt scaling. The Ligatures=TeX/
2797          * Mapping=tex-text option assures TeX ligatures (such as "--")
2798          * are resolved. Note that tt does not use these ligatures.
2799          * TODO:
2800          *    -- add more GUI options?
2801          *    -- add more fonts (fonts for other scripts)
2802          *    -- if there's a way to find out if a font really supports
2803          *       OldStyle, enable/disable the widget accordingly.
2804         */
2805         if (useNonTeXFonts && features.isAvailable("fontspec")) {
2806                 // "Mapping=tex-text" and "Ligatures=TeX" are equivalent.
2807                 // However, until v.2 (2010/07/11) fontspec only knew
2808                 // Mapping=tex-text (for XeTeX only); then "Ligatures=TeX"
2809                 // was introduced for both XeTeX and LuaTeX (LuaTeX
2810                 // didn't understand "Mapping=tex-text", while XeTeX
2811                 // understood both. With most recent versions, both
2812                 // variants are understood by both engines. However,
2813                 // we want to provide support for at least TeXLive 2009
2814                 // (for XeTeX; LuaTeX is only supported as of v.2)
2815                 string const texmapping =
2816                         (features.runparams().flavor == OutputParams::XETEX) ?
2817                         "Mapping=tex-text" : "Ligatures=TeX";
2818                 if (fonts_roman != "default") {
2819                         os << "\\setmainfont[" << texmapping;
2820                         if (fonts_old_figures)
2821                                 os << ",Numbers=OldStyle";
2822                         os << "]{" << parseFontName(fonts_roman) << "}\n";
2823                 }
2824                 if (fonts_sans != "default") {
2825                         string const sans = parseFontName(fonts_sans);
2826                         if (fonts_sans_scale != 100)
2827                                 os << "\\setsansfont[Scale="
2828                                    << float(fonts_sans_scale) / 100
2829                                    << "," << texmapping << "]{"
2830                                    << sans << "}\n";
2831                         else
2832                                 os << "\\setsansfont[" << texmapping << "]{"
2833                                    << sans << "}\n";
2834                 }
2835                 if (fonts_typewriter != "default") {
2836                         string const mono = parseFontName(fonts_typewriter);
2837                         if (fonts_typewriter_scale != 100)
2838                                 os << "\\setmonofont[Scale="
2839                                    << float(fonts_typewriter_scale) / 100
2840                                    << "]{"
2841                                    << mono << "}\n";
2842                         else
2843                                 os << "\\setmonofont{"
2844                                    << mono << "}\n";
2845                 }
2846                 return os.str();
2847         }
2848
2849         // Tex Fonts
2850         bool const ot1 = (font_encoding() == "default" || font_encoding() == "OT1");
2851         bool const dryrun = features.runparams().dryrun;
2852         bool const complete = (fonts_sans == "default" && fonts_typewriter == "default");
2853         bool const nomath = (fonts_math == "default");
2854
2855         // ROMAN FONTS
2856         os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_roman)).getLaTeXCode(
2857                 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
2858                 nomath);
2859
2860         // SANS SERIF
2861         os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_sans)).getLaTeXCode(
2862                 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
2863                 nomath, fonts_sans_scale);
2864
2865         // MONOSPACED/TYPEWRITER
2866         os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_typewriter)).getLaTeXCode(
2867                 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
2868                 nomath, fonts_typewriter_scale);
2869
2870         // MATH
2871         os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_math)).getLaTeXCode(
2872                 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
2873                 nomath);
2874
2875         return os.str();
2876 }
2877
2878
2879 Encoding const & BufferParams::encoding() const
2880 {
2881         // FIXME: actually, we should check for the flavor
2882         // or runparams.isFullyUnicode() here:
2883         // This check will not work with XeTeX/LuaTeX and tex fonts.
2884         // Thus we have to reset the encoding in Buffer::makeLaTeXFile.
2885         if (useNonTeXFonts)
2886                 return *(encodings.fromLaTeXName("utf8-plain"));
2887         if (inputenc == "auto" || inputenc == "default")
2888                 return *language->encoding();
2889         Encoding const * const enc = encodings.fromLaTeXName(inputenc);
2890         if (enc)
2891                 return *enc;
2892         LYXERR0("Unknown inputenc value `" << inputenc
2893                << "'. Using `auto' instead.");
2894         return *language->encoding();
2895 }
2896
2897
2898 bool BufferParams::addCiteEngine(string const & engine)
2899 {
2900         LayoutModuleList::const_iterator it = cite_engine_.begin();
2901         LayoutModuleList::const_iterator en = cite_engine_.end();
2902         for (; it != en; ++it)
2903                 if (*it == engine)
2904                         return false;
2905         cite_engine_.push_back(engine);
2906         return true;
2907 }
2908
2909
2910 bool BufferParams::addCiteEngine(vector<string> const & engine)
2911 {
2912         vector<string>::const_iterator it = engine.begin();
2913         vector<string>::const_iterator en = engine.end();
2914         bool ret = true;
2915         for (; it != en; ++it)
2916                 if (!addCiteEngine(*it))
2917                         ret = false;
2918         return ret;
2919 }
2920
2921
2922 string const & BufferParams::defaultBiblioStyle() const
2923 {
2924         return documentClass().defaultBiblioStyle();
2925 }
2926
2927
2928 bool const & BufferParams::fullAuthorList() const
2929 {
2930         return documentClass().fullAuthorList();
2931 }
2932
2933
2934 void BufferParams::setCiteEngine(string const & engine)
2935 {
2936         clearCiteEngine();
2937         addCiteEngine(engine);
2938 }
2939
2940
2941 void BufferParams::setCiteEngine(vector<string> const & engine)
2942 {
2943         clearCiteEngine();
2944         addCiteEngine(engine);
2945 }
2946
2947
2948 vector<string> BufferParams::citeCommands() const
2949 {
2950         static CitationStyle const default_style;
2951         vector<string> commands =
2952                 documentClass().citeCommands(citeEngineType());
2953         if (commands.empty())
2954                 commands.push_back(default_style.cmd);
2955         return commands;
2956 }
2957
2958
2959 vector<CitationStyle> BufferParams::citeStyles() const
2960 {
2961         static CitationStyle const default_style;
2962         vector<CitationStyle> styles =
2963                 documentClass().citeStyles(citeEngineType());
2964         if (styles.empty())
2965                 styles.push_back(default_style);
2966         return styles;
2967 }
2968
2969 } // namespace lyx