src/BufferParams.cpp

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