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