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