src/BufferParams.cpp

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