src/BufferParams.cpp

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