src/BufferParams.cpp

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