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