src/BufferParams.cpp

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