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