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