src/BufferParams.cpp

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