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