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         // for arabic_arabi and farsi we also need to load the LAE and
1495         // LFE encoding
1496         // XeTeX and LuaTeX (with OS fonts) work without fontenc
1497         if (font_encoding() != "default" && language->lang() != "japanese"
1498             && !useNonTeXFonts && !features.isProvided("fontenc")) {
1499                 docstring extra_encoding;
1500                 if (features.mustProvide("textgreek"))
1501                         extra_encoding += from_ascii("LGR");
1502                 if (features.mustProvide("textcyr")) {
1503                         if (!extra_encoding.empty())
1504                                 extra_encoding.push_back(',');
1505                         extra_encoding += from_ascii("T2A");
1506                 }
1507                 if (!extra_encoding.empty() && !font_encoding().empty())
1508                         extra_encoding.push_back(',');
1509                 size_t fars = language_options.str().find("farsi");
1510                 size_t arab = language_options.str().find("arabic");
1511                 if (language->lang() == "arabic_arabi"
1512                         || language->lang() == "farsi" || fars != string::npos
1513                         || arab != string::npos) {
1514                         os << "\\usepackage[" << extra_encoding
1515                            << from_ascii(font_encoding())
1516                            << ",LFE,LAE]{fontenc}\n";
1517                 } else {
1518                         os << "\\usepackage[" << extra_encoding
1519                            << from_ascii(font_encoding())
1520                            << "]{fontenc}\n";
1521                 }
1522         }
1523
1524         // handle inputenc etc.
1525         writeEncodingPreamble(os, features);
1526
1527         // includeonly
1528         if (!features.runparams().includeall && !included_children_.empty()) {
1529                 os << "\\includeonly{";
1530                 list<string>::const_iterator it = included_children_.begin();
1531                 list<string>::const_iterator en = included_children_.end();
1532                 bool first = true;
1533                 for (; it != en; ++it) {
1534                         string incfile = *it;
1535                         FileName inc = makeAbsPath(incfile, filepath.absFileName());
1536                         string mangled = DocFileName(changeExtension(inc.absFileName(), ".tex")).
1537                         mangledFileName();
1538                         if (!features.runparams().nice)
1539                                 incfile = mangled;
1540                         // \includeonly doesn't want an extension
1541                         incfile = changeExtension(incfile, string());
1542                         incfile = support::latex_path(incfile);
1543                         if (!incfile.empty()) {
1544                                 if (!first)
1545                                         os << ",";
1546                                 os << from_utf8(incfile);
1547                         }
1548                         first = false;
1549                 }
1550                 os << "}\n";
1551         }
1552
1553         if (!features.isProvided("geometry")
1554             && (use_geometry || nonstandard_papersize)) {
1555                 odocstringstream ods;
1556                 if (!getGraphicsDriver("geometry").empty())
1557                         ods << getGraphicsDriver("geometry");
1558                 if (orientation == ORIENTATION_LANDSCAPE)
1559                         ods << ",landscape";
1560                 switch (papersize) {
1561                 case PAPER_CUSTOM:
1562                         if (!paperwidth.empty())
1563                                 ods << ",paperwidth="
1564                                    << from_ascii(paperwidth);
1565                         if (!paperheight.empty())
1566                                 ods << ",paperheight="
1567                                    << from_ascii(paperheight);
1568                         break;
1569                 case PAPER_USLETTER:
1570                         ods << ",letterpaper";
1571                         break;
1572                 case PAPER_USLEGAL:
1573                         ods << ",legalpaper";
1574                         break;
1575                 case PAPER_USEXECUTIVE:
1576                         ods << ",executivepaper";
1577                         break;
1578                 case PAPER_A0:
1579                         ods << ",a0paper";
1580                         break;
1581                 case PAPER_A1:
1582                         ods << ",a1paper";
1583                         break;
1584                 case PAPER_A2:
1585                         ods << ",a2paper";
1586                         break;
1587                 case PAPER_A3:
1588                         ods << ",a3paper";
1589                         break;
1590                 case PAPER_A4:
1591                         ods << ",a4paper";
1592                         break;
1593                 case PAPER_A5:
1594                         ods << ",a5paper";
1595                         break;
1596                 case PAPER_A6:
1597                         ods << ",a6paper";
1598                         break;
1599                 case PAPER_B0:
1600                         ods << ",b0paper";
1601                         break;
1602                 case PAPER_B1:
1603                         ods << ",b1paper";
1604                         break;
1605                 case PAPER_B2:
1606                         ods << ",b2paper";
1607                         break;
1608                 case PAPER_B3:
1609                         ods << ",b3paper";
1610                         break;
1611                 case PAPER_B4:
1612                         ods << ",b4paper";
1613                         break;
1614                 case PAPER_B5:
1615                         ods << ",b5paper";
1616                         break;
1617                 case PAPER_B6:
1618                         ods << ",b6paper";
1619                         break;
1620                 case PAPER_C0:
1621                         ods << ",c0paper";
1622                         break;
1623                 case PAPER_C1:
1624                         ods << ",c1paper";
1625                         break;
1626                 case PAPER_C2:
1627                         ods << ",c2paper";
1628                         break;
1629                 case PAPER_C3:
1630                         ods << ",c3paper";
1631                         break;
1632                 case PAPER_C4:
1633                         ods << ",c4paper";
1634                         break;
1635                 case PAPER_C5:
1636                         ods << ",c5paper";
1637                         break;
1638                 case PAPER_C6:
1639                         ods << ",c6paper";
1640                         break;
1641                 case PAPER_JISB0:
1642                         ods << ",b0j";
1643                         break;
1644                 case PAPER_JISB1:
1645                         ods << ",b1j";
1646                         break;
1647                 case PAPER_JISB2:
1648                         ods << ",b2j";
1649                         break;
1650                 case PAPER_JISB3:
1651                         ods << ",b3j";
1652                         break;
1653                 case PAPER_JISB4:
1654                         ods << ",b4j";
1655                         break;
1656                 case PAPER_JISB5:
1657                         ods << ",b5j";
1658                         break;
1659                 case PAPER_JISB6:
1660                         ods << ",b6j";
1661                         break;
1662                 case PAPER_DEFAULT:
1663                         break;
1664                 }
1665                 docstring const g_options = trim(ods.str(), ",");
1666                 os << "\\usepackage";
1667                 if (!g_options.empty())
1668                         os << '[' << g_options << ']';
1669                 os << "{geometry}\n";
1670                 // output this only if use_geometry is true
1671                 if (use_geometry) {
1672                         os << "\\geometry{verbose";
1673                         if (!topmargin.empty())
1674                                 os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1675                         if (!bottommargin.empty())
1676                                 os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1677                         if (!leftmargin.empty())
1678                                 os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1679                         if (!rightmargin.empty())
1680                                 os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1681                         if (!headheight.empty())
1682                                 os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1683                         if (!headsep.empty())
1684                                 os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1685                         if (!footskip.empty())
1686                                 os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1687                         if (!columnsep.empty())
1688                                 os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
1689                         os << "}\n";
1690                 }
1691         } else if (orientation == ORIENTATION_LANDSCAPE
1692                    || papersize != PAPER_DEFAULT) {
1693                 features.require("papersize");
1694         }
1695
1696         if (tokenPos(tclass.opt_pagestyle(), '|', pagestyle) >= 0) {
1697                 if (pagestyle == "fancy")
1698                         os << "\\usepackage{fancyhdr}\n";
1699                 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1700         }
1701
1702         // only output when the background color is not default
1703         if (isbackgroundcolor == true) {
1704                 // only require color here, the background color will be defined
1705                 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1706                 // package pdfpages
1707                 features.require("color");
1708                 features.require("pagecolor");
1709         }
1710
1711         // only output when the font color is not default
1712         if (isfontcolor == true) {
1713                 // only require color here, the font color will be defined
1714                 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1715                 // package pdfpages
1716                 features.require("color");
1717                 features.require("fontcolor");
1718         }
1719
1720         // Only if class has a ToC hierarchy
1721         if (tclass.hasTocLevels()) {
1722                 if (secnumdepth != tclass.secnumdepth()) {
1723                         os << "\\setcounter{secnumdepth}{"
1724                            << secnumdepth
1725                            << "}\n";
1726                 }
1727                 if (tocdepth != tclass.tocdepth()) {
1728                         os << "\\setcounter{tocdepth}{"
1729                            << tocdepth
1730                            << "}\n";
1731                 }
1732         }
1733
1734         if (paragraph_separation) {
1735                 // when skip separation
1736                 switch (getDefSkip().kind()) {
1737                 case VSpace::SMALLSKIP:
1738                         os << "\\setlength{\\parskip}{\\smallskipamount}\n";
1739                         break;
1740                 case VSpace::MEDSKIP:
1741                         os << "\\setlength{\\parskip}{\\medskipamount}\n";
1742                         break;
1743                 case VSpace::BIGSKIP:
1744                         os << "\\setlength{\\parskip}{\\bigskipamount}\n";
1745                         break;
1746                 case VSpace::LENGTH:
1747                         os << "\\setlength{\\parskip}{"
1748                            << from_utf8(getDefSkip().length().asLatexString())
1749                            << "}\n";
1750                         break;
1751                 default: // should never happen // Then delete it.
1752                         os << "\\setlength{\\parskip}{\\medskipamount}\n";
1753                         break;
1754                 }
1755                 os << "\\setlength{\\parindent}{0pt}\n";
1756         } else {
1757                 // when separation by indentation
1758                 // only output something when a width is given
1759                 if (getIndentation().asLyXCommand() != "default") {
1760                         os << "\\setlength{\\parindent}{"
1761                            << from_utf8(getIndentation().asLatexCommand())
1762                            << "}\n";
1763                 }
1764         }
1765
1766         // Now insert the LyX specific LaTeX commands...
1767         docstring lyxpreamble;
1768         features.resolveAlternatives();
1769
1770         if (output_sync) {
1771                 if (!output_sync_macro.empty())
1772                         lyxpreamble += from_utf8(output_sync_macro) +"\n";
1773                 else if (features.runparams().flavor == OutputParams::LATEX)
1774                         lyxpreamble += "\\usepackage[active]{srcltx}\n";
1775                 else if (features.runparams().flavor == OutputParams::PDFLATEX)
1776                         lyxpreamble += "\\synctex=-1\n";
1777         }
1778
1779         // The package options (via \PassOptionsToPackage)
1780         lyxpreamble += from_ascii(features.getPackageOptions());
1781
1782         // due to interferences with babel and hyperref, the color package has to
1783         // be loaded (when it is not already loaded) before babel when hyperref
1784         // is used with the colorlinks option, see
1785         // http://www.lyx.org/trac/ticket/5291
1786         // we decided therefore to load color always before babel, see
1787         // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
1788         lyxpreamble += from_ascii(features.getColorOptions());
1789
1790         // If we use hyperref, jurabib, japanese, varioref or vietnamese,
1791         // we have to call babel before
1792         if (use_babel
1793             && (features.isRequired("jurabib")
1794                 || features.isRequired("hyperref")
1795                 || features.isRequired("varioref")
1796                 || features.isRequired("vietnamese")
1797                 || features.isRequired("japanese"))) {
1798                         // FIXME UNICODE
1799                         lyxpreamble += from_utf8(features.getBabelPresettings());
1800                         lyxpreamble += from_utf8(babelCall(language_options.str(),
1801                                                            features.needBabelLangOptions())) + '\n';
1802                         lyxpreamble += from_utf8(features.getBabelPostsettings());
1803         }
1804
1805         // The optional packages;
1806         lyxpreamble += from_ascii(features.getPackages());
1807
1808         // Additional Indices
1809         if (features.isRequired("splitidx")) {
1810                 IndicesList::const_iterator iit = indiceslist().begin();
1811                 IndicesList::const_iterator iend = indiceslist().end();
1812                 for (; iit != iend; ++iit) {
1813                         pair<docstring, docstring> indexname_latex =
1814                                 features.runparams().encoding->latexString(iit->index(),
1815                                                                            features.runparams().dryrun);
1816                         if (!indexname_latex.second.empty()) {
1817                                 // issue a warning about omitted characters
1818                                 // FIXME: should be passed to the error dialog
1819                                 frontend::Alert::warning(_("Uncodable characters"),
1820                                         bformat(_("The following characters that are used in an index name are not\n"
1821                                                   "representable in the current encoding and therefore have been omitted:\n%1$s."),
1822                                                 indexname_latex.second));
1823                         }
1824                         lyxpreamble += "\\newindex[";
1825                         lyxpreamble += indexname_latex.first;
1826                         lyxpreamble += "]{";
1827                         lyxpreamble += escape(iit->shortcut());
1828                         lyxpreamble += "}\n";
1829                 }
1830         }
1831
1832         // Line spacing
1833         lyxpreamble += from_utf8(spacing().writePreamble(features.isProvided("SetSpace")));
1834
1835         // PDF support.
1836         // * Hyperref manual: "Make sure it comes last of your loaded
1837         //   packages, to give it a fighting chance of not being over-written,
1838         //   since its job is to redefine many LaTeX commands."
1839         // * Email from Heiko Oberdiek: "It is usually better to load babel
1840         //   before hyperref. Then hyperref has a chance to detect babel.
1841         // * Has to be loaded before the "LyX specific LaTeX commands" to
1842         //   avoid errors with algorithm floats.
1843         // use hyperref explicitly if it is required
1844         if (features.isRequired("hyperref")) {
1845                 // pass what we have to stream here, since we need
1846                 // to access the stream itself in PDFOptions.
1847                 os << lyxpreamble;
1848
1849                 OutputParams tmp_params = features.runparams();
1850                 pdfoptions().writeLaTeX(tmp_params, os,
1851                                         features.isProvided("hyperref"));
1852                 // set back for the rest
1853                 lyxpreamble.clear();
1854                 // correctly break URLs with hyperref and dvi output
1855                 if (features.runparams().flavor == OutputParams::LATEX
1856                     && features.isAvailable("breakurl"))
1857                         lyxpreamble += "\\usepackage{breakurl}\n";
1858         } else if (features.isRequired("nameref"))
1859                 // hyperref loads this automatically
1860                 lyxpreamble += "\\usepackage{nameref}\n";
1861
1862         // bibtopic needs to be loaded after hyperref.
1863         // the dot provides the aux file naming which LyX can detect.
1864         if (features.mustProvide("bibtopic"))
1865                 lyxpreamble += "\\usepackage[dot]{bibtopic}\n";
1866
1867         // Will be surrounded by \makeatletter and \makeatother when not empty
1868         docstring atlyxpreamble;
1869
1870         // Some macros LyX will need
1871         docstring tmppreamble(features.getMacros());
1872
1873         if (!tmppreamble.empty())
1874                 atlyxpreamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1875                         "LyX specific LaTeX commands.\n"
1876                         + tmppreamble + '\n';
1877
1878         // the text class specific preamble
1879         tmppreamble = features.getTClassPreamble();
1880         if (!tmppreamble.empty())
1881                 atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1882                         "Textclass specific LaTeX commands.\n"
1883                         + tmppreamble + '\n';
1884
1885         // suppress date if selected
1886         // use \@ifundefined because we cannot be sure that every document class
1887         // has a \date command
1888         if (suppress_date)
1889                 atlyxpreamble += "\\@ifundefined{date}{}{\\date{}}\n";
1890
1891         /* the user-defined preamble */
1892         if (!containsOnly(preamble, " \n\t"))
1893                 // FIXME UNICODE
1894                 atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1895                         "User specified LaTeX commands.\n"
1896                         + from_utf8(preamble) + '\n';
1897
1898         // footmisc must be loaded after setspace
1899         // Load it here to avoid clashes with footmisc loaded in the user
1900         // preamble. For that reason we also pass the options via
1901         // \PassOptionsToPackage in getPreamble() and not here.
1902         if (features.mustProvide("footmisc"))
1903                 atlyxpreamble += "\\usepackage{footmisc}\n";
1904
1905         // subfig loads internally the LaTeX package "caption". As
1906         // caption is a very popular package, users will load it in
1907         // the preamble. Therefore we must load subfig behind the
1908         // user-defined preamble and check if the caption package was
1909         // loaded or not. For the case that caption is loaded before
1910         // subfig, there is the subfig option "caption=false". This
1911         // option also works when a koma-script class is used and
1912         // koma's own caption commands are used instead of caption. We
1913         // use \PassOptionsToPackage here because the user could have
1914         // already loaded subfig in the preamble.
1915         if (features.isRequired("subfig")) {
1916                 atlyxpreamble += "\\@ifundefined{showcaptionsetup}{}{%\n"
1917                         " \\PassOptionsToPackage{caption=false}{subfig}}\n"
1918                         "\\usepackage{subfig}\n";
1919         }
1920
1921         // Itemize bullet settings need to be last in case the user
1922         // defines their own bullets that use a package included
1923         // in the user-defined preamble -- ARRae
1924         // Actually it has to be done much later than that
1925         // since some packages like frenchb make modifications
1926         // at \begin{document} time -- JMarc
1927         docstring bullets_def;
1928         for (int i = 0; i < 4; ++i) {
1929                 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1930                         if (bullets_def.empty())
1931                                 bullets_def += "\\AtBeginDocument{\n";
1932                         bullets_def += "  \\def\\labelitemi";
1933                         switch (i) {
1934                                 // `i' is one less than the item to modify
1935                         case 0:
1936                                 break;
1937                         case 1:
1938                                 bullets_def += 'i';
1939                                 break;
1940                         case 2:
1941                                 bullets_def += "ii";
1942                                 break;
1943                         case 3:
1944                                 bullets_def += 'v';
1945                                 break;
1946                         }
1947                         bullets_def += '{' +
1948                                 user_defined_bullet(i).getText()
1949                                 + "}\n";
1950                 }
1951         }
1952
1953         if (!bullets_def.empty())
1954                 atlyxpreamble += bullets_def + "}\n\n";
1955
1956         if (!atlyxpreamble.empty())
1957                 lyxpreamble += "\n\\makeatletter\n"
1958                         + atlyxpreamble + "\\makeatother\n\n";
1959
1960         // We try to load babel late, in case it interferes with other packages.
1961         // Jurabib, hyperref, varioref and listings (bug 8995) have to be
1962         // called after babel, though.
1963         if (use_babel && !features.isRequired("jurabib")
1964             && !features.isRequired("hyperref")
1965                 && !features.isRequired("varioref")
1966             && !features.isRequired("vietnamese")
1967             && !features.isRequired("japanese")) {
1968                 // FIXME UNICODE
1969                 lyxpreamble += from_utf8(features.getBabelPresettings());
1970                 lyxpreamble += from_utf8(babelCall(language_options.str(),
1971                                                    features.needBabelLangOptions())) + '\n';
1972                 lyxpreamble += from_utf8(features.getBabelPostsettings());
1973         }
1974         if (!listings_params.empty() || features.isRequired("listings"))
1975                 lyxpreamble += "\\usepackage{listings}\n";
1976         if (!listings_params.empty()) {
1977                 lyxpreamble += "\\lstset{";
1978                 // do not test validity because listings_params is
1979                 // supposed to be valid
1980                 string par =
1981                         InsetListingsParams(listings_params).separatedParams(true);
1982                 lyxpreamble += from_utf8(par);
1983                 lyxpreamble += "}\n";
1984         }
1985
1986         // xunicode needs to be loaded at least after amsmath, amssymb,
1987         // esint and the other packages that provide special glyphs
1988         if (features.runparams().flavor == OutputParams::XETEX
1989             && useNonTeXFonts)
1990                 lyxpreamble += "\\usepackage{xunicode}\n";
1991
1992         // Polyglossia must be loaded last
1993         if (use_polyglossia) {
1994                 // call the package
1995                 lyxpreamble += "\\usepackage{polyglossia}\n";
1996                 // set the main language
1997                 lyxpreamble += "\\setdefaultlanguage";
1998                 if (!language->polyglossiaOpts().empty())
1999                         lyxpreamble += "[" + from_ascii(language->polyglossiaOpts()) + "]";
2000                 lyxpreamble += "{" + from_ascii(language->polyglossia()) + "}\n";
2001                 // now setup the other languages
2002                 std::map<std::string, std::string> const polylangs =
2003                         features.getPolyglossiaLanguages();
2004                 for (std::map<std::string, std::string>::const_iterator mit = polylangs.begin();
2005                      mit != polylangs.end() ; ++mit) {
2006                         lyxpreamble += "\\setotherlanguage";
2007                         if (!mit->second.empty())
2008                                 lyxpreamble += "[" + from_ascii(mit->second) + "]";
2009                         lyxpreamble += "{" + from_ascii(mit->first) + "}\n";
2010                 }
2011         }
2012
2013         // Load custom language package here
2014         if (features.langPackage() == LaTeXFeatures::LANG_PACK_CUSTOM) {
2015                 if (lang_package == "default")
2016                         lyxpreamble += from_utf8(lyxrc.language_custom_package);
2017                 else
2018                         lyxpreamble += from_utf8(lang_package);
2019                 lyxpreamble += '\n';
2020         }
2021
2022         docstring const i18npreamble =
2023                 features.getTClassI18nPreamble(use_babel, use_polyglossia);
2024         if (!i18npreamble.empty())
2025                 lyxpreamble += i18npreamble + '\n';
2026
2027         os << lyxpreamble;
2028
2029         return use_babel;
2030 }
2031
2032
2033 void BufferParams::useClassDefaults()
2034 {
2035         DocumentClass const & tclass = documentClass();
2036
2037         sides = tclass.sides();
2038         columns = tclass.columns();
2039         pagestyle = tclass.pagestyle();
2040         use_default_options = true;
2041         // Only if class has a ToC hierarchy
2042         if (tclass.hasTocLevels()) {
2043                 secnumdepth = tclass.secnumdepth();
2044                 tocdepth = tclass.tocdepth();
2045         }
2046 }
2047
2048
2049 bool BufferParams::hasClassDefaults() const
2050 {
2051         DocumentClass const & tclass = documentClass();
2052
2053         return sides == tclass.sides()
2054                 && columns == tclass.columns()
2055                 && pagestyle == tclass.pagestyle()
2056                 && use_default_options
2057                 && secnumdepth == tclass.secnumdepth()
2058                 && tocdepth == tclass.tocdepth();
2059 }
2060
2061
2062 DocumentClass const & BufferParams::documentClass() const
2063 {
2064         return *doc_class_.get();
2065 }
2066
2067
2068 DocumentClassConstPtr BufferParams::documentClassPtr() const
2069 {
2070         return doc_class_;
2071 }
2072
2073
2074 void BufferParams::setDocumentClass(DocumentClassConstPtr tc)
2075 {
2076         // evil, but this function is evil
2077         doc_class_ = const_pointer_cast<DocumentClass>(tc);
2078 }
2079
2080
2081 bool BufferParams::setBaseClass(string const & classname)
2082 {
2083         LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
2084         LayoutFileList & bcl = LayoutFileList::get();
2085         if (!bcl.haveClass(classname)) {
2086                 docstring s =
2087                         bformat(_("The layout file:\n"
2088                                 "%1$s\n"
2089                                 "could not be found. A default textclass with default\n"
2090                                 "layouts will be used. LyX will not be able to produce\n"
2091                                 "correct output."),
2092                         from_utf8(classname));
2093                 frontend::Alert::error(_("Document class not found"), s);
2094                 bcl.addEmptyClass(classname);
2095         }
2096
2097         bool const success = bcl[classname].load();
2098         if (!success) {
2099                 docstring s =
2100                         bformat(_("Due to some error in it, the layout file:\n"
2101                                 "%1$s\n"
2102                                 "could not be loaded. A default textclass with default\n"
2103                                 "layouts will be used. LyX will not be able to produce\n"
2104                                 "correct output."),
2105                         from_utf8(classname));
2106                 frontend::Alert::error(_("Could not load class"), s);
2107                 bcl.addEmptyClass(classname);
2108         }
2109
2110         pimpl_->baseClass_ = classname;
2111         layout_modules_.adaptToBaseClass(baseClass(), removed_modules_);
2112         return true;
2113 }
2114
2115
2116 LayoutFile const * BufferParams::baseClass() const
2117 {
2118         if (LayoutFileList::get().haveClass(pimpl_->baseClass_))
2119                 return &(LayoutFileList::get()[pimpl_->baseClass_]);
2120         else
2121                 return 0;
2122 }
2123
2124
2125 LayoutFileIndex const & BufferParams::baseClassID() const
2126 {
2127         return pimpl_->baseClass_;
2128 }
2129
2130
2131 void BufferParams::makeDocumentClass(bool const clone)
2132 {
2133         if (!baseClass())
2134                 return;
2135
2136         LayoutModuleList mods;
2137         LayoutModuleList::iterator it = layout_modules_.begin();
2138         LayoutModuleList::iterator en = layout_modules_.end();
2139         for (; it != en; ++it)
2140                 mods.push_back(*it);
2141
2142         it = cite_engine_.begin();
2143         en = cite_engine_.end();
2144         for (; it != en; ++it)
2145                 mods.push_back(*it);
2146
2147         doc_class_ = getDocumentClass(*baseClass(), mods, clone);
2148
2149         TextClass::ReturnValues success = TextClass::OK;
2150         if (!forced_local_layout_.empty())
2151                 success = doc_class_->read(forced_local_layout_, TextClass::MODULE);
2152         if (!local_layout_.empty() &&
2153             (success == TextClass::OK || success == TextClass::OK_OLDFORMAT))
2154                 success = doc_class_->read(local_layout_, TextClass::MODULE);
2155         if (success != TextClass::OK && success != TextClass::OK_OLDFORMAT) {
2156                 docstring const msg = _("Error reading internal layout information");
2157                 frontend::Alert::warning(_("Read Error"), msg);
2158         }
2159 }
2160
2161
2162 bool BufferParams::layoutModuleCanBeAdded(string const & modName) const
2163 {
2164         return layout_modules_.moduleCanBeAdded(modName, baseClass());
2165 }
2166
2167
2168 bool BufferParams::citationModuleCanBeAdded(string const & modName) const
2169 {
2170         return cite_engine_.moduleCanBeAdded(modName, baseClass());
2171 }
2172
2173
2174 std::string BufferParams::getLocalLayout(bool forced) const
2175 {
2176         if (forced)
2177                 return doc_class_->forcedLayouts();
2178         else
2179                 return local_layout_;
2180 }
2181
2182
2183 void BufferParams::setLocalLayout(string const & layout, bool forced)
2184 {
2185         if (forced)
2186                 forced_local_layout_ = layout;
2187         else
2188                 local_layout_ = layout;
2189 }
2190
2191
2192 bool BufferParams::addLayoutModule(string const & modName)
2193 {
2194         LayoutModuleList::const_iterator it = layout_modules_.begin();
2195         LayoutModuleList::const_iterator end = layout_modules_.end();
2196         for (; it != end; ++it)
2197                 if (*it == modName)
2198                         return false;
2199         layout_modules_.push_back(modName);
2200         return true;
2201 }
2202
2203
2204 string BufferParams::bufferFormat() const
2205 {
2206         string format = documentClass().outputFormat();
2207         if (format == "latex") {
2208                 if (useNonTeXFonts)
2209                         return "xetex";
2210                 if (encoding().package() == Encoding::japanese)
2211                         return "platex";
2212         }
2213         return format;
2214 }
2215
2216
2217 bool BufferParams::isExportable(string const & format) const
2218 {
2219         vector<string> backs = backends();
2220         for (vector<string>::const_iterator it = backs.begin();
2221              it != backs.end(); ++it)
2222                 if (theConverters().isReachable(*it, format))
2223                         return true;
2224         return false;
2225 }
2226
2227
2228 vector<Format const *> BufferParams::exportableFormats(bool only_viewable) const
2229 {
2230         vector<string> const backs = backends();
2231         set<string> excludes;
2232         if (useNonTeXFonts) {
2233                 excludes.insert("latex");
2234                 excludes.insert("pdflatex");
2235         }
2236         vector<Format const *> result =
2237                 theConverters().getReachable(backs[0], only_viewable, true, excludes);
2238         for (vector<string>::const_iterator it = backs.begin() + 1;
2239              it != backs.end(); ++it) {
2240                 vector<Format const *>  r =
2241                         theConverters().getReachable(*it, only_viewable, false, excludes);
2242                 result.insert(result.end(), r.begin(), r.end());
2243         }
2244         return result;
2245 }
2246
2247
2248 bool BufferParams::isExportableFormat(string const & format) const
2249 {
2250         typedef vector<Format const *> Formats;
2251         Formats formats;
2252         formats = exportableFormats(true);
2253         Formats::const_iterator fit = formats.begin();
2254         Formats::const_iterator end = formats.end();
2255         for (; fit != end ; ++fit) {
2256                 if ((*fit)->name() == format)
2257                         return true;
2258         }
2259         return false;
2260 }
2261
2262
2263 vector<string> BufferParams::backends() const
2264 {
2265         vector<string> v;
2266         string const buffmt = bufferFormat();
2267
2268         // FIXME: Don't hardcode format names here, but use a flag
2269         if (buffmt == "latex") {
2270                 if (!useNonTeXFonts) {
2271                         v.push_back("pdflatex");
2272                         v.push_back("latex");
2273                 }
2274                 v.push_back("luatex");
2275                 v.push_back("dviluatex");
2276                 v.push_back("xetex");
2277         } else if (buffmt == "xetex") {
2278                 v.push_back("xetex");
2279                 // FIXME: need to test all languages (bug 8205)
2280                 if (!language || !language->isPolyglossiaExclusive()) {
2281                         v.push_back("luatex");
2282                         v.push_back("dviluatex");
2283                 }
2284         } else
2285                 v.push_back(buffmt);
2286
2287         v.push_back("xhtml");
2288         v.push_back("text");
2289         v.push_back("lyx");
2290         return v;
2291 }
2292
2293
2294 OutputParams::FLAVOR BufferParams::getOutputFlavor(string const & format) const
2295 {
2296         string const dformat = (format.empty() || format == "default") ?
2297                 getDefaultOutputFormat() : format;
2298         DefaultFlavorCache::const_iterator it =
2299                 default_flavors_.find(dformat);
2300
2301         if (it != default_flavors_.end())
2302                 return it->second;
2303
2304         OutputParams::FLAVOR result = OutputParams::LATEX;
2305
2306         // FIXME It'd be better not to hardcode this, but to do
2307         //       something with formats.
2308         if (dformat == "xhtml")
2309                 result = OutputParams::HTML;
2310         else if (dformat == "text")
2311                 result = OutputParams::TEXT;
2312         else if (dformat == "lyx")
2313                 result = OutputParams::LYX;
2314         else if (dformat == "pdflatex")
2315                 result = OutputParams::PDFLATEX;
2316         else if (dformat == "xetex")
2317                 result = OutputParams::XETEX;
2318         else if (dformat == "luatex")
2319                 result = OutputParams::LUATEX;
2320         else if (dformat == "dviluatex")
2321                 result = OutputParams::DVILUATEX;
2322         else {
2323                 // Try to determine flavor of default output format
2324                 vector<string> backs = backends();
2325                 if (find(backs.begin(), backs.end(), dformat) == backs.end()) {
2326                         // Get shortest path to format
2327                         Graph::EdgePath path;
2328                         for (vector<string>::const_iterator it = backs.begin();
2329                             it != backs.end(); ++it) {
2330                                 Graph::EdgePath p = theConverters().getPath(*it, dformat);
2331                                 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2332                                         path = p;
2333                                 }
2334                         }
2335                         if (!path.empty())
2336                                 result = theConverters().getFlavor(path);
2337                 }
2338         }
2339         // cache this flavor
2340         default_flavors_[dformat] = result;
2341         return result;
2342 }
2343
2344
2345 string BufferParams::getDefaultOutputFormat() const
2346 {
2347         if (!default_output_format.empty()
2348             && default_output_format != "default")
2349                 return default_output_format;
2350         if (isDocBook()
2351             || encoding().package() == Encoding::japanese) {
2352                 vector<Format const *> const formats = exportableFormats(true);
2353                 if (formats.empty())
2354                         return string();
2355                 // return the first we find
2356                 return formats.front()->name();
2357         }
2358         if (useNonTeXFonts)
2359                 return lyxrc.default_otf_view_format;
2360         return lyxrc.default_view_format;
2361 }
2362
2363 Font const BufferParams::getFont() const
2364 {
2365         FontInfo f = documentClass().defaultfont();
2366         if (fonts_default_family == "rmdefault")
2367                 f.setFamily(ROMAN_FAMILY);
2368         else if (fonts_default_family == "sfdefault")
2369                 f.setFamily(SANS_FAMILY);
2370         else if (fonts_default_family == "ttdefault")
2371                 f.setFamily(TYPEWRITER_FAMILY);
2372         return Font(f, language);
2373 }
2374
2375
2376 InsetQuotes::QuoteLanguage BufferParams::getQuoteStyle(string const & qs) const
2377 {
2378         return quoteslangtranslator().find(qs);
2379 }
2380
2381
2382 bool BufferParams::isLatex() const
2383 {
2384         return documentClass().outputType() == LATEX;
2385 }
2386
2387
2388 bool BufferParams::isLiterate() const
2389 {
2390         return documentClass().outputType() == LITERATE;
2391 }
2392
2393
2394 bool BufferParams::isDocBook() const
2395 {
2396         return documentClass().outputType() == DOCBOOK;
2397 }
2398
2399
2400 void BufferParams::readPreamble(Lexer & lex)
2401 {
2402         if (lex.getString() != "\\begin_preamble")
2403                 lyxerr << "Error (BufferParams::readPreamble):"
2404                         "consistency check failed." << endl;
2405
2406         preamble = lex.getLongString("\\end_preamble");
2407 }
2408
2409
2410 void BufferParams::readLocalLayout(Lexer & lex, bool forced)
2411 {
2412         string const expected = forced ? "\\begin_forced_local_layout" :
2413                                          "\\begin_local_layout";
2414         if (lex.getString() != expected)
2415                 lyxerr << "Error (BufferParams::readLocalLayout):"
2416                         "consistency check failed." << endl;
2417
2418         if (forced)
2419                 forced_local_layout_ =
2420                         lex.getLongString("\\end_forced_local_layout");
2421         else
2422                 local_layout_ = lex.getLongString("\\end_local_layout");
2423 }
2424
2425
2426 bool BufferParams::setLanguage(string const & lang)
2427 {
2428         Language const *new_language = languages.getLanguage(lang);
2429         if (!new_language) {
2430                 // Language lang was not found
2431                 return false;
2432         }
2433         language = new_language;
2434         return true;
2435 }
2436
2437
2438 void BufferParams::readLanguage(Lexer & lex)
2439 {
2440         if (!lex.next()) return;
2441
2442         string const tmptok = lex.getString();
2443
2444         // check if tmptok is part of tex_babel in tex-defs.h
2445         if (!setLanguage(tmptok)) {
2446                 // Language tmptok was not found
2447                 language = default_language;
2448                 lyxerr << "Warning: Setting language `"
2449                        << tmptok << "' to `" << language->lang()
2450                        << "'." << endl;
2451         }
2452 }
2453
2454
2455 void BufferParams::readGraphicsDriver(Lexer & lex)
2456 {
2457         if (!lex.next())
2458                 return;
2459
2460         string const tmptok = lex.getString();
2461         // check if tmptok is part of tex_graphics in tex_defs.h
2462         int n = 0;
2463         while (true) {
2464                 string const test = tex_graphics[n++];
2465
2466                 if (test == tmptok) {
2467                         graphics_driver = tmptok;
2468                         break;
2469                 }
2470                 if (test.empty()) {
2471                         lex.printError(
2472                                 "Warning: graphics driver `$$Token' not recognized!\n"
2473                                 "         Setting graphics driver to `default'.\n");
2474                         graphics_driver = "default";
2475                         break;
2476                 }
2477         }
2478 }
2479
2480
2481 void BufferParams::readBullets(Lexer & lex)
2482 {
2483         if (!lex.next())
2484                 return;
2485
2486         int const index = lex.getInteger();
2487         lex.next();
2488         int temp_int = lex.getInteger();
2489         user_defined_bullet(index).setFont(temp_int);
2490         temp_bullet(index).setFont(temp_int);
2491         lex >> temp_int;
2492         user_defined_bullet(index).setCharacter(temp_int);
2493         temp_bullet(index).setCharacter(temp_int);
2494         lex >> temp_int;
2495         user_defined_bullet(index).setSize(temp_int);
2496         temp_bullet(index).setSize(temp_int);
2497 }
2498
2499
2500 void BufferParams::readBulletsLaTeX(Lexer & lex)
2501 {
2502         // The bullet class should be able to read this.
2503         if (!lex.next())
2504                 return;
2505         int const index = lex.getInteger();
2506         lex.next(true);
2507         docstring const temp_str = lex.getDocString();
2508
2509         user_defined_bullet(index).setText(temp_str);
2510         temp_bullet(index).setText(temp_str);
2511 }
2512
2513
2514 void BufferParams::readModules(Lexer & lex)
2515 {
2516         if (!lex.eatLine()) {
2517                 lyxerr << "Error (BufferParams::readModules):"
2518                                 "Unexpected end of input." << endl;
2519                 return;
2520         }
2521         while (true) {
2522                 string mod = lex.getString();
2523                 if (mod == "\\end_modules")
2524                         break;
2525                 addLayoutModule(mod);
2526                 lex.eatLine();
2527         }
2528 }
2529
2530
2531 void BufferParams::readRemovedModules(Lexer & lex)
2532 {
2533         if (!lex.eatLine()) {
2534                 lyxerr << "Error (BufferParams::readRemovedModules):"
2535                                 "Unexpected end of input." << endl;
2536                 return;
2537         }
2538         while (true) {
2539                 string mod = lex.getString();
2540                 if (mod == "\\end_removed_modules")
2541                         break;
2542                 removed_modules_.push_back(mod);
2543                 lex.eatLine();
2544         }
2545         // now we want to remove any removed modules that were previously
2546         // added. normally, that will be because default modules were added in
2547         // setBaseClass(), which gets called when \textclass is read at the
2548         // start of the read.
2549         list<string>::const_iterator rit = removed_modules_.begin();
2550         list<string>::const_iterator const ren = removed_modules_.end();
2551         for (; rit != ren; ++rit) {
2552                 LayoutModuleList::iterator const mit = layout_modules_.begin();
2553                 LayoutModuleList::iterator const men = layout_modules_.end();
2554                 LayoutModuleList::iterator found = find(mit, men, *rit);
2555                 if (found == men)
2556                         continue;
2557                 layout_modules_.erase(found);
2558         }
2559 }
2560
2561
2562 void BufferParams::readIncludeonly(Lexer & lex)
2563 {
2564         if (!lex.eatLine()) {
2565                 lyxerr << "Error (BufferParams::readIncludeonly):"
2566                                 "Unexpected end of input." << endl;
2567                 return;
2568         }
2569         while (true) {
2570                 string child = lex.getString();
2571                 if (child == "\\end_includeonly")
2572                         break;
2573                 included_children_.push_back(child);
2574                 lex.eatLine();
2575         }
2576 }
2577
2578
2579 string BufferParams::paperSizeName(PapersizePurpose purpose) const
2580 {
2581         switch (papersize) {
2582         case PAPER_DEFAULT:
2583                 // could be anything, so don't guess
2584                 return string();
2585         case PAPER_CUSTOM: {
2586                 if (purpose == XDVI && !paperwidth.empty() &&
2587                     !paperheight.empty()) {
2588                         // heightxwidth<unit>
2589                         string first = paperwidth;
2590                         string second = paperheight;
2591                         if (orientation == ORIENTATION_LANDSCAPE)
2592                                 first.swap(second);
2593                         // cut off unit.
2594                         return first.erase(first.length() - 2)
2595                                 + "x" + second;
2596                 }
2597                 return string();
2598         }
2599         case PAPER_A0:
2600                 // dvips and dvipdfm do not know this
2601                 if (purpose == DVIPS || purpose == DVIPDFM)
2602                         return string();
2603                 return "a0";
2604         case PAPER_A1:
2605                 if (purpose == DVIPS || purpose == DVIPDFM)
2606                         return string();
2607                 return "a1";
2608         case PAPER_A2:
2609                 if (purpose == DVIPS || purpose == DVIPDFM)
2610                         return string();
2611                 return "a2";
2612         case PAPER_A3:
2613                 return "a3";
2614         case PAPER_A4:
2615                 return "a4";
2616         case PAPER_A5:
2617                 return "a5";
2618         case PAPER_A6:
2619                 if (purpose == DVIPS || purpose == DVIPDFM)
2620                         return string();
2621                 return "a6";
2622         case PAPER_B0:
2623                 if (purpose == DVIPS || purpose == DVIPDFM)
2624                         return string();
2625                 return "b0";
2626         case PAPER_B1:
2627                 if (purpose == DVIPS || purpose == DVIPDFM)
2628                         return string();
2629                 return "b1";
2630         case PAPER_B2:
2631                 if (purpose == DVIPS || purpose == DVIPDFM)
2632                         return string();
2633                 return "b2";
2634         case PAPER_B3:
2635                 if (purpose == DVIPS || purpose == DVIPDFM)
2636                         return string();
2637                 return "b3";
2638         case PAPER_B4:
2639                 // dvipdfm does not know this
2640                 if (purpose == DVIPDFM)
2641                         return string();
2642                 return "b4";
2643         case PAPER_B5:
2644                 if (purpose == DVIPDFM)
2645                         return string();
2646                 return "b5";
2647         case PAPER_B6:
2648                 if (purpose == DVIPS || purpose == DVIPDFM)
2649                         return string();
2650                 return "b6";
2651         case PAPER_C0:
2652                 if (purpose == DVIPS || purpose == DVIPDFM)
2653                         return string();
2654                 return "c0";
2655         case PAPER_C1:
2656                 if (purpose == DVIPS || purpose == DVIPDFM)
2657                         return string();
2658                 return "c1";
2659         case PAPER_C2:
2660                 if (purpose == DVIPS || purpose == DVIPDFM)
2661                         return string();
2662                 return "c2";
2663         case PAPER_C3:
2664                 if (purpose == DVIPS || purpose == DVIPDFM)
2665                         return string();
2666                 return "c3";
2667         case PAPER_C4:
2668                 if (purpose == DVIPS || purpose == DVIPDFM)
2669                         return string();
2670                 return "c4";
2671         case PAPER_C5:
2672                 if (purpose == DVIPS || purpose == DVIPDFM)
2673                         return string();
2674                 return "c5";
2675         case PAPER_C6:
2676                 if (purpose == DVIPS || purpose == DVIPDFM)
2677                         return string();
2678                 return "c6";
2679         case PAPER_JISB0:
2680                 if (purpose == DVIPS || purpose == DVIPDFM)
2681                         return string();
2682                 return "jisb0";
2683         case PAPER_JISB1:
2684                 if (purpose == DVIPS || purpose == DVIPDFM)
2685                         return string();
2686                 return "jisb1";
2687         case PAPER_JISB2:
2688                 if (purpose == DVIPS || purpose == DVIPDFM)
2689                         return string();
2690                 return "jisb2";
2691         case PAPER_JISB3:
2692                 if (purpose == DVIPS || purpose == DVIPDFM)
2693                         return string();
2694                 return "jisb3";
2695         case PAPER_JISB4:
2696                 if (purpose == DVIPS || purpose == DVIPDFM)
2697                         return string();
2698                 return "jisb4";
2699         case PAPER_JISB5:
2700                 if (purpose == DVIPS || purpose == DVIPDFM)
2701                         return string();
2702                 return "jisb5";
2703         case PAPER_JISB6:
2704                 if (purpose == DVIPS || purpose == DVIPDFM)
2705                         return string();
2706                 return "jisb6";
2707         case PAPER_USEXECUTIVE:
2708                 // dvipdfm does not know this
2709                 if (purpose == DVIPDFM)
2710                         return string();
2711                 return "foolscap";
2712         case PAPER_USLEGAL:
2713                 return "legal";
2714         case PAPER_USLETTER:
2715         default:
2716                 if (purpose == XDVI)
2717                         return "us";
2718                 return "letter";
2719         }
2720 }
2721
2722
2723 string const BufferParams::dvips_options() const
2724 {
2725         string result;
2726
2727         // If the class loads the geometry package, we do not know which
2728         // paper size is used, since we do not set it (bug 7013).
2729         // Therefore we must not specify any argument here.
2730         // dvips gets the correct paper size via DVI specials in this case
2731         // (if the class uses the geometry package correctly).
2732         if (documentClass().provides("geometry"))
2733                 return result;
2734
2735         if (use_geometry
2736             && papersize == PAPER_CUSTOM
2737             && !lyxrc.print_paper_dimension_flag.empty()
2738             && !paperwidth.empty()
2739             && !paperheight.empty()) {
2740                 // using a custom papersize
2741                 result = lyxrc.print_paper_dimension_flag;
2742                 result += ' ' + paperwidth;
2743                 result += ',' + paperheight;
2744         } else {
2745                 string const paper_option = paperSizeName(DVIPS);
2746                 if (!paper_option.empty() && (paper_option != "letter" ||
2747                     orientation != ORIENTATION_LANDSCAPE)) {
2748                         // dvips won't accept -t letter -t landscape.
2749                         // In all other cases, include the paper size
2750                         // explicitly.
2751                         result = lyxrc.print_paper_flag;
2752                         result += ' ' + paper_option;
2753                 }
2754         }
2755         if (orientation == ORIENTATION_LANDSCAPE &&
2756             papersize != PAPER_CUSTOM)
2757                 result += ' ' + lyxrc.print_landscape_flag;
2758         return result;
2759 }
2760
2761
2762 string const BufferParams::font_encoding() const
2763 {
2764         return (fontenc == "global") ? lyxrc.fontenc : fontenc;
2765 }
2766
2767
2768 string BufferParams::babelCall(string const & lang_opts, bool const langoptions) const
2769 {
2770         // suppress the babel call if there is no BabelName defined
2771         // for the document language in the lib/languages file and if no
2772         // other languages are used (lang_opts is then empty)
2773         if (lang_opts.empty())
2774                 return string();
2775         // either a specific language (AsBabelOptions setting in
2776         // lib/languages) or the prefs require the languages to
2777         // be submitted to babel itself (not the class).
2778         if (langoptions)
2779                 return "\\usepackage[" + lang_opts + "]{babel}";
2780         return "\\usepackage{babel}";
2781 }
2782
2783
2784 docstring BufferParams::getGraphicsDriver(string const & package) const
2785 {
2786         docstring result;
2787
2788         if (package == "geometry") {
2789                 if (graphics_driver == "dvips"
2790                     || graphics_driver == "dvipdfm"
2791                     || graphics_driver == "pdftex"
2792                     || graphics_driver == "vtex")
2793                         result = from_ascii(graphics_driver);
2794                 else if (graphics_driver == "dvipdfmx")
2795                         result = from_ascii("dvipdfm");
2796         }
2797
2798         return result;
2799 }
2800
2801
2802 void BufferParams::writeEncodingPreamble(otexstream & os,
2803                                          LaTeXFeatures & features) const
2804 {
2805         // XeTeX does not need this
2806         if (features.runparams().flavor == OutputParams::XETEX)
2807                 return;
2808         // LuaTeX neither, but with tex fonts, we need to load
2809         // the luainputenc package.
2810         if (features.runparams().flavor == OutputParams::LUATEX
2811                 || features.runparams().flavor == OutputParams::DVILUATEX) {
2812                 if (!useNonTeXFonts && inputenc != "default"
2813                     && ((inputenc == "auto" && language->encoding()->package() == Encoding::inputenc)
2814                         || (inputenc != "auto" && encoding().package() == Encoding::inputenc))) {
2815                         os << "\\usepackage[utf8]{luainputenc}\n";
2816                 }
2817                 return;
2818         }
2819         if (inputenc == "auto") {
2820                 string const doc_encoding =
2821                         language->encoding()->latexName();
2822                 Encoding::Package const package =
2823                         language->encoding()->package();
2824
2825                 // Create a list with all the input encodings used
2826                 // in the document
2827                 set<string> encodings =
2828                         features.getEncodingSet(doc_encoding);
2829
2830                 // If the "japanese" package (i.e. pLaTeX) is used,
2831                 // inputenc must be omitted.
2832                 // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
2833                 if ((!encodings.empty() || package == Encoding::inputenc)
2834                     && !features.isRequired("japanese")) {
2835                         os << "\\usepackage[";
2836                         set<string>::const_iterator it = encodings.begin();
2837                         set<string>::const_iterator const end = encodings.end();
2838                         if (it != end) {
2839                                 os << from_ascii(*it);
2840                                 ++it;
2841                         }
2842                         for (; it != end; ++it)
2843                                 os << ',' << from_ascii(*it);
2844                         if (package == Encoding::inputenc) {
2845                                 if (!encodings.empty())
2846                                         os << ',';
2847                                 os << from_ascii(doc_encoding);
2848                         }
2849                         os << "]{inputenc}\n";
2850                 }
2851                 if (package == Encoding::CJK || features.mustProvide("CJK")) {
2852                         if (language->encoding()->name() == "utf8-cjk"
2853                             && LaTeXFeatures::isAvailable("CJKutf8"))
2854                                 os << "\\usepackage{CJKutf8}\n";
2855                         else
2856                                 os << "\\usepackage{CJK}\n";
2857                 }
2858         } else if (inputenc != "default") {
2859                 switch (encoding().package()) {
2860                 case Encoding::none:
2861                 case Encoding::japanese:
2862                         break;
2863                 case Encoding::inputenc:
2864                         // do not load inputenc if japanese is used
2865                         if (features.isRequired("japanese"))
2866                                 break;
2867                         os << "\\usepackage[" << from_ascii(encoding().latexName())
2868                            << "]{inputenc}\n";
2869                         break;
2870                 case Encoding::CJK:
2871                         if (encoding().name() == "utf8-cjk"
2872                             && LaTeXFeatures::isAvailable("CJKutf8"))
2873                                 os << "\\usepackage{CJKutf8}\n";
2874                         else
2875                                 os << "\\usepackage{CJK}\n";
2876                         break;
2877                 }
2878                 // Load the CJK package if needed by a secondary language.
2879                 // If the main encoding is some variant of UTF8, use CJKutf8.
2880                 if (encoding().package() != Encoding::CJK && features.mustProvide("CJK")) {
2881                         if (encoding().iconvName() == "UTF-8"
2882                             && LaTeXFeatures::isAvailable("CJKutf8"))
2883                                 os << "\\usepackage{CJKutf8}\n";
2884                         else
2885                                 os << "\\usepackage{CJK}\n";
2886                 }
2887         }
2888 }
2889
2890
2891 string const BufferParams::parseFontName(string const & name) const
2892 {
2893         string mangled = name;
2894         size_t const idx = mangled.find('[');
2895         if (idx == string::npos || idx == 0)
2896                 return mangled;
2897         else
2898                 return mangled.substr(0, idx - 1);
2899 }
2900
2901
2902 string const BufferParams::loadFonts(LaTeXFeatures & features) const
2903 {
2904         if (fonts_roman == "default" && fonts_sans == "default"
2905             && fonts_typewriter == "default"
2906             && (fonts_math == "default" || fonts_math == "auto"))
2907                 //nothing to do
2908                 return string();
2909
2910         ostringstream os;
2911
2912         /* Fontspec (XeTeX, LuaTeX): we provide GUI support for oldstyle
2913          * numbers (Numbers=OldStyle) and sf/tt scaling. The Ligatures=TeX/
2914          * Mapping=tex-text option assures TeX ligatures (such as "--")
2915          * are resolved. Note that tt does not use these ligatures.
2916          * TODO:
2917          *    -- add more GUI options?
2918          *    -- add more fonts (fonts for other scripts)
2919          *    -- if there's a way to find out if a font really supports
2920          *       OldStyle, enable/disable the widget accordingly.
2921         */
2922         if (useNonTeXFonts && features.isAvailable("fontspec")) {
2923                 // "Mapping=tex-text" and "Ligatures=TeX" are equivalent.
2924                 // However, until v.2 (2010/07/11) fontspec only knew
2925                 // Mapping=tex-text (for XeTeX only); then "Ligatures=TeX"
2926                 // was introduced for both XeTeX and LuaTeX (LuaTeX
2927                 // didn't understand "Mapping=tex-text", while XeTeX
2928                 // understood both. With most recent versions, both
2929                 // variants are understood by both engines. However,
2930                 // we want to provide support for at least TeXLive 2009
2931                 // (for XeTeX; LuaTeX is only supported as of v.2)
2932                 string const texmapping =
2933                         (features.runparams().flavor == OutputParams::XETEX) ?
2934                         "Mapping=tex-text" : "Ligatures=TeX";
2935                 if (fonts_roman != "default") {
2936                         os << "\\setmainfont[" << texmapping;
2937                         if (fonts_old_figures)
2938                                 os << ",Numbers=OldStyle";
2939                         os << "]{" << parseFontName(fonts_roman) << "}\n";
2940                 }
2941                 if (fonts_sans != "default") {
2942                         string const sans = parseFontName(fonts_sans);
2943                         if (fonts_sans_scale != 100)
2944                                 os << "\\setsansfont[Scale="
2945                                    << float(fonts_sans_scale) / 100
2946                                    << "," << texmapping << "]{"
2947                                    << sans << "}\n";
2948                         else
2949                                 os << "\\setsansfont[" << texmapping << "]{"
2950                                    << sans << "}\n";
2951                 }
2952                 if (fonts_typewriter != "default") {
2953                         string const mono = parseFontName(fonts_typewriter);
2954                         if (fonts_typewriter_scale != 100)
2955                                 os << "\\setmonofont[Scale="
2956                                    << float(fonts_typewriter_scale) / 100
2957                                    << "]{"
2958                                    << mono << "}\n";
2959                         else
2960                                 os << "\\setmonofont{"
2961                                    << mono << "}\n";
2962                 }
2963                 return os.str();
2964         }
2965
2966         // Tex Fonts
2967         bool const ot1 = (font_encoding() == "default" || font_encoding() == "OT1");
2968         bool const dryrun = features.runparams().dryrun;
2969         bool const complete = (fonts_sans == "default" && fonts_typewriter == "default");
2970         bool const nomath = (fonts_math == "default");
2971
2972         // ROMAN FONTS
2973         os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_roman)).getLaTeXCode(
2974                 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
2975                 nomath);
2976
2977         // SANS SERIF
2978         os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_sans)).getLaTeXCode(
2979                 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
2980                 nomath, fonts_sans_scale);
2981
2982         // MONOSPACED/TYPEWRITER
2983         os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_typewriter)).getLaTeXCode(
2984                 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
2985                 nomath, fonts_typewriter_scale);
2986
2987         // MATH
2988         os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_math)).getLaTeXCode(
2989                 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
2990                 nomath);
2991
2992         return os.str();
2993 }
2994
2995
2996 Encoding const & BufferParams::encoding() const
2997 {
2998         // FIXME: actually, we should check for the flavor
2999         // or runparams.isFullyUnicode() here:
3000         // This check will not work with XeTeX/LuaTeX and tex fonts.
3001         // Thus we have to reset the encoding in Buffer::makeLaTeXFile.
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