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