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