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