src/BufferParams.cpp

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