src/BufferParams.cpp

   1 /**
   2  * \file BufferParams.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Alfredo Braunstein
   7  * \author Lars Gullik Bjønnes
   8  * \author Jean-Marc Lasgouttes
   9  * \author John Levon
  10  * \author André Pönitz
  11  * \author Martin Vermeer
  12  *
  13  * Full author contact details are available in file CREDITS.
  14  */
  15
  16 #include <config.h>
  17
  18 #include "BufferParams.h"
  19
  20 #include "Author.h"
  21 #include "LayoutFile.h"
  22 #include "BranchList.h"
  23 #include "buffer_funcs.h"
  24 #include "Bullet.h"
  25 #include "Color.h"
  26 #include "Encoding.h"
  27 #include "Language.h"
  28 #include "LaTeXFeatures.h"
  29 #include "ModuleList.h"
  30 #include "Font.h"
  31 #include "Lexer.h"
  32 #include "LyXRC.h"
  33 #include "OutputParams.h"
  34 #include "Spacing.h"
  35 #include "TexRow.h"
  36 #include "VSpace.h"
  37 #include "PDFOptions.h"
  38
  39 #include "frontends/alert.h"
  40
  41 #include "insets/InsetListingsParams.h"
  42
  43 #include "support/convert.h"
  44 #include "support/debug.h"
  45 #include "support/docstream.h"
  46 #include "support/FileName.h"
  47 #include "support/filetools.h"
  48 #include "support/gettext.h"
  49 #include "support/Messages.h"
  50 #include "support/Translator.h"
  51 #include "support/lstrings.h"
  52
  53 #include <algorithm>
  54 #include <sstream>
  55
  56 using namespace std;
  57 using namespace lyx::support;
  58
  59
  60 static char const * const string_paragraph_separation[] = {
  61         "indent", "skip", ""
  62 };
  63
  64
  65 static char const * const string_quotes_language[] = {
  66         "english", "swedish", "german", "polish", "french", "danish", ""
  67 };
  68
  69
  70 static char const * const string_papersize[] = {
  71         "default", "custom", "letterpaper", "legalpaper", "executivepaper",
  72         "a3paper", "a4paper", "a5paper", "b3paper", "b4paper", "b5paper", ""
  73 };
  74
  75
  76 static char const * const string_orientation[] = {
  77         "portrait", "landscape", ""
  78 };
  79
  80
  81 static char const * const string_footnotekinds[] = {
  82         "footnote", "margin", "fig", "tab", "alg", "wide-fig", "wide-tab", ""
  83 };
  84
  85
  86 static char const * const tex_graphics[] = {
  87         "default", "dvialw", "dvilaser", "dvipdf", "dvipdfm", "dvipdfmx",
  88         "dvips", "dvipsone", "dvitops", "dviwin", "dviwindo", "dvi2ps", "emtex",
  89         "ln", "oztex", "pctexhp", "pctexps", "pctexwin", "pctex32", "pdftex",
  90         "psprint", "pubps", "tcidvi", "textures", "truetex", "vtex", "xdvi",
  91         "xetex", "none", ""
  92 };
  93
  94
  95 namespace lyx {
  96
  97 // Local translators
  98 namespace {
  99
 100 // Paragraph separation
 101 typedef Translator<string, BufferParams::ParagraphSeparation> ParSepTranslator;
 102
 103
 104 ParSepTranslator const init_parseptranslator()
 105 {
 106         ParSepTranslator translator
 107                 (string_paragraph_separation[0], BufferParams::ParagraphIndentSeparation);
 108         translator.addPair(string_paragraph_separation[1], BufferParams::ParagraphSkipSeparation);
 109         return translator;
 110 }
 111
 112
 113 ParSepTranslator const & parseptranslator()
 114 {
 115         static ParSepTranslator translator = init_parseptranslator();
 116         return translator;
 117 }
 118
 119
 120 // Quotes language
 121 typedef Translator<string, InsetQuotes::QuoteLanguage> QuotesLangTranslator;
 122
 123
 124 QuotesLangTranslator const init_quoteslangtranslator()
 125 {
 126         QuotesLangTranslator translator
 127                 (string_quotes_language[0], InsetQuotes::EnglishQuotes);
 128         translator.addPair(string_quotes_language[1], InsetQuotes::SwedishQuotes);
 129         translator.addPair(string_quotes_language[2], InsetQuotes::GermanQuotes);
 130         translator.addPair(string_quotes_language[3], InsetQuotes::PolishQuotes);
 131         translator.addPair(string_quotes_language[4], InsetQuotes::FrenchQuotes);
 132         translator.addPair(string_quotes_language[5], InsetQuotes::DanishQuotes);
 133         return translator;
 134 }
 135
 136
 137 QuotesLangTranslator const & quoteslangtranslator()
 138 {
 139         static QuotesLangTranslator translator = init_quoteslangtranslator();
 140         return translator;
 141 }
 142
 143
 144 // Paper size
 145 typedef Translator<string, PAPER_SIZE> PaperSizeTranslator;
 146
 147
 148 static PaperSizeTranslator initPaperSizeTranslator()
 149 {
 150         PaperSizeTranslator translator(string_papersize[0], PAPER_DEFAULT);
 151         translator.addPair(string_papersize[1], PAPER_CUSTOM);
 152         translator.addPair(string_papersize[2], PAPER_USLETTER);
 153         translator.addPair(string_papersize[3], PAPER_USLEGAL);
 154         translator.addPair(string_papersize[4], PAPER_USEXECUTIVE);
 155         translator.addPair(string_papersize[5], PAPER_A3);
 156         translator.addPair(string_papersize[6], PAPER_A4);
 157         translator.addPair(string_papersize[7], PAPER_A5);
 158         translator.addPair(string_papersize[8], PAPER_B3);
 159         translator.addPair(string_papersize[9], PAPER_B4);
 160         translator.addPair(string_papersize[10], PAPER_B5);
 161         return translator;
 162 }
 163
 164
 165 PaperSizeTranslator const & papersizetranslator()
 166 {
 167         static PaperSizeTranslator translator = initPaperSizeTranslator();
 168         return translator;
 169 }
 170
 171
 172 // Paper orientation
 173 typedef Translator<string, PAPER_ORIENTATION> PaperOrientationTranslator;
 174
 175
 176 PaperOrientationTranslator const init_paperorientationtranslator()
 177 {
 178         PaperOrientationTranslator translator(string_orientation[0], ORIENTATION_PORTRAIT);
 179         translator.addPair(string_orientation[1], ORIENTATION_LANDSCAPE);
 180         return translator;
 181 }
 182
 183
 184 PaperOrientationTranslator const & paperorientationtranslator()
 185 {
 186         static PaperOrientationTranslator translator = init_paperorientationtranslator();
 187         return translator;
 188 }
 189
 190
 191 // Page sides
 192 typedef Translator<int, PageSides> SidesTranslator;
 193
 194
 195 SidesTranslator const init_sidestranslator()
 196 {
 197         SidesTranslator translator(1, OneSide);
 198         translator.addPair(2, TwoSides);
 199         return translator;
 200 }
 201
 202
 203 SidesTranslator const & sidestranslator()
 204 {
 205         static SidesTranslator translator = init_sidestranslator();
 206         return translator;
 207 }
 208
 209
 210 // LaTeX packages
 211 typedef Translator<int, BufferParams::Package> PackageTranslator;
 212
 213
 214 PackageTranslator const init_packagetranslator()
 215 {
 216         PackageTranslator translator(0, BufferParams::package_off);
 217         translator.addPair(1, BufferParams::package_auto);
 218         translator.addPair(2, BufferParams::package_on);
 219         return translator;
 220 }
 221
 222
 223 PackageTranslator const & packagetranslator()
 224 {
 225         static PackageTranslator translator = init_packagetranslator();
 226         return translator;
 227 }
 228
 229
 230 // Cite engine
 231 typedef Translator<string, CiteEngine> CiteEngineTranslator;
 232
 233
 234 CiteEngineTranslator const init_citeenginetranslator()
 235 {
 236         CiteEngineTranslator translator("basic", ENGINE_BASIC);
 237         translator.addPair("natbib_numerical", ENGINE_NATBIB_NUMERICAL);
 238         translator.addPair("natbib_authoryear", ENGINE_NATBIB_AUTHORYEAR);
 239         translator.addPair("jurabib", ENGINE_JURABIB);
 240         return translator;
 241 }
 242
 243
 244 CiteEngineTranslator const & citeenginetranslator()
 245 {
 246         static CiteEngineTranslator translator = init_citeenginetranslator();
 247         return translator;
 248 }
 249
 250
 251 // Spacing
 252 typedef Translator<string, Spacing::Space> SpaceTranslator;
 253
 254
 255 SpaceTranslator const init_spacetranslator()
 256 {
 257         SpaceTranslator translator("default", Spacing::Default);
 258         translator.addPair("single", Spacing::Single);
 259         translator.addPair("onehalf", Spacing::Onehalf);
 260         translator.addPair("double", Spacing::Double);
 261         translator.addPair("other", Spacing::Other);
 262         return translator;
 263 }
 264
 265
 266 SpaceTranslator const & spacetranslator()
 267 {
 268         static SpaceTranslator translator = init_spacetranslator();
 269         return translator;
 270 }
 271
 272
 273 } // anon namespace
 274
 275
 276 class BufferParams::Impl
 277 {
 278 public:
 279         Impl();
 280
 281         AuthorList authorlist;
 282         BranchList branchlist;
 283         Bullet temp_bullets[4];
 284         Bullet user_defined_bullets[4];
 285         Spacing spacing;
 286         /** This is the amount of space used for paragraph_separation "skip",
 287          * and for detached paragraphs in "indented" documents.
 288          */
 289         VSpace defskip;
 290         PDFOptions pdfoptions;
 291         LayoutFileIndex baseClass_;
 292 };
 293
 294
 295 BufferParams::Impl::Impl()
 296         : defskip(VSpace::MEDSKIP), baseClass_(string(""))
 297 {
 298         // set initial author
 299         // FIXME UNICODE
 300         authorlist.record(Author(from_utf8(lyxrc.user_name), from_utf8(lyxrc.user_email)));
 301 }
 302
 303
 304 BufferParams::Impl *
 305 BufferParams::MemoryTraits::clone(BufferParams::Impl const * ptr)
 306 {
 307         LASSERT(ptr, /**/);
 308
 309         return new BufferParams::Impl(*ptr);
 310 }
 311
 312
 313 void BufferParams::MemoryTraits::destroy(BufferParams::Impl * ptr)
 314 {
 315         delete ptr;
 316 }
 317
 318
 319 BufferParams::BufferParams()
 320         : pimpl_(new Impl)
 321 {
 322         setBaseClass(defaultBaseclass());
 323         makeDocumentClass();
 324         paragraph_separation = ParagraphIndentSeparation;
 325         quotes_language = InsetQuotes::EnglishQuotes;
 326         fontsize = "default";
 327
 328         /*  PaperLayout */
 329         papersize = PAPER_DEFAULT;
 330         orientation = ORIENTATION_PORTRAIT;
 331         use_geometry = false;
 332         use_amsmath = package_auto;
 333         use_esint = package_auto;
 334         cite_engine_ = ENGINE_BASIC;
 335         use_bibtopic = false;
 336         trackChanges = false;
 337         outputChanges = false;
 338         use_default_options = true;
 339         secnumdepth = 3;
 340         tocdepth = 3;
 341         language = default_language;
 342         fontsRoman = "default";
 343         fontsSans = "default";
 344         fontsTypewriter = "default";
 345         fontsDefaultFamily = "default";
 346         fontsSC = false;
 347         fontsOSF = false;
 348         fontsSansScale = 100;
 349         fontsTypewriterScale = 100;
 350         inputenc = "auto";
 351         graphicsDriver = "default";
 352         sides = OneSide;
 353         columns = 1;
 354         listings_params = string();
 355         pagestyle = "default";
 356         compressed = false;
 357         for (int iter = 0; iter < 4; ++iter) {
 358                 user_defined_bullet(iter) = ITEMIZE_DEFAULTS[iter];
 359                 temp_bullet(iter) = ITEMIZE_DEFAULTS[iter];
 360         }
 361 }
 362
 363
 364 docstring BufferParams::B_(string const & l10n) const
 365 {
 366         LASSERT(language, /**/);
 367         return getMessages(language->code()).get(l10n);
 368 }
 369
 370
 371 AuthorList & BufferParams::authors()
 372 {
 373         return pimpl_->authorlist;
 374 }
 375
 376
 377 AuthorList const & BufferParams::authors() const
 378 {
 379         return pimpl_->authorlist;
 380 }
 381
 382
 383 BranchList & BufferParams::branchlist()
 384 {
 385         return pimpl_->branchlist;
 386 }
 387
 388
 389 BranchList const & BufferParams::branchlist() const
 390 {
 391         return pimpl_->branchlist;
 392 }
 393
 394
 395 Bullet & BufferParams::temp_bullet(lyx::size_type const index)
 396 {
 397         LASSERT(index < 4, /**/);
 398         return pimpl_->temp_bullets[index];
 399 }
 400
 401
 402 Bullet const & BufferParams::temp_bullet(lyx::size_type const index) const
 403 {
 404         LASSERT(index < 4, /**/);
 405         return pimpl_->temp_bullets[index];
 406 }
 407
 408
 409 Bullet & BufferParams::user_defined_bullet(lyx::size_type const index)
 410 {
 411         LASSERT(index < 4, /**/);
 412         return pimpl_->user_defined_bullets[index];
 413 }
 414
 415
 416 Bullet const & BufferParams::user_defined_bullet(lyx::size_type const index) const
 417 {
 418         LASSERT(index < 4, /**/);
 419         return pimpl_->user_defined_bullets[index];
 420 }
 421
 422
 423 Spacing & BufferParams::spacing()
 424 {
 425         return pimpl_->spacing;
 426 }
 427
 428
 429 Spacing const & BufferParams::spacing() const
 430 {
 431         return pimpl_->spacing;
 432 }
 433
 434
 435 PDFOptions & BufferParams::pdfoptions()
 436 {
 437         return pimpl_->pdfoptions;
 438 }
 439
 440
 441 PDFOptions const & BufferParams::pdfoptions() const
 442 {
 443         return pimpl_->pdfoptions;
 444 }
 445
 446
 447 VSpace const & BufferParams::getDefSkip() const
 448 {
 449         return pimpl_->defskip;
 450 }
 451
 452
 453 void BufferParams::setDefSkip(VSpace const & vs)
 454 {
 455         pimpl_->defskip = vs;
 456 }
 457
 458
 459 string BufferParams::readToken(Lexer & lex, string const & token,
 460         FileName const & filepath)
 461 {
 462         if (token == "\\textclass") {
 463                 lex.next();
 464                 string const classname = lex.getString();
 465                 // if there exists a local layout file, ignore the system one
 466                 // NOTE: in this case, the textclass (.cls file) is assumed to be available.
 467                 string tcp;
 468                 LayoutFileList & bcl = LayoutFileList::get();
 469                 if (tcp.empty() && !filepath.empty())
 470                         tcp = bcl.addLocalLayout(classname, filepath.absFilename());
 471                 if (!tcp.empty())
 472                         setBaseClass(tcp);
 473                 else
 474                         setBaseClass(classname);
 475                 // We assume that a tex class exists for local or unknown layouts so this warning
 476                 // will only be given for system layouts.
 477                 if (!baseClass()->isTeXClassAvailable()) {
 478                         docstring const msg =
 479                                 bformat(_("The layout file requested by this document,\n"
 480                                                  "%1$s.layout,\n"
 481                                                  "is not usable. This is probably because a LaTeX\n"
 482                                                  "class or style file required by it is not\n"
 483                                                  "available. See the Customization documentation\n"
 484                                                  "for more information.\n"), from_utf8(classname));
 485                         frontend::Alert::warning(_("Document class not available"),
 486                                        msg + _("LyX will not be able to produce output."));
 487                 }
 488         } else if (token == "\\begin_preamble") {
 489                 readPreamble(lex);
 490         } else if (token == "\\begin_local_layout") {
 491                 readLocalLayout(lex);
 492         } else if (token == "\\begin_modules") {
 493                 readModules(lex);
 494         } else if (token == "\\begin_removed_modules") {
 495                 readRemovedModules(lex);
 496         } else if (token == "\\options") {
 497                 lex.eatLine();
 498                 options = lex.getString();
 499         } else if (token == "\\use_default_options") {
 500                 lex >> use_default_options;
 501         } else if (token == "\\master") {
 502                 lex.eatLine();
 503                 master = lex.getString();
 504         } else if (token == "\\language") {
 505                 readLanguage(lex);
 506         } else if (token == "\\inputencoding") {
 507                 lex >> inputenc;
 508         } else if (token == "\\graphics") {
 509                 readGraphicsDriver(lex);
 510         } else if (token == "\\font_roman") {
 511                 lex >> fontsRoman;
 512         } else if (token == "\\font_sans") {
 513                 lex >> fontsSans;
 514         } else if (token == "\\font_typewriter") {
 515                 lex >> fontsTypewriter;
 516         } else if (token == "\\font_default_family") {
 517                 lex >> fontsDefaultFamily;
 518         } else if (token == "\\font_sc") {
 519                 lex >> fontsSC;
 520         } else if (token == "\\font_osf") {
 521                 lex >> fontsOSF;
 522         } else if (token == "\\font_sf_scale") {
 523                 lex >> fontsSansScale;
 524         } else if (token == "\\font_tt_scale") {
 525                 lex >> fontsTypewriterScale;
 526         } else if (token == "\\font_cjk") {
 527                 lex >> fontsCJK;
 528         } else if (token == "\\paragraph_separation") {
 529                 string parsep;
 530                 lex >> parsep;
 531                 paragraph_separation = parseptranslator().find(parsep);
 532         } else if (token == "\\defskip") {
 533                 lex.next();
 534                 string defskip = lex.getString();
 535                 if (defskip == "defskip")
 536                         // this is invalid
 537                         defskip = "medskip";
 538                 pimpl_->defskip = VSpace(defskip);
 539         } else if (token == "\\quotes_language") {
 540                 string quotes_lang;
 541                 lex >> quotes_lang;
 542                 quotes_language = quoteslangtranslator().find(quotes_lang);
 543         } else if (token == "\\papersize") {
 544                 string ppsize;
 545                 lex >> ppsize;
 546                 papersize = papersizetranslator().find(ppsize);
 547         } else if (token == "\\use_geometry") {
 548                 lex >> use_geometry;
 549         } else if (token == "\\use_amsmath") {
 550                 int use_ams;
 551                 lex >> use_ams;
 552                 use_amsmath = packagetranslator().find(use_ams);
 553         } else if (token == "\\use_esint") {
 554                 int useesint;
 555                 lex >> useesint;
 556                 use_esint = packagetranslator().find(useesint);
 557         } else if (token == "\\cite_engine") {
 558                 string engine;
 559                 lex >> engine;
 560                 cite_engine_ = citeenginetranslator().find(engine);
 561         } else if (token == "\\use_bibtopic") {
 562                 lex >> use_bibtopic;
 563         } else if (token == "\\tracking_changes") {
 564                 lex >> trackChanges;
 565         } else if (token == "\\output_changes") {
 566                 lex >> outputChanges;
 567         } else if (token == "\\branch") {
 568                 lex.next();
 569                 docstring branch = lex.getDocString();
 570                 branchlist().add(branch);
 571                 while (true) {
 572                         lex.next();
 573                         string const tok = lex.getString();
 574                         if (tok == "\\end_branch")
 575                                 break;
 576                         Branch * branch_ptr = branchlist().find(branch);
 577                         if (tok == "\\selected") {
 578                                 lex.next();
 579                                 if (branch_ptr)
 580                                         branch_ptr->setSelected(lex.getInteger());
 581                         }
 582                         // not yet operational
 583                         if (tok == "\\color") {
 584                                 lex.eatLine();
 585                                 string color = lex.getString();
 586                                 if (branch_ptr)
 587                                         branch_ptr->setColor(color);
 588                                 // Update also the Color table:
 589                                 if (color == "none")
 590                                         color = lcolor.getX11Name(Color_background);
 591                                 // FIXME UNICODE
 592                                 lcolor.setColor(to_utf8(branch), color);
 593
 594                         }
 595                 }
 596         } else if (token == "\\author") {
 597                 lex.eatLine();
 598                 istringstream ss(lex.getString());
 599                 Author a;
 600                 ss >> a;
 601                 author_map.push_back(pimpl_->authorlist.record(a));
 602         } else if (token == "\\paperorientation") {
 603                 string orient;
 604                 lex >> orient;
 605                 orientation = paperorientationtranslator().find(orient);
 606         } else if (token == "\\paperwidth") {
 607                 lex >> paperwidth;
 608         } else if (token == "\\paperheight") {
 609                 lex >> paperheight;
 610         } else if (token == "\\leftmargin") {
 611                 lex >> leftmargin;
 612         } else if (token == "\\topmargin") {
 613                 lex >> topmargin;
 614         } else if (token == "\\rightmargin") {
 615                 lex >> rightmargin;
 616         } else if (token == "\\bottommargin") {
 617                 lex >> bottommargin;
 618         } else if (token == "\\headheight") {
 619                 lex >> headheight;
 620         } else if (token == "\\headsep") {
 621                 lex >> headsep;
 622         } else if (token == "\\footskip") {
 623                 lex >> footskip;
 624         } else if (token == "\\columnsep") {
 625                 lex >> columnsep;
 626         } else if (token == "\\paperfontsize") {
 627                 lex >> fontsize;
 628         } else if (token == "\\papercolumns") {
 629                 lex >> columns;
 630         } else if (token == "\\listings_params") {
 631                 string par;
 632                 lex >> par;
 633                 listings_params = InsetListingsParams(par).params();
 634         } else if (token == "\\papersides") {
 635                 int psides;
 636                 lex >> psides;
 637                 sides = sidestranslator().find(psides);
 638         } else if (token == "\\paperpagestyle") {
 639                 lex >> pagestyle;
 640         } else if (token == "\\bullet") {
 641                 readBullets(lex);
 642         } else if (token == "\\bulletLaTeX") {
 643                 readBulletsLaTeX(lex);
 644         } else if (token == "\\secnumdepth") {
 645                 lex >> secnumdepth;
 646         } else if (token == "\\tocdepth") {
 647                 lex >> tocdepth;
 648         } else if (token == "\\spacing") {
 649                 string nspacing;
 650                 lex >> nspacing;
 651                 string tmp_val;
 652                 if (nspacing == "other") {
 653                         lex >> tmp_val;
 654                 }
 655                 spacing().set(spacetranslator().find(nspacing), tmp_val);
 656         } else if (token == "\\float_placement") {
 657                 lex >> float_placement;
 658
 659         } else if (prefixIs(token, "\\pdf_") || token == "\\use_hyperref") {
 660                 string toktmp = pdfoptions().readToken(lex, token);
 661                 if (!toktmp.empty()) {
 662                         lyxerr << "PDFOptions::readToken(): Unknown token: " <<
 663                                 toktmp << endl;
 664                         return toktmp;
 665                 }
 666         } else {
 667                 lyxerr << "BufferParams::readToken(): Unknown token: " <<
 668                         token << endl;
 669                 return token;
 670         }
 671
 672         return string();
 673 }
 674
 675
 676 void BufferParams::writeFile(ostream & os) const
 677 {
 678         // The top of the file is written by the buffer.
 679         // Prints out the buffer info into the .lyx file given by file
 680
 681         // the textclass
 682         os << "\\textclass " << baseClass()->name() << '\n';
 683
 684         // then the preamble
 685         if (!preamble.empty()) {
 686                 // remove '\n' from the end of preamble
 687                 string const tmppreamble = rtrim(preamble, "\n");
 688                 os << "\\begin_preamble\n"
 689                    << tmppreamble
 690                    << "\n\\end_preamble\n";
 691         }
 692
 693         // the options
 694         if (!options.empty()) {
 695                 os << "\\options " << options << '\n';
 696         }
 697
 698         // use the class options defined in the layout?
 699         os << "\\use_default_options "
 700            << convert<string>(use_default_options) << "\n";
 701
 702         // the master document
 703         if (!master.empty()) {
 704                 os << "\\master " << master << '\n';
 705         }
 706
 707         // removed modules
 708         if (!removedModules_.empty()) {
 709                 os << "\\begin_removed_modules" << '\n';
 710                 set<string>::const_iterator it = removedModules_.begin();
 711                 set<string>::const_iterator en = removedModules_.end();
 712                 for (; it != en; it++)
 713                         os << *it << '\n';
 714                 os << "\\end_removed_modules" << '\n';
 715         }
 716
 717         // the modules
 718         if (!layoutModules_.empty()) {
 719                 os << "\\begin_modules" << '\n';
 720                 LayoutModuleList::const_iterator it = layoutModules_.begin();
 721                 LayoutModuleList::const_iterator en = layoutModules_.end();
 722                 for (; it != en; it++)
 723                         os << *it << '\n';
 724                 os << "\\end_modules" << '\n';
 725         }
 726
 727         // local layout information
 728         if (!local_layout.empty()) {
 729                 // remove '\n' from the end
 730                 string const tmplocal = rtrim(local_layout, "\n");
 731                 os << "\\begin_local_layout\n"
 732                    << tmplocal
 733                    << "\n\\end_local_layout\n";
 734         }
 735
 736         // then the text parameters
 737         if (language != ignore_language)
 738                 os << "\\language " << language->lang() << '\n';
 739         os << "\\inputencoding " << inputenc
 740            << "\n\\font_roman " << fontsRoman
 741            << "\n\\font_sans " << fontsSans
 742            << "\n\\font_typewriter " << fontsTypewriter
 743            << "\n\\font_default_family " << fontsDefaultFamily
 744            << "\n\\font_sc " << convert<string>(fontsSC)
 745            << "\n\\font_osf " << convert<string>(fontsOSF)
 746            << "\n\\font_sf_scale " << fontsSansScale
 747            << "\n\\font_tt_scale " << fontsTypewriterScale
 748            << '\n';
 749         if (!fontsCJK.empty()) {
 750                 os << "\\font_cjk " << fontsCJK << '\n';
 751         }
 752         os << "\n\\graphics " << graphicsDriver << '\n';
 753
 754         if (!float_placement.empty()) {
 755                 os << "\\float_placement " << float_placement << '\n';
 756         }
 757         os << "\\paperfontsize " << fontsize << '\n';
 758
 759         spacing().writeFile(os);
 760         pdfoptions().writeFile(os);
 761
 762         os << "\\papersize " << string_papersize[papersize]
 763            << "\n\\use_geometry " << convert<string>(use_geometry)
 764            << "\n\\use_amsmath " << use_amsmath
 765            << "\n\\use_esint " << use_esint
 766            << "\n\\cite_engine " << citeenginetranslator().find(cite_engine_)
 767            << "\n\\use_bibtopic " << convert<string>(use_bibtopic)
 768            << "\n\\paperorientation " << string_orientation[orientation]
 769            << '\n';
 770
 771         BranchList::const_iterator it = branchlist().begin();
 772         BranchList::const_iterator end = branchlist().end();
 773         for (; it != end; ++it) {
 774                 os << "\\branch " << to_utf8(it->branch())
 775                    << "\n\\selected " << it->isSelected()
 776                    << "\n\\color " << lyx::X11hexname(it->color())
 777                    << "\n\\end_branch"
 778                    << "\n";
 779         }
 780
 781         if (!paperwidth.empty())
 782                 os << "\\paperwidth "
 783                    << VSpace(paperwidth).asLyXCommand() << '\n';
 784         if (!paperheight.empty())
 785                 os << "\\paperheight "
 786                    << VSpace(paperheight).asLyXCommand() << '\n';
 787         if (!leftmargin.empty())
 788                 os << "\\leftmargin "
 789                    << VSpace(leftmargin).asLyXCommand() << '\n';
 790         if (!topmargin.empty())
 791                 os << "\\topmargin "
 792                    << VSpace(topmargin).asLyXCommand() << '\n';
 793         if (!rightmargin.empty())
 794                 os << "\\rightmargin "
 795                    << VSpace(rightmargin).asLyXCommand() << '\n';
 796         if (!bottommargin.empty())
 797                 os << "\\bottommargin "
 798                    << VSpace(bottommargin).asLyXCommand() << '\n';
 799         if (!headheight.empty())
 800                 os << "\\headheight "
 801                    << VSpace(headheight).asLyXCommand() << '\n';
 802         if (!headsep.empty())
 803                 os << "\\headsep "
 804                    << VSpace(headsep).asLyXCommand() << '\n';
 805         if (!footskip.empty())
 806                 os << "\\footskip "
 807                    << VSpace(footskip).asLyXCommand() << '\n';
 808         if (!columnsep.empty())
 809                 os << "\\columnsep "
 810                          << VSpace(columnsep).asLyXCommand() << '\n';
 811         os << "\\secnumdepth " << secnumdepth
 812            << "\n\\tocdepth " << tocdepth
 813            << "\n\\paragraph_separation "
 814            << string_paragraph_separation[paragraph_separation]
 815            << "\n\\defskip " << getDefSkip().asLyXCommand()
 816            << "\n\\quotes_language "
 817            << string_quotes_language[quotes_language]
 818            << "\n\\papercolumns " << columns
 819            << "\n\\papersides " << sides
 820            << "\n\\paperpagestyle " << pagestyle << '\n';
 821         if (!listings_params.empty())
 822                 os << "\\listings_params \"" <<
 823                         InsetListingsParams(listings_params).encodedString() << "\"\n";
 824         for (int i = 0; i < 4; ++i) {
 825                 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
 826                         if (user_defined_bullet(i).getFont() != -1) {
 827                                 os << "\\bullet " << i << " "
 828                                    << user_defined_bullet(i).getFont() << " "
 829                                    << user_defined_bullet(i).getCharacter() << " "
 830                                    << user_defined_bullet(i).getSize() << "\n";
 831                         }
 832                         else {
 833                                 // FIXME UNICODE
 834                                 os << "\\bulletLaTeX " << i << " \""
 835                                    << lyx::to_ascii(user_defined_bullet(i).getText())
 836                                    << "\"\n";
 837                         }
 838                 }
 839         }
 840
 841         os << "\\tracking_changes " << convert<string>(trackChanges) << "\n";
 842         os << "\\output_changes " << convert<string>(outputChanges) << "\n";
 843
 844         AuthorList::Authors::const_iterator a_it = pimpl_->authorlist.begin();
 845         AuthorList::Authors::const_iterator a_end = pimpl_->authorlist.end();
 846         for (; a_it != a_end; ++a_it) {
 847                 if (a_it->second.used())
 848                         os << "\\author " << a_it->second << "\n";
 849                 else
 850                         os << "\\author " << Author() << "\n";
 851         }
 852 }
 853
 854
 855 void BufferParams::validate(LaTeXFeatures & features) const
 856 {
 857         features.require(documentClass().requires());
 858
 859         if (outputChanges) {
 860                 bool dvipost    = LaTeXFeatures::isAvailable("dvipost");
 861                 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
 862                                   LaTeXFeatures::isAvailable("xcolor");
 863
 864                 switch (features.runparams().flavor) {
 865                 case OutputParams::LATEX:
 866                         if (dvipost) {
 867                                 features.require("ct-dvipost");
 868                                 features.require("dvipost");
 869                         } else if (xcolorsoul) {
 870                                 features.require("ct-xcolor-soul");
 871                                 features.require("soul");
 872                                 features.require("xcolor");
 873                         } else {
 874                                 features.require("ct-none");
 875                         }
 876                         break;
 877                 case OutputParams::PDFLATEX:
 878                         if (xcolorsoul) {
 879                                 features.require("ct-xcolor-soul");
 880                                 features.require("soul");
 881                                 features.require("xcolor");
 882                                 // improves color handling in PDF output
 883                                 features.require("pdfcolmk");
 884                         } else {
 885                                 features.require("ct-none");
 886                         }
 887                         break;
 888                 default:
 889                         break;
 890                 }
 891         }
 892
 893         // Floats with 'Here definitely' as default setting.
 894         if (float_placement.find('H') != string::npos)
 895                 features.require("float");
 896
 897         // AMS Style is at document level
 898         if (use_amsmath == package_on
 899             || documentClass().provides("amsmath"))
 900                 features.require("amsmath");
 901         if (use_esint == package_on)
 902                 features.require("esint");
 903
 904         // Document-level line spacing
 905         if (spacing().getSpace() != Spacing::Single && !spacing().isDefault())
 906                 features.require("setspace");
 907
 908         // the bullet shapes are buffer level not paragraph level
 909         // so they are tested here
 910         for (int i = 0; i < 4; ++i) {
 911                 if (user_defined_bullet(i) == ITEMIZE_DEFAULTS[i])
 912                         continue;
 913                 int const font = user_defined_bullet(i).getFont();
 914                 if (font == 0) {
 915                         int const c = user_defined_bullet(i).getCharacter();
 916                         if (c == 16
 917                             || c == 17
 918                             || c == 25
 919                             || c == 26
 920                             || c == 31) {
 921                                 features.require("latexsym");
 922                         }
 923                 } else if (font == 1) {
 924                         features.require("amssymb");
 925                 } else if (font >= 2 && font <= 5) {
 926                         features.require("pifont");
 927                 }
 928         }
 929
 930         if (pdfoptions().use_hyperref) {
 931                 features.require("hyperref");
 932                 // due to interferences with babel and hyperref, the color package has to
 933                 // be loaded after hyperref when hyperref is used with the colorlinks
 934                 // option, see http://bugzilla.lyx.org/show_bug.cgi?id=5291
 935                 if (pdfoptions().colorlinks)
 936                         features.require("color");
 937         }
 938
 939         if (language->lang() == "vietnamese")
 940                 features.require("vietnamese");
 941         else if (language->lang() == "japanese")
 942                 features.require("japanese");
 943 }
 944
 945
 946 bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
 947                               TexRow & texrow) const
 948 {
 949         os << "\\documentclass";
 950
 951         DocumentClass const & tclass = documentClass();
 952
 953         ostringstream clsoptions; // the document class options.
 954
 955         if (tokenPos(tclass.opt_fontsize(),
 956                      '|', fontsize) >= 0) {
 957                 // only write if existing in list (and not default)
 958                 clsoptions << fontsize << "pt,";
 959         }
 960
 961         // custom, A3, B3 and B4 paper sizes need geometry
 962         bool nonstandard_papersize = papersize == PAPER_B3
 963                 || papersize == PAPER_B4
 964                 || papersize == PAPER_A3
 965                 || papersize == PAPER_CUSTOM;
 966
 967         if (!use_geometry) {
 968                 switch (papersize) {
 969                 case PAPER_A4:
 970                         clsoptions << "a4paper,";
 971                         break;
 972                 case PAPER_USLETTER:
 973                         clsoptions << "letterpaper,";
 974                         break;
 975                 case PAPER_A5:
 976                         clsoptions << "a5paper,";
 977                         break;
 978                 case PAPER_B5:
 979                         clsoptions << "b5paper,";
 980                         break;
 981                 case PAPER_USEXECUTIVE:
 982                         clsoptions << "executivepaper,";
 983                         break;
 984                 case PAPER_USLEGAL:
 985                         clsoptions << "legalpaper,";
 986                         break;
 987                 case PAPER_DEFAULT:
 988                 case PAPER_A3:
 989                 case PAPER_B3:
 990                 case PAPER_B4:
 991                 case PAPER_CUSTOM:
 992                         break;
 993                 }
 994         }
 995
 996         // if needed
 997         if (sides != tclass.sides()) {
 998                 switch (sides) {
 999                 case OneSide:
1000                         clsoptions << "oneside,";
1001                         break;
1002                 case TwoSides:
1003                         clsoptions << "twoside,";
1004                         break;
1005                 }
1006         }
1007
1008         // if needed
1009         if (columns != tclass.columns()) {
1010                 if (columns == 2)
1011                         clsoptions << "twocolumn,";
1012                 else
1013                         clsoptions << "onecolumn,";
1014         }
1015
1016         if (!use_geometry
1017             && orientation == ORIENTATION_LANDSCAPE)
1018                 clsoptions << "landscape,";
1019
1020         // language should be a parameter to \documentclass
1021         if (language->babel() == "hebrew"
1022             && default_language->babel() != "hebrew")
1023                 // This seems necessary
1024                 features.useLanguage(default_language);
1025
1026         ostringstream language_options;
1027         bool const use_babel = features.useBabel();
1028         if (use_babel) {
1029                 language_options << features.getLanguages();
1030                 if (!language->babel().empty()) {
1031                         if (!language_options.str().empty())
1032                                 language_options << ',';
1033                         language_options << language->babel();
1034                 }
1035                 // if Vietnamese is used, babel must directly be loaded
1036                 // with language options, not in the class options, see
1037                 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129417.html
1038                 size_t viet = language_options.str().find("vietnam");
1039                 // viet = string::npos when not found
1040                 // the same is for all other languages that are not directly supported by
1041                 // babel, but where LaTeX-packages add babel support.
1042                 // this is currently the case for Latvian, Lithuanian, and Mongolian
1043                 size_t latvian = language_options.str().find("latvian");
1044                 size_t lithu = language_options.str().find("lithuanian");
1045                 size_t mongo = language_options.str().find("mongolian");
1046                 // if Japanese is used, babel must directly be loaded
1047                 // with language options, not in the class options, see
1048                 // http://bugzilla.lyx.org/show_bug.cgi?id=4597#c4
1049                 size_t japan = language_options.str().find("japanese");
1050                 if (lyxrc.language_global_options && !language_options.str().empty()
1051                         && viet == string::npos && japan == string::npos
1052                         && latvian == string::npos && lithu == string::npos
1053                         && mongo == string::npos)
1054                         clsoptions << language_options.str() << ',';
1055         }
1056
1057         // the predefined options from the layout
1058         if (use_default_options && !tclass.options().empty())
1059                 clsoptions << tclass.options() << ',';
1060
1061         // the user-defined options
1062         if (!options.empty()) {
1063                 clsoptions << options << ',';
1064         }
1065
1066         string strOptions(clsoptions.str());
1067         if (!strOptions.empty()) {
1068                 strOptions = rtrim(strOptions, ",");
1069                 // FIXME UNICODE
1070                 os << '[' << from_utf8(strOptions) << ']';
1071         }
1072
1073         os << '{' << from_ascii(tclass.latexname()) << "}\n";
1074         texrow.newline();
1075         // end of \documentclass defs
1076
1077         // font selection must be done before loading fontenc.sty
1078         string const fonts =
1079                 loadFonts(fontsRoman, fontsSans,
1080                           fontsTypewriter, fontsSC, fontsOSF,
1081                           fontsSansScale, fontsTypewriterScale);
1082         if (!fonts.empty()) {
1083                 os << from_ascii(fonts);
1084                 texrow.newline();
1085         }
1086         if (fontsDefaultFamily != "default")
1087                 os << "\\renewcommand{\\familydefault}{\\"
1088                    << from_ascii(fontsDefaultFamily) << "}\n";
1089
1090         // set font encoding
1091         // this one is not per buffer
1092         // for arabic_arabi and farsi we also need to load the LAE and
1093         // LFE encoding
1094         if (lyxrc.fontenc != "default" && language->lang() != "japanese") {
1095                 if (language->lang() == "arabic_arabi"
1096                     || language->lang() == "farsi") {
1097                         os << "\\usepackage[" << from_ascii(lyxrc.fontenc)
1098                            << ",LFE,LAE]{fontenc}\n";
1099                         texrow.newline();
1100                 } else {
1101                         os << "\\usepackage[" << from_ascii(lyxrc.fontenc)
1102                            << "]{fontenc}\n";
1103                         texrow.newline();
1104                 }
1105         }
1106
1107         // handle inputenc etc.
1108         writeEncodingPreamble(os, features, texrow);
1109
1110         if (!listings_params.empty() || features.isRequired("listings")) {
1111                 os << "\\usepackage{listings}\n";
1112                 texrow.newline();
1113         }
1114         if (!listings_params.empty()) {
1115                 os << "\\lstset{";
1116                 // do not test validity because listings_params is
1117                 // supposed to be valid
1118                 string par =
1119                         InsetListingsParams(listings_params).separatedParams(true);
1120                 // we can't support all packages, but we should load the color package
1121                 if (par.find("\\color", 0) != string::npos)
1122                         features.require("color");
1123                 os << from_utf8(par);
1124                 // count the number of newlines
1125                 for (size_t i = 0; i < par.size(); ++i)
1126                         if (par[i] == '\n')
1127                                 texrow.newline();
1128                 os << "}\n";
1129                 texrow.newline();
1130         }
1131         if (use_geometry || nonstandard_papersize) {
1132                 os << "\\usepackage{geometry}\n";
1133                 texrow.newline();
1134                 os << "\\geometry{verbose";
1135                 if (orientation == ORIENTATION_LANDSCAPE)
1136                         os << ",landscape";
1137                 switch (papersize) {
1138                 case PAPER_CUSTOM:
1139                         if (!paperwidth.empty())
1140                                 os << ",paperwidth="
1141                                    << from_ascii(paperwidth);
1142                         if (!paperheight.empty())
1143                                 os << ",paperheight="
1144                                    << from_ascii(paperheight);
1145                         break;
1146                 case PAPER_USLETTER:
1147                         os << ",letterpaper";
1148                         break;
1149                 case PAPER_USLEGAL:
1150                         os << ",legalpaper";
1151                         break;
1152                 case PAPER_USEXECUTIVE:
1153                         os << ",executivepaper";
1154                         break;
1155                 case PAPER_A3:
1156                         os << ",a3paper";
1157                         break;
1158                 case PAPER_A4:
1159                         os << ",a4paper";
1160                         break;
1161                 case PAPER_A5:
1162                         os << ",a5paper";
1163                         break;
1164                 case PAPER_B3:
1165                         os << ",b3paper";
1166                         break;
1167                 case PAPER_B4:
1168                         os << ",b4paper";
1169                         break;
1170                 case PAPER_B5:
1171                         os << ",b5paper";
1172                         break;
1173                 default:
1174                         // default papersize ie PAPER_DEFAULT
1175                         switch (lyxrc.default_papersize) {
1176                         case PAPER_DEFAULT: // keep compiler happy
1177                         case PAPER_USLETTER:
1178                                 os << ",letterpaper";
1179                                 break;
1180                         case PAPER_USLEGAL:
1181                                 os << ",legalpaper";
1182                                 break;
1183                         case PAPER_USEXECUTIVE:
1184                                 os << ",executivepaper";
1185                                 break;
1186                         case PAPER_A3:
1187                                 os << ",a3paper";
1188                                 break;
1189                         case PAPER_A4:
1190                                 os << ",a4paper";
1191                                 break;
1192                         case PAPER_A5:
1193                                 os << ",a5paper";
1194                                 break;
1195                         case PAPER_B5:
1196                                 os << ",b5paper";
1197                                 break;
1198                         case PAPER_B3:
1199                         case PAPER_B4:
1200                         case PAPER_CUSTOM:
1201                                 break;
1202                         }
1203                 }
1204                 if (!topmargin.empty())
1205                         os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1206                 if (!bottommargin.empty())
1207                         os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1208                 if (!leftmargin.empty())
1209                         os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1210                 if (!rightmargin.empty())
1211                         os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1212                 if (!headheight.empty())
1213                         os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1214                 if (!headsep.empty())
1215                         os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1216                 if (!footskip.empty())
1217                         os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1218                 if (!columnsep.empty())
1219                         os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
1220                 os << "}\n";
1221                 texrow.newline();
1222         } else if (orientation == ORIENTATION_LANDSCAPE) {
1223                 features.require("papersize");
1224         }
1225
1226         if (tokenPos(tclass.opt_pagestyle(),
1227                      '|', pagestyle) >= 0) {
1228                 if (pagestyle == "fancy") {
1229                         os << "\\usepackage{fancyhdr}\n";
1230                         texrow.newline();
1231                 }
1232                 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1233                 texrow.newline();
1234         }
1235
1236         // Only if class has a ToC hierarchy
1237         if (tclass.hasTocLevels()) {
1238                 if (secnumdepth != tclass.secnumdepth()) {
1239                         os << "\\setcounter{secnumdepth}{"
1240                            << secnumdepth
1241                            << "}\n";
1242                         texrow.newline();
1243                 }
1244                 if (tocdepth != tclass.tocdepth()) {
1245                         os << "\\setcounter{tocdepth}{"
1246                            << tocdepth
1247                            << "}\n";
1248                         texrow.newline();
1249                 }
1250         }
1251
1252         if (paragraph_separation) {
1253                 switch (getDefSkip().kind()) {
1254                 case VSpace::SMALLSKIP:
1255                         os << "\\setlength{\\parskip}{\\smallskipamount}\n";
1256                         break;
1257                 case VSpace::MEDSKIP:
1258                         os << "\\setlength{\\parskip}{\\medskipamount}\n";
1259                         break;
1260                 case VSpace::BIGSKIP:
1261                         os << "\\setlength{\\parskip}{\\bigskipamount}\n";
1262                         break;
1263                 case VSpace::LENGTH:
1264                         os << "\\setlength{\\parskip}{"
1265                            << from_utf8(getDefSkip().length().asLatexString())
1266                            << "}\n";
1267                         break;
1268                 default: // should never happen // Then delete it.
1269                         os << "\\setlength{\\parskip}{\\medskipamount}\n";
1270                         break;
1271                 }
1272                 texrow.newline();
1273
1274                 os << "\\setlength{\\parindent}{0pt}\n";
1275                 texrow.newline();
1276         }
1277
1278         // Now insert the LyX specific LaTeX commands...
1279         docstring lyxpreamble;
1280
1281         // due to interferences with babel and hyperref, the color package has to
1282         // be loaded (when it is not already loaded) before babel when hyperref
1283         // is used with the colorlinks option, see
1284         // http://bugzilla.lyx.org/show_bug.cgi?id=5291
1285         // we decided therefore to load color always before babel, see
1286         // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
1287         lyxpreamble += from_ascii(features.getColorOptions());
1288
1289         // If we use hyperref, jurabib, japanese, or vietnamese, we have to call babel before them.
1290         if (use_babel
1291                 && (features.isRequired("jurabib")
1292                         || features.isRequired("hyperref")
1293                         || features.isRequired("vietnamese")
1294                         || features.isRequired("japanese") ) ) {
1295                                 // FIXME UNICODE
1296                                 lyxpreamble += from_utf8(babelCall(language_options.str())) + '\n';
1297                                 lyxpreamble += from_utf8(features.getBabelOptions()) + '\n';
1298         }
1299
1300         // The optional packages;
1301         lyxpreamble += from_ascii(features.getPackages());
1302
1303         // Line spacing
1304         lyxpreamble += from_utf8(spacing().writePreamble(tclass.provides("SetSpace")));
1305
1306         // PDF support.
1307         // * Hyperref manual: "Make sure it comes last of your loaded
1308         //   packages, to give it a fighting chance of not being over-written,
1309         //   since its job is to redefine many LaTeX commands."
1310         // * Email from Heiko Oberdiek: "It is usually better to load babel
1311         //   before hyperref. Then hyperref has a chance to detect babel.
1312         // * Has to be loaded before the "LyX specific LaTeX commands" to
1313         //   avoid errors with algorithm floats.
1314         // use hyperref explicitely when it is required
1315         if (features.isRequired("hyperref")) {
1316                 odocstringstream oss;
1317                 pdfoptions().writeLaTeX(oss, documentClass().provides("hyperref"));
1318                 lyxpreamble += oss.str();
1319         }
1320
1321         // Will be surrounded by \makeatletter and \makeatother when needed
1322         docstring atlyxpreamble;
1323
1324         // Some macros LyX will need
1325         docstring tmppreamble(from_ascii(features.getMacros()));
1326
1327         if (!tmppreamble.empty())
1328                 atlyxpreamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1329                         "LyX specific LaTeX commands.\n"
1330                         + tmppreamble + '\n';
1331
1332         // the text class specific preamble
1333         tmppreamble = features.getTClassPreamble();
1334         if (!tmppreamble.empty())
1335                 atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1336                         "Textclass specific LaTeX commands.\n"
1337                         + tmppreamble + '\n';
1338
1339         /* the user-defined preamble */
1340         if (!preamble.empty())
1341                 // FIXME UNICODE
1342                 atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1343                         "User specified LaTeX commands.\n"
1344                         + from_utf8(preamble) + '\n';
1345
1346         // subfig loads internally the LaTeX package "caption". As
1347         // caption is a very popular package, users will load it in
1348         // the preamble. Therefore we must load subfig behind the
1349         // user-defined preamble and check if the caption package was
1350         // loaded or not. For the case that caption is loaded before
1351         // subfig, there is the subfig option "caption=false". This
1352         // option also works when a koma-script class is used and
1353         // koma's own caption commands are used instead of caption. We
1354         // use \PassOptionsToPackage here because the user could have
1355         // already loaded subfig in the preamble.
1356         if (features.isRequired("subfig")) {
1357                 atlyxpreamble += "\\@ifundefined{showcaptionsetup}{}{%\n"
1358                         " \\PassOptionsToPackage{caption=false}{subfig}}\n"
1359                         "\\usepackage{subfig}\n";
1360         }
1361
1362         // Itemize bullet settings need to be last in case the user
1363         // defines their own bullets that use a package included
1364         // in the user-defined preamble -- ARRae
1365         // Actually it has to be done much later than that
1366         // since some packages like frenchb make modifications
1367         // at \begin{document} time -- JMarc
1368         docstring bullets_def;
1369         for (int i = 0; i < 4; ++i) {
1370                 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1371                         if (bullets_def.empty())
1372                                 bullets_def += "\\AtBeginDocument{\n";
1373                         bullets_def += "  \\def\\labelitemi";
1374                         switch (i) {
1375                                 // `i' is one less than the item to modify
1376                         case 0:
1377                                 break;
1378                         case 1:
1379                                 bullets_def += 'i';
1380                                 break;
1381                         case 2:
1382                                 bullets_def += "ii";
1383                                 break;
1384                         case 3:
1385                                 bullets_def += 'v';
1386                                 break;
1387                         }
1388                         bullets_def += '{' +
1389                                 user_defined_bullet(i).getText()
1390                                 + "}\n";
1391                 }
1392         }
1393
1394         if (!bullets_def.empty())
1395                 atlyxpreamble += bullets_def + "}\n\n";
1396
1397         if (atlyxpreamble.find(from_ascii("@")) != docstring::npos)
1398                 lyxpreamble += "\n\\makeatletter\n"
1399                         + atlyxpreamble + "\\makeatother\n\n";
1400         else
1401                 lyxpreamble += '\n' + atlyxpreamble;
1402
1403         // We try to load babel late, in case it interferes with other packages.
1404         // Jurabib and Hyperref have to be called after babel, though.
1405         if (use_babel && !features.isRequired("jurabib")
1406             && !features.isRequired("hyperref")
1407             && !features.isRequired("vietnamese")
1408             && !features.isRequired("japanese")) {
1409                 // FIXME UNICODE
1410                 lyxpreamble += from_utf8(babelCall(language_options.str())) + '\n';
1411                 lyxpreamble += from_utf8(features.getBabelOptions()) + '\n';
1412         }
1413
1414         int const nlines =
1415                 int(count(lyxpreamble.begin(), lyxpreamble.end(), '\n'));
1416         for (int j = 0; j != nlines; ++j) {
1417                 texrow.newline();
1418         }
1419
1420         os << lyxpreamble;
1421         return use_babel;
1422 }
1423
1424
1425 void BufferParams::useClassDefaults()
1426 {
1427         DocumentClass const & tclass = documentClass();
1428
1429         sides = tclass.sides();
1430         columns = tclass.columns();
1431         pagestyle = tclass.pagestyle();
1432         use_default_options = true;
1433         // Only if class has a ToC hierarchy
1434         if (tclass.hasTocLevels()) {
1435                 secnumdepth = tclass.secnumdepth();
1436                 tocdepth = tclass.tocdepth();
1437         }
1438 }
1439
1440
1441 bool BufferParams::hasClassDefaults() const
1442 {
1443         DocumentClass const & tclass = documentClass();
1444
1445         return sides == tclass.sides()
1446                 && columns == tclass.columns()
1447                 && pagestyle == tclass.pagestyle()
1448                 && use_default_options
1449                 && secnumdepth == tclass.secnumdepth()
1450                 && tocdepth == tclass.tocdepth();
1451 }
1452
1453
1454 DocumentClass const & BufferParams::documentClass() const
1455 {
1456         return *doc_class_;
1457 }
1458
1459
1460 DocumentClass const * BufferParams::documentClassPtr() const {
1461         return doc_class_;
1462 }
1463
1464
1465 void BufferParams::setDocumentClass(DocumentClass const * const tc) {
1466         // evil, but this function is evil
1467         doc_class_ = const_cast<DocumentClass *>(tc);
1468 }
1469
1470
1471 void BufferParams::removeExcludedModules()
1472 {
1473         // remove any modules the new base class excludes
1474         list<string> oldModules = getModules();
1475         clearLayoutModules();
1476         list<string>::const_iterator oit = oldModules.begin();
1477         list<string>::const_iterator oen = oldModules.end();
1478         list<string> const & exclmods = baseClass()->excludedModules();
1479         for (; oit != oen; ++oit) {
1480                 // are we excluded by the document class?
1481                 if (find(exclmods.begin(), exclmods.end(), *oit) != exclmods.end()) {
1482                         LYXERR0("Module " << *oit << " dropped because excluded by document class.");
1483                         continue;
1484                 }
1485                 layoutModules_.push_back(*oit);
1486         }
1487 }
1488
1489
1490 void BufferParams::addDefaultModules()
1491 {
1492         // add any default modules not already in use
1493         list<string> const & mods = baseClass()->defaultModules();
1494         list<string>::const_iterator mit = mods.begin();
1495         list<string>::const_iterator men = mods.end();
1496
1497         // we want to add these to the front, but in the right order,
1498         // so we collect them here first.
1499         list<string> modulesToAdd;
1500
1501         for (; mit != men; mit++) {
1502                 string const & modName = *mit;
1503                 // make sure the user hasn't removed it
1504                 if (find(removedModules_.begin(), removedModules_.end(), modName) !=
1505                     removedModules_.end()) {
1506                         LYXERR(Debug::TCLASS, "Default module `" << modName <<
1507                                         "' not added because removed by user.");
1508                         continue;
1509                 }
1510
1511                 if (moduleCanBeAdded(modName)) {
1512                         LYXERR(Debug::TCLASS, "Default module `" << modName << "' added.");
1513                         modulesToAdd.push_back(modName);
1514                 } else
1515                         LYXERR(Debug::TCLASS,
1516                                         "Default module `" << modName << "' could not be added.");
1517         }
1518
1519         // OK, now we can add the default modules.
1520         layoutModules_.insert(
1521                         layoutModules_.begin(), modulesToAdd.begin(), modulesToAdd.end());
1522 }
1523
1524
1525 bool BufferParams::checkModuleConsistency() {
1526         bool consistent = true;
1527         // Perform a consistency check on the set of modules.
1528         // In particular, we need to check that modules provided by this class
1529         // do not conflict with modules chosen by the user.
1530         list<string> oldModules = getModules();
1531         clearLayoutModules();
1532         list<string>::const_iterator oit = oldModules.begin();
1533         list<string>::const_iterator oen = oldModules.end();
1534         list<string> const & provmods = baseClass()->providedModules();
1535         list<string> const & exclmods = baseClass()->excludedModules();
1536         for (; oit != oen; ++oit) {
1537                 string const & modname = *oit;
1538                 // skip modules that the class provides
1539                 if (find(provmods.begin(), provmods.end(), modname) != provmods.end()) {
1540                         consistent = false;
1541                         LYXERR0("Module " << modname << " dropped because provided by document class.");
1542                         continue;
1543                 }
1544                 // are we excluded by the document class?
1545                 if (find(exclmods.begin(), exclmods.end(), modname) != exclmods.end()) {
1546                         consistent = false;
1547                         LYXERR0("WARNING: Module " << modname << " should already have been dropped!");
1548                         continue;
1549                 }
1550
1551                 // determine whether some provided module excludes us or we exclude it
1552                 list<string>::const_iterator pit = provmods.begin();
1553                 list<string>::const_iterator pen = provmods.end();
1554                 bool excluded = false;
1555                 for (; !excluded && pit != pen; ++pit) {
1556                         if (!LyXModule::areCompatible(modname, *pit)) {
1557                                 consistent = false;
1558                                 LYXERR0("Module " << modname <<
1559                                                 " dropped becuase it conflicts with provided module " << *pit);
1560                                 excluded = true;
1561                         }
1562                 }
1563
1564                 if (excluded)
1565                         continue;
1566
1567                 // Determine whether some prior module excludes us, or we exclude it
1568                 list<string>::const_iterator lit = layoutModules_.begin();
1569                 list<string>::const_iterator len = layoutModules_.end();
1570                 for (; !excluded && lit != len; ++lit) {
1571                         if (!LyXModule::areCompatible(modname, *lit)) {
1572                                 consistent = false;
1573                                 LYXERR0("Module " << modname <<
1574                                                 " dropped because it is excluded by prior module " << *lit);
1575                                 excluded = true;
1576                         }
1577                 }
1578
1579                 if (excluded)
1580                         continue;
1581
1582                 // determine whether some provided module or some prior module
1583                 // satisfies our requirements
1584                 LyXModule const * const oldmod = moduleList[modname];
1585                 if (!oldmod) {
1586                         LYXERR0("Default module " << modname <<
1587                                         " added although it is unavailable and can't check requirements.");
1588                         continue;
1589                 }
1590
1591                 vector<string> const & reqs = oldmod->getRequiredModules();
1592                 if (!reqs.empty()) {
1593                         // we now set excluded to true, meaning that we haven't
1594                         // yet found a required module.
1595                         excluded = true;
1596                         vector<string>::const_iterator rit  = reqs.begin();
1597                         vector<string>::const_iterator ren = reqs.end();
1598                         for (; rit != ren; ++rit) {
1599                                 string const reqmod = *rit;
1600                                 if (find(provmods.begin(), provmods.end(), reqmod) !=
1601                                                 provmods.end()) {
1602                                         excluded = false;
1603                                         break;
1604                                 }
1605                                 if (find(layoutModules_.begin(), layoutModules_.end(), reqmod) !=
1606                                                 layoutModules_.end()) {
1607                                         excluded = false;
1608                                         break;
1609                                 }
1610                         }
1611                 }
1612                 if (excluded) {
1613                         consistent = false;
1614                         LYXERR0("Module " << modname << " dropped because requirements not met.");
1615                 } else {
1616                         LYXERR(Debug::TCLASS, "Module " << modname << " passed consistency check.");
1617                         layoutModules_.push_back(modname);
1618                 }
1619         }
1620         return consistent;
1621 }
1622
1623
1624 bool BufferParams::setBaseClass(string const & classname)
1625 {
1626         LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
1627         LayoutFileList & bcl = LayoutFileList::get();
1628         if (!bcl.haveClass(classname)) {
1629                 docstring s =
1630                         bformat(_("The document class %1$s could not be found. "
1631                                 "A default textclass with default layouts will be used. "
1632                                 "LyX might not be able to produce output unless a correct "
1633                                 "textclass is selected from the document settings dialog."),
1634                         from_utf8(classname));
1635                 frontend::Alert::error(_("Document class not found"), s);
1636                 bcl.addEmptyClass(classname);
1637         }
1638
1639         bool const success = bcl[classname].load();
1640         if (!success) {
1641                 docstring s =
1642                         bformat(_("The document class %1$s could not be loaded."),
1643                         from_utf8(classname));
1644                 frontend::Alert::error(_("Could not load class"), s);
1645                 return false;
1646         }
1647
1648         pimpl_->baseClass_ = classname;
1649         removeExcludedModules();
1650         addDefaultModules();
1651         checkModuleConsistency();
1652
1653         return true;
1654 }
1655
1656
1657 LayoutFile const * BufferParams::baseClass() const
1658 {
1659         if (LayoutFileList::get().haveClass(pimpl_->baseClass_))
1660                 return &(LayoutFileList::get()[pimpl_->baseClass_]);
1661         else
1662                 return 0;
1663 }
1664
1665
1666 LayoutFileIndex const & BufferParams::baseClassID() const
1667 {
1668         return pimpl_->baseClass_;
1669 }
1670
1671
1672 void BufferParams::makeDocumentClass()
1673 {
1674         if (!baseClass())
1675                 return;
1676
1677         doc_class_ = &(DocumentClassBundle::get().newClass(*baseClass()));
1678
1679         // FIXME It might be worth loading the children's modules here,
1680         // just as we load their bibliographies and such, instead of just
1681         // doing a check in InsetInclude.
1682         LayoutModuleList::const_iterator it = layoutModules_.begin();
1683         for (; it != layoutModules_.end(); it++) {
1684                 string const modName = *it;
1685                 LyXModule * lm = moduleList[modName];
1686                 if (!lm) {
1687                         docstring const msg =
1688                                 bformat(_("The module %1$s has been requested by\n"
1689                                         "this document but has not been found in the list of\n"
1690                                         "available modules. If you recently installed it, you\n"
1691                                         "probably need to reconfigure LyX.\n"), from_utf8(modName));
1692                         frontend::Alert::warning(_("Module not available"),
1693                                         msg + _("Some layouts may not be available."));
1694                         LYXERR0("BufferParams::makeDocumentClass(): Module " <<
1695                                         modName << " requested but not found in module list.");
1696                         continue;
1697                 }
1698                 if (!lm->isAvailable()) {
1699                         docstring const msg =
1700                                                 bformat(_("The module %1$s requires a package that is\n"
1701                                                 "not available in your LaTeX installation. LaTeX output\n"
1702                                                 "may not be possible.\n"), from_utf8(modName));
1703                         frontend::Alert::warning(_("Package not available"), msg);
1704                 }
1705                 FileName layout_file = libFileSearch("layouts", lm->getFilename());
1706                 if (!doc_class_->read(layout_file, TextClass::MODULE)) {
1707                         docstring const msg =
1708                                 bformat(_("Error reading module %1$s\n"), from_utf8(modName));
1709                         frontend::Alert::warning(_("Read Error"), msg);
1710                 }
1711         }
1712         if (!local_layout.empty()) {
1713                 if (!doc_class_->read(local_layout, TextClass::MODULE)) {
1714                         docstring const msg = _("Error reading internal layout information");
1715                         frontend::Alert::warning(_("Read Error"), msg);
1716                 }
1717         }
1718 }
1719
1720
1721 bool BufferParams::moduleCanBeAdded(string const & modName) const
1722 {
1723         // Is the module already present?
1724         LayoutModuleList::const_iterator it = layoutModules_.begin();
1725         LayoutModuleList::const_iterator end = layoutModules_.end();
1726         for (; it != end; it++)
1727                 if (*it == modName)
1728                         return false;
1729
1730         LyXModule const * const lm = moduleList[modName];
1731         if (!lm)
1732                 return true;
1733
1734         // Is this module explicitly excluded by the document class?
1735         list<string>::const_iterator const exclmodstart =
1736                         baseClass()->excludedModules().begin();
1737         list<string>::const_iterator const exclmodend =
1738                         baseClass()->excludedModules().end();
1739         if (find(exclmodstart, exclmodend, modName) != exclmodend)
1740                 return false;
1741
1742         // Is this module already provided by the document class?
1743         list<string>::const_iterator const provmodstart =
1744                         baseClass()->providedModules().begin();
1745         list<string>::const_iterator const provmodend =
1746                         baseClass()->providedModules().end();
1747         if (find(provmodstart, provmodend, modName) != provmodend)
1748                 return false;
1749
1750         // Check for conflicts with used modules
1751         // first the provided modules...
1752         list<string>::const_iterator provmodit = provmodstart;
1753         for (; provmodit != provmodend; ++provmodit) {
1754                 if (!LyXModule::areCompatible(modName, *provmodit))
1755                         return false;
1756         }
1757         // and then the selected modules
1758         LayoutModuleList::const_iterator mit = getModules().begin();
1759         LayoutModuleList::const_iterator const men = getModules().end();
1760         for (; mit != men; ++mit)
1761                 if (!LyXModule::areCompatible(modName, *mit))
1762                         return false;
1763
1764         // Check whether some required module is available
1765         vector<string> const reqs = lm->getRequiredModules();
1766         if (reqs.empty())
1767                 return true;
1768
1769         mit = getModules().begin(); // reset
1770         vector<string>::const_iterator rit = reqs.begin();
1771         vector<string>::const_iterator ren = reqs.end();
1772         bool foundone = false;
1773         for (; rit != ren; ++rit) {
1774                 if (find(mit, men, *rit) != men ||
1775                     find(provmodstart, provmodend, *rit) != provmodend) {
1776                         foundone = true;
1777                         break;
1778                 }
1779         }
1780
1781         return foundone;
1782 }
1783
1784
1785 bool BufferParams::addLayoutModule(string const & modName)
1786 {
1787         LayoutModuleList::const_iterator it = layoutModules_.begin();
1788         LayoutModuleList::const_iterator end = layoutModules_.end();
1789         for (; it != end; it++)
1790                 if (*it == modName)
1791                         return false;
1792         layoutModules_.push_back(modName);
1793         return true;
1794 }
1795
1796
1797 Font const BufferParams::getFont() const
1798 {
1799         FontInfo f = documentClass().defaultfont();
1800         if (fontsDefaultFamily == "rmdefault")
1801                 f.setFamily(ROMAN_FAMILY);
1802         else if (fontsDefaultFamily == "sfdefault")
1803                 f.setFamily(SANS_FAMILY);
1804         else if (fontsDefaultFamily == "ttdefault")
1805                 f.setFamily(TYPEWRITER_FAMILY);
1806         return Font(f, language);
1807 }
1808
1809
1810 void BufferParams::readPreamble(Lexer & lex)
1811 {
1812         if (lex.getString() != "\\begin_preamble")
1813                 lyxerr << "Error (BufferParams::readPreamble):"
1814                         "consistency check failed." << endl;
1815
1816         preamble = lex.getLongString("\\end_preamble");
1817 }
1818
1819
1820 void BufferParams::readLocalLayout(Lexer & lex)
1821 {
1822         if (lex.getString() != "\\begin_local_layout")
1823                 lyxerr << "Error (BufferParams::readLocalLayout):"
1824                         "consistency check failed." << endl;
1825
1826         local_layout = lex.getLongString("\\end_local_layout");
1827 }
1828
1829
1830 void BufferParams::readLanguage(Lexer & lex)
1831 {
1832         if (!lex.next()) return;
1833
1834         string const tmptok = lex.getString();
1835
1836         // check if tmptok is part of tex_babel in tex-defs.h
1837         language = languages.getLanguage(tmptok);
1838         if (!language) {
1839                 // Language tmptok was not found
1840                 language = default_language;
1841                 lyxerr << "Warning: Setting language `"
1842                        << tmptok << "' to `" << language->lang()
1843                        << "'." << endl;
1844         }
1845 }
1846
1847
1848 void BufferParams::readGraphicsDriver(Lexer & lex)
1849 {
1850         if (!lex.next())
1851                 return;
1852
1853         string const tmptok = lex.getString();
1854         // check if tmptok is part of tex_graphics in tex_defs.h
1855         int n = 0;
1856         while (true) {
1857                 string const test = tex_graphics[n++];
1858
1859                 if (test == tmptok) {
1860                         graphicsDriver = tmptok;
1861                         break;
1862                 }
1863                 if (test.empty()) {
1864                         lex.printError(
1865                                 "Warning: graphics driver `$$Token' not recognized!\n"
1866                                 "         Setting graphics driver to `default'.\n");
1867                         graphicsDriver = "default";
1868                         break;
1869                 }
1870         }
1871 }
1872
1873
1874 void BufferParams::readBullets(Lexer & lex)
1875 {
1876         if (!lex.next())
1877                 return;
1878
1879         int const index = lex.getInteger();
1880         lex.next();
1881         int temp_int = lex.getInteger();
1882         user_defined_bullet(index).setFont(temp_int);
1883         temp_bullet(index).setFont(temp_int);
1884         lex >> temp_int;
1885         user_defined_bullet(index).setCharacter(temp_int);
1886         temp_bullet(index).setCharacter(temp_int);
1887         lex >> temp_int;
1888         user_defined_bullet(index).setSize(temp_int);
1889         temp_bullet(index).setSize(temp_int);
1890 }
1891
1892
1893 void BufferParams::readBulletsLaTeX(Lexer & lex)
1894 {
1895         // The bullet class should be able to read this.
1896         if (!lex.next())
1897                 return;
1898         int const index = lex.getInteger();
1899         lex.next(true);
1900         docstring const temp_str = lex.getDocString();
1901
1902         user_defined_bullet(index).setText(temp_str);
1903         temp_bullet(index).setText(temp_str);
1904 }
1905
1906
1907 void BufferParams::readModules(Lexer & lex)
1908 {
1909         if (!lex.eatLine()) {
1910                 lyxerr << "Error (BufferParams::readModules):"
1911                                 "Unexpected end of input." << endl;
1912                 return;
1913         }
1914         while (true) {
1915                 string mod = lex.getString();
1916                 if (mod == "\\end_modules")
1917                         break;
1918                 addLayoutModule(mod);
1919                 lex.eatLine();
1920         }
1921 }
1922
1923
1924 void BufferParams::readRemovedModules(Lexer & lex)
1925 {
1926         if (!lex.eatLine()) {
1927                 lyxerr << "Error (BufferParams::readRemovedModules):"
1928                                 "Unexpected end of input." << endl;
1929                 return;
1930         }
1931         while (true) {
1932                 string mod = lex.getString();
1933                 if (mod == "\\end_removed_modules")
1934                         break;
1935                 removedModules_.insert(mod);
1936                 lex.eatLine();
1937         }
1938         // now we want to remove any removed modules that were previously
1939         // added. normally, that will be because default modules were added in
1940         // setBaseClass(), which gets called when \textclass is read at the
1941         // start of the read.
1942         set<string>::const_iterator rit = removedModules_.begin();
1943         set<string>::const_iterator const ren = removedModules_.end();
1944         for (; rit != ren; rit++) {
1945                 LayoutModuleList::iterator const mit = layoutModules_.begin();
1946                 LayoutModuleList::iterator const men = layoutModules_.end();
1947                 LayoutModuleList::iterator found = find(mit, men, *rit);
1948                 if (found == men)
1949                         continue;
1950                 layoutModules_.erase(found);
1951         }
1952 }
1953
1954
1955 string BufferParams::paperSizeName(PapersizePurpose purpose) const
1956 {
1957         char real_papersize = papersize;
1958         if (real_papersize == PAPER_DEFAULT)
1959                 real_papersize = lyxrc.default_papersize;
1960
1961         switch (real_papersize) {
1962         case PAPER_DEFAULT:
1963                 // could be anything, so don't guess
1964                 return string();
1965         case PAPER_CUSTOM: {
1966                 if (purpose == XDVI && !paperwidth.empty() &&
1967                     !paperheight.empty()) {
1968                         // heightxwidth<unit>
1969                         string first = paperwidth;
1970                         string second = paperheight;
1971                         if (orientation == ORIENTATION_LANDSCAPE)
1972                                 first.swap(second);
1973                         // cut off unit.
1974                         return first.erase(first.length() - 2)
1975                                 + "x" + second;
1976                 }
1977                 return string();
1978         }
1979         case PAPER_A3:
1980                 return "a3";
1981         case PAPER_A4:
1982                 return "a4";
1983         case PAPER_A5:
1984                 return "a5";
1985         case PAPER_B3:
1986                 // dvips and dvipdfm do not know this
1987                 if (purpose == DVIPS || purpose == DVIPDFM)
1988                         return string();
1989                 return "b3";
1990         case PAPER_B4:
1991                 // dvipdfm does not know this
1992                 if (purpose == DVIPDFM)
1993                         return string();
1994                 return "b4";
1995         case PAPER_B5:
1996                 // dvipdfm does not know this
1997                 if (purpose == DVIPDFM)
1998                         return string();
1999                 return "b5";
2000         case PAPER_USEXECUTIVE:
2001                 // dvipdfm does not know this
2002                 if (purpose == DVIPDFM)
2003                         return string();
2004                 return "foolscap";
2005         case PAPER_USLEGAL:
2006                 return "legal";
2007         case PAPER_USLETTER:
2008         default:
2009                 if (purpose == XDVI)
2010                         return "us";
2011                 return "letter";
2012         }
2013 }
2014
2015
2016 string const BufferParams::dvips_options() const
2017 {
2018         string result;
2019
2020         if (use_geometry
2021             && papersize == PAPER_CUSTOM
2022             && !lyxrc.print_paper_dimension_flag.empty()
2023             && !paperwidth.empty()
2024             && !paperheight.empty()) {
2025                 // using a custom papersize
2026                 result = lyxrc.print_paper_dimension_flag;
2027                 result += ' ' + paperwidth;
2028                 result += ',' + paperheight;
2029         } else {
2030                 string const paper_option = paperSizeName(DVIPS);
2031                 if (!paper_option.empty() && (paper_option != "letter" ||
2032                     orientation != ORIENTATION_LANDSCAPE)) {
2033                         // dvips won't accept -t letter -t landscape.
2034                         // In all other cases, include the paper size
2035                         // explicitly.
2036                         result = lyxrc.print_paper_flag;
2037                         result += ' ' + paper_option;
2038                 }
2039         }
2040         if (orientation == ORIENTATION_LANDSCAPE &&
2041             papersize != PAPER_CUSTOM)
2042                 result += ' ' + lyxrc.print_landscape_flag;
2043         return result;
2044 }
2045
2046
2047 string BufferParams::babelCall(string const & lang_opts) const
2048 {
2049         string lang_pack = lyxrc.language_package;
2050         if (lang_pack != "\\usepackage{babel}")
2051                 return lang_pack;
2052         // suppress the babel call when there is no babel language defined
2053         // for the document language in the lib/languages file and if no
2054         // other languages are used (lang_opts is then empty)
2055         if (lang_opts.empty())
2056                 return string();
2057         // If Vietnamese is used, babel must directly be loaded with the
2058         // language options, see
2059         // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129417.html
2060         size_t viet = lang_opts.find("vietnam");
2061         // viet = string::npos when not found
2062         // the same is for all other languages that are not directly supported by
2063         // babel, but where LaTeX-packages add babel support.
2064         // this is currently the case for Latvian, Lithuanian, and Mongolian
2065         size_t latvian = lang_opts.find("latvian");
2066         size_t lithu = lang_opts.find("lithuanian");
2067         size_t mongo = lang_opts.find("mongolian");
2068         // If Japanese is used, babel must directly be loaded with the
2069         // language options, see
2070         // http://bugzilla.lyx.org/show_bug.cgi?id=4597#c4
2071         size_t japan = lang_opts.find("japanese");
2072         if (!lyxrc.language_global_options || viet != string::npos
2073                 || japan != string::npos || latvian != string::npos
2074                 || lithu != string::npos || mongo != string::npos)
2075                 return "\\usepackage[" + lang_opts + "]{babel}";
2076         return lang_pack;
2077 }
2078
2079
2080 void BufferParams::writeEncodingPreamble(odocstream & os,
2081                 LaTeXFeatures & features, TexRow & texrow) const
2082 {
2083         if (inputenc == "auto") {
2084                 string const doc_encoding =
2085                         language->encoding()->latexName();
2086                 Encoding::Package const package =
2087                         language->encoding()->package();
2088
2089                 // Create a list with all the input encodings used
2090                 // in the document
2091                 set<string> encodings =
2092                         features.getEncodingSet(doc_encoding);
2093
2094                 // If the "japanese" package (i.e. pLaTeX) is used,
2095                 // inputenc must be omitted.
2096                 // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
2097                 if (package == Encoding::japanese)
2098                      features.require("japanese");
2099
2100                 if ((!encodings.empty() || package == Encoding::inputenc)
2101                     && !features.isRequired("japanese")) {
2102                         os << "\\usepackage[";
2103                         set<string>::const_iterator it = encodings.begin();
2104                         set<string>::const_iterator const end = encodings.end();
2105                         if (it != end) {
2106                                 os << from_ascii(*it);
2107                                 ++it;
2108                         }
2109                         for (; it != end; ++it)
2110                                 os << ',' << from_ascii(*it);
2111                         if (package == Encoding::inputenc) {
2112                                 if (!encodings.empty())
2113                                         os << ',';
2114                                 os << from_ascii(doc_encoding);
2115                         }
2116                         os << "]{inputenc}\n";
2117                         texrow.newline();
2118                 }
2119                 if (package == Encoding::CJK || features.mustProvide("CJK")) {
2120                         os << "\\usepackage{CJK}\n";
2121                         texrow.newline();
2122                 }
2123         } else if (inputenc != "default") {
2124                 switch (encoding().package()) {
2125                 case Encoding::none:
2126                 case Encoding::japanese:
2127                         break;
2128                 case Encoding::inputenc:
2129                         // do not load inputenc if japanese is used
2130                         if (features.isRequired("japanese"))
2131                                 break;
2132                         os << "\\usepackage[" << from_ascii(inputenc)
2133                            << "]{inputenc}\n";
2134                         texrow.newline();
2135                         break;
2136                 case Encoding::CJK:
2137                         os << "\\usepackage{CJK}\n";
2138                         texrow.newline();
2139                         break;
2140                 }
2141         }
2142
2143         // The encoding "armscii8" (for Armenian) is only available when
2144         // the package "armtex" is loaded.
2145         if (language->encoding()->latexName() == "armscii8"
2146             || inputenc == "armscii8") {
2147                 os << "\\usepackage{armtex}\n";
2148                 texrow.newline();
2149         }
2150 }
2151
2152
2153 string const BufferParams::loadFonts(string const & rm,
2154                                      string const & sf, string const & tt,
2155                                      bool const & sc, bool const & osf,
2156                                      int const & sfscale, int const & ttscale) const
2157 {
2158         /* The LaTeX font world is in a flux. In the PSNFSS font interface,
2159            several packages have been replaced by others, that might not
2160            be installed on every system. We have to take care for that
2161            (see psnfss.pdf). We try to support all psnfss fonts as well
2162            as the fonts that have become de facto standard in the LaTeX
2163            world (e.g. Latin Modern). We do not support obsolete fonts
2164            (like PSLatex). In general, it should be possible to mix any
2165            rm font with any sf or tt font, respectively. (JSpitzm)
2166            TODO:
2167                 -- separate math fonts.
2168         */
2169
2170         if (rm == "default" && sf == "default" && tt == "default")
2171                 //nothing to do
2172                 return string();
2173
2174         ostringstream os;
2175
2176         // ROMAN FONTS
2177         // Computer Modern (must be explicitely selectable -- there might be classes
2178         // that define a different default font!
2179         if (rm == "cmr") {
2180                 os << "\\renewcommand{\\rmdefault}{cmr}\n";
2181                 // osf for Computer Modern needs eco.sty
2182                 if (osf)
2183                         os << "\\usepackage{eco}\n";
2184         }
2185         // Latin Modern Roman
2186         else if (rm == "lmodern")
2187                 os << "\\usepackage{lmodern}\n";
2188         // AE
2189         else if (rm == "ae") {
2190                 // not needed when using OT1 font encoding.
2191                 if (lyxrc.fontenc != "default")
2192                         os << "\\usepackage{ae,aecompl}\n";
2193         }
2194         // Times
2195         else if (rm == "times") {
2196                 // try to load the best available package
2197                 if (LaTeXFeatures::isAvailable("mathptmx"))
2198                         os << "\\usepackage{mathptmx}\n";
2199                 else if (LaTeXFeatures::isAvailable("mathptm"))
2200                         os << "\\usepackage{mathptm}\n";
2201                 else
2202                         os << "\\usepackage{times}\n";
2203         }
2204         // Palatino
2205         else if (rm == "palatino") {
2206                 // try to load the best available package
2207                 if (LaTeXFeatures::isAvailable("mathpazo")) {
2208                         os << "\\usepackage";
2209                         if (osf || sc) {
2210                                 os << '[';
2211                                 if (!osf)
2212                                         os << "sc";
2213                                 else
2214                                         // "osf" includes "sc"!
2215                                         os << "osf";
2216                                 os << ']';
2217                         }
2218                         os << "{mathpazo}\n";
2219                 }
2220                 else if (LaTeXFeatures::isAvailable("mathpple"))
2221                         os << "\\usepackage{mathpple}\n";
2222                 else
2223                         os << "\\usepackage{palatino}\n";
2224         }
2225         // Utopia
2226         else if (rm == "utopia") {
2227                 // fourier supersedes utopia.sty, but does
2228                 // not work with OT1 encoding.
2229                 if (LaTeXFeatures::isAvailable("fourier")
2230                     && lyxrc.fontenc != "default") {
2231                         os << "\\usepackage";
2232                         if (osf || sc) {
2233                                 os << '[';
2234                                 if (sc)
2235                                         os << "expert";
2236                                 if (osf && sc)
2237                                         os << ',';
2238                                 if (osf)
2239                                         os << "oldstyle";
2240                                 os << ']';
2241                         }
2242                         os << "{fourier}\n";
2243                 }
2244                 else
2245                         os << "\\usepackage{utopia}\n";
2246         }
2247         // Bera (complete fontset)
2248         else if (rm == "bera" && sf == "default" && tt == "default")
2249                 os << "\\usepackage{bera}\n";
2250         // everything else
2251         else if (rm != "default")
2252                 os << "\\usepackage" << "{" << rm << "}\n";
2253
2254         // SANS SERIF
2255         // Helvetica, Bera Sans
2256         if (sf == "helvet" || sf == "berasans") {
2257                 if (sfscale != 100)
2258                         os << "\\usepackage[scaled=" << float(sfscale) / 100
2259                            << "]{" << sf << "}\n";
2260                 else
2261                         os << "\\usepackage{" << sf << "}\n";
2262         }
2263         // Avant Garde
2264         else if (sf == "avant")
2265                 os << "\\usepackage{" << sf << "}\n";
2266         // Computer Modern, Latin Modern, CM Bright
2267         else if (sf != "default")
2268                 os << "\\renewcommand{\\sfdefault}{" << sf << "}\n";
2269
2270         // monospaced/typewriter
2271         // Courier, LuxiMono
2272         if (tt == "luximono" || tt == "beramono") {
2273                 if (ttscale != 100)
2274                         os << "\\usepackage[scaled=" << float(ttscale) / 100
2275                            << "]{" << tt << "}\n";
2276                 else
2277                         os << "\\usepackage{" << tt << "}\n";
2278         }
2279         // Courier
2280         else if (tt == "courier" )
2281                 os << "\\usepackage{" << tt << "}\n";
2282         // Computer Modern, Latin Modern, CM Bright
2283         else if (tt != "default")
2284                 os << "\\renewcommand{\\ttdefault}{" << tt << "}\n";
2285
2286         return os.str();
2287 }
2288
2289
2290 Encoding const & BufferParams::encoding() const
2291 {
2292         if (inputenc == "auto" || inputenc == "default")
2293                 return *language->encoding();
2294         Encoding const * const enc = encodings.fromLaTeXName(inputenc);
2295         if (enc)
2296                 return *enc;
2297         LYXERR0("Unknown inputenc value `" << inputenc
2298                << "'. Using `auto' instead.");
2299         return *language->encoding();
2300 }
2301
2302
2303 CiteEngine BufferParams::citeEngine() const
2304 {
2305         // FIXME the class should provide the numerical/
2306         // authoryear choice
2307         if (documentClass().provides("natbib")
2308             && cite_engine_ != ENGINE_NATBIB_NUMERICAL)
2309                 return ENGINE_NATBIB_AUTHORYEAR;
2310         return cite_engine_;
2311 }
2312
2313
2314 void BufferParams::setCiteEngine(CiteEngine cite_engine)
2315 {
2316         cite_engine_ = cite_engine;
2317 }
2318
2319 } // namespace lyx