src/BufferParams.cpp

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