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