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