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