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