2 * \file BufferParams.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Alfredo Braunstein
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
10 * \author André Pönitz
11 * \author Martin Vermeer
13 * Full author contact details are available in file CREDITS.
18 #include "BufferParams.h"
21 #include "LayoutFile.h"
22 #include "BranchList.h"
23 #include "buffer_funcs.h"
28 #include "LaTeXFeatures.h"
29 #include "ModuleList.h"
33 #include "OutputParams.h"
37 #include "PDFOptions.h"
39 #include "frontends/alert.h"
41 #include "insets/InsetListingsParams.h"
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"
57 using namespace lyx::support;
60 static char const * const string_paragraph_separation[] = {
65 static char const * const string_quotes_language[] = {
66 "english", "swedish", "german", "polish", "french", "danish", ""
70 static char const * const string_papersize[] = {
71 "default", "custom", "letterpaper", "legalpaper", "executivepaper",
72 "a3paper", "a4paper", "a5paper", "b3paper", "b4paper", "b5paper", ""
76 static char const * const string_orientation[] = {
77 "portrait", "landscape", ""
81 static char const * const string_footnotekinds[] = {
82 "footnote", "margin", "fig", "tab", "alg", "wide-fig", "wide-tab", ""
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",
100 // Paragraph separation
101 typedef Translator<string, BufferParams::ParagraphSeparation> ParSepTranslator;
104 ParSepTranslator const init_parseptranslator()
106 ParSepTranslator translator
107 (string_paragraph_separation[0], BufferParams::ParagraphIndentSeparation);
108 translator.addPair(string_paragraph_separation[1], BufferParams::ParagraphSkipSeparation);
113 ParSepTranslator const & parseptranslator()
115 static ParSepTranslator translator = init_parseptranslator();
121 typedef Translator<string, InsetQuotes::QuoteLanguage> QuotesLangTranslator;
124 QuotesLangTranslator const init_quoteslangtranslator()
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);
137 QuotesLangTranslator const & quoteslangtranslator()
139 static QuotesLangTranslator translator = init_quoteslangtranslator();
145 typedef Translator<string, PAPER_SIZE> PaperSizeTranslator;
148 static PaperSizeTranslator initPaperSizeTranslator()
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);
165 PaperSizeTranslator const & papersizetranslator()
167 static PaperSizeTranslator translator = initPaperSizeTranslator();
173 typedef Translator<string, PAPER_ORIENTATION> PaperOrientationTranslator;
176 PaperOrientationTranslator const init_paperorientationtranslator()
178 PaperOrientationTranslator translator(string_orientation[0], ORIENTATION_PORTRAIT);
179 translator.addPair(string_orientation[1], ORIENTATION_LANDSCAPE);
184 PaperOrientationTranslator const & paperorientationtranslator()
186 static PaperOrientationTranslator translator = init_paperorientationtranslator();
192 typedef Translator<int, PageSides> SidesTranslator;
195 SidesTranslator const init_sidestranslator()
197 SidesTranslator translator(1, OneSide);
198 translator.addPair(2, TwoSides);
203 SidesTranslator const & sidestranslator()
205 static SidesTranslator translator = init_sidestranslator();
211 typedef Translator<int, BufferParams::Package> PackageTranslator;
214 PackageTranslator const init_packagetranslator()
216 PackageTranslator translator(0, BufferParams::package_off);
217 translator.addPair(1, BufferParams::package_auto);
218 translator.addPair(2, BufferParams::package_on);
223 PackageTranslator const & packagetranslator()
225 static PackageTranslator translator = init_packagetranslator();
231 typedef Translator<string, CiteEngine> CiteEngineTranslator;
234 CiteEngineTranslator const init_citeenginetranslator()
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);
244 CiteEngineTranslator const & citeenginetranslator()
246 static CiteEngineTranslator translator = init_citeenginetranslator();
252 typedef Translator<string, Spacing::Space> SpaceTranslator;
255 SpaceTranslator const init_spacetranslator()
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);
266 SpaceTranslator const & spacetranslator()
268 static SpaceTranslator translator = init_spacetranslator();
276 class BufferParams::Impl
281 AuthorList authorlist;
282 BranchList branchlist;
283 Bullet temp_bullets[4];
284 Bullet user_defined_bullets[4];
286 /** This is the amount of space used for paragraph_separation "skip",
287 * and for detached paragraphs in "indented" documents.
290 PDFOptions pdfoptions;
291 LayoutFileIndex baseClass_;
295 BufferParams::Impl::Impl()
296 : defskip(VSpace::MEDSKIP), baseClass_(string(""))
298 // set initial author
300 authorlist.record(Author(from_utf8(lyxrc.user_name), from_utf8(lyxrc.user_email)));
305 BufferParams::MemoryTraits::clone(BufferParams::Impl const * ptr)
309 return new BufferParams::Impl(*ptr);
313 void BufferParams::MemoryTraits::destroy(BufferParams::Impl * ptr)
319 BufferParams::BufferParams()
322 setBaseClass(defaultBaseclass());
324 paragraph_separation = ParagraphIndentSeparation;
325 quotes_language = InsetQuotes::EnglishQuotes;
326 fontsize = "default";
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;
340 language = default_language;
341 fontsRoman = "default";
342 fontsSans = "default";
343 fontsTypewriter = "default";
344 fontsDefaultFamily = "default";
347 fontsSansScale = 100;
348 fontsTypewriterScale = 100;
350 graphicsDriver = "default";
353 listings_params = string();
354 pagestyle = "default";
356 for (int iter = 0; iter < 4; ++iter) {
357 user_defined_bullet(iter) = ITEMIZE_DEFAULTS[iter];
358 temp_bullet(iter) = ITEMIZE_DEFAULTS[iter];
363 docstring BufferParams::B_(string const & l10n) const
365 LASSERT(language, /**/);
366 return getMessages(language->code()).get(l10n);
370 AuthorList & BufferParams::authors()
372 return pimpl_->authorlist;
376 AuthorList const & BufferParams::authors() const
378 return pimpl_->authorlist;
382 BranchList & BufferParams::branchlist()
384 return pimpl_->branchlist;
388 BranchList const & BufferParams::branchlist() const
390 return pimpl_->branchlist;
394 Bullet & BufferParams::temp_bullet(lyx::size_type const index)
396 LASSERT(index < 4, /**/);
397 return pimpl_->temp_bullets[index];
401 Bullet const & BufferParams::temp_bullet(lyx::size_type const index) const
403 LASSERT(index < 4, /**/);
404 return pimpl_->temp_bullets[index];
408 Bullet & BufferParams::user_defined_bullet(lyx::size_type const index)
410 LASSERT(index < 4, /**/);
411 return pimpl_->user_defined_bullets[index];
415 Bullet const & BufferParams::user_defined_bullet(lyx::size_type const index) const
417 LASSERT(index < 4, /**/);
418 return pimpl_->user_defined_bullets[index];
422 Spacing & BufferParams::spacing()
424 return pimpl_->spacing;
428 Spacing const & BufferParams::spacing() const
430 return pimpl_->spacing;
434 PDFOptions & BufferParams::pdfoptions()
436 return pimpl_->pdfoptions;
440 PDFOptions const & BufferParams::pdfoptions() const
442 return pimpl_->pdfoptions;
446 VSpace const & BufferParams::getDefSkip() const
448 return pimpl_->defskip;
452 void BufferParams::setDefSkip(VSpace const & vs)
454 pimpl_->defskip = vs;
458 string BufferParams::readToken(Lexer & lex, string const & token,
459 FileName const & filepath)
461 if (token == "\\textclass") {
463 string const classname = lex.getString();
464 // if there exists a local layout file, ignore the system one
465 // NOTE: in this case, the textclass (.cls file) is assumed to be available.
467 LayoutFileList & bcl = LayoutFileList::get();
468 if (tcp.empty() && !filepath.empty())
469 tcp = bcl.addLocalLayout(classname, filepath.absFilename());
473 setBaseClass(classname);
474 // We assume that a tex class exists for local or unknown layouts so this warning
475 // will only be given for system layouts.
476 if (!baseClass()->isTeXClassAvailable()) {
477 docstring const msg =
478 bformat(_("The layout file requested by this document,\n"
480 "is not usable. This is probably because a LaTeX\n"
481 "class or style file required by it is not\n"
482 "available. See the Customization documentation\n"
483 "for more information.\n"), from_utf8(classname));
484 frontend::Alert::warning(_("Document class not available"),
485 msg + _("LyX will not be able to produce output."));
487 } else if (token == "\\begin_preamble") {
489 } else if (token == "\\begin_local_layout") {
490 readLocalLayout(lex);
491 } else if (token == "\\begin_modules") {
493 } else if (token == "\\begin_removed_modules") {
494 readRemovedModules(lex);
495 } else if (token == "\\options") {
497 options = lex.getString();
498 } else if (token == "\\master") {
500 master = lex.getString();
501 } else if (token == "\\language") {
503 } else if (token == "\\inputencoding") {
505 } else if (token == "\\graphics") {
506 readGraphicsDriver(lex);
507 } else if (token == "\\font_roman") {
509 } else if (token == "\\font_sans") {
511 } else if (token == "\\font_typewriter") {
512 lex >> fontsTypewriter;
513 } else if (token == "\\font_default_family") {
514 lex >> fontsDefaultFamily;
515 } else if (token == "\\font_sc") {
517 } else if (token == "\\font_osf") {
519 } else if (token == "\\font_sf_scale") {
520 lex >> fontsSansScale;
521 } else if (token == "\\font_tt_scale") {
522 lex >> fontsTypewriterScale;
523 } else if (token == "\\font_cjk") {
525 } else if (token == "\\paragraph_separation") {
528 paragraph_separation = parseptranslator().find(parsep);
529 } else if (token == "\\defskip") {
531 string defskip = lex.getString();
532 if (defskip == "defskip")
535 pimpl_->defskip = VSpace(defskip);
536 } else if (token == "\\quotes_language") {
539 quotes_language = quoteslangtranslator().find(quotes_lang);
540 } else if (token == "\\papersize") {
543 papersize = papersizetranslator().find(ppsize);
544 } else if (token == "\\use_geometry") {
546 } else if (token == "\\use_amsmath") {
549 use_amsmath = packagetranslator().find(use_ams);
550 } else if (token == "\\use_esint") {
553 use_esint = packagetranslator().find(useesint);
554 } else if (token == "\\cite_engine") {
557 cite_engine_ = citeenginetranslator().find(engine);
558 } else if (token == "\\use_bibtopic") {
560 } else if (token == "\\tracking_changes") {
562 } else if (token == "\\output_changes") {
563 lex >> outputChanges;
564 } else if (token == "\\branch") {
566 docstring branch = lex.getDocString();
567 branchlist().add(branch);
570 string const tok = lex.getString();
571 if (tok == "\\end_branch")
573 Branch * branch_ptr = branchlist().find(branch);
574 if (tok == "\\selected") {
577 branch_ptr->setSelected(lex.getInteger());
579 // not yet operational
580 if (tok == "\\color") {
582 string color = lex.getString();
584 branch_ptr->setColor(color);
585 // Update also the Color table:
587 color = lcolor.getX11Name(Color_background);
589 lcolor.setColor(to_utf8(branch), color);
593 } else if (token == "\\author") {
595 istringstream ss(lex.getString());
598 author_map.push_back(pimpl_->authorlist.record(a));
599 } else if (token == "\\paperorientation") {
602 orientation = paperorientationtranslator().find(orient);
603 } else if (token == "\\paperwidth") {
605 } else if (token == "\\paperheight") {
607 } else if (token == "\\leftmargin") {
609 } else if (token == "\\topmargin") {
611 } else if (token == "\\rightmargin") {
613 } else if (token == "\\bottommargin") {
615 } else if (token == "\\headheight") {
617 } else if (token == "\\headsep") {
619 } else if (token == "\\footskip") {
621 } else if (token == "\\columnsep") {
623 } else if (token == "\\paperfontsize") {
625 } else if (token == "\\papercolumns") {
627 } else if (token == "\\listings_params") {
630 listings_params = InsetListingsParams(par).params();
631 } else if (token == "\\papersides") {
634 sides = sidestranslator().find(psides);
635 } else if (token == "\\paperpagestyle") {
637 } else if (token == "\\bullet") {
639 } else if (token == "\\bulletLaTeX") {
640 readBulletsLaTeX(lex);
641 } else if (token == "\\secnumdepth") {
643 } else if (token == "\\tocdepth") {
645 } else if (token == "\\spacing") {
649 if (nspacing == "other") {
652 spacing().set(spacetranslator().find(nspacing), tmp_val);
653 } else if (token == "\\float_placement") {
654 lex >> float_placement;
656 } else if (prefixIs(token, "\\pdf_") || token == "\\use_hyperref") {
657 string toktmp = pdfoptions().readToken(lex, token);
658 if (!toktmp.empty()) {
659 lyxerr << "PDFOptions::readToken(): Unknown token: " <<
664 lyxerr << "BufferParams::readToken(): Unknown token: " <<
673 void BufferParams::writeFile(ostream & os) const
675 // The top of the file is written by the buffer.
676 // Prints out the buffer info into the .lyx file given by file
679 os << "\\textclass " << baseClass()->name() << '\n';
682 if (!preamble.empty()) {
683 // remove '\n' from the end of preamble
684 string const tmppreamble = rtrim(preamble, "\n");
685 os << "\\begin_preamble\n"
687 << "\n\\end_preamble\n";
691 if (!options.empty()) {
692 os << "\\options " << options << '\n';
695 // the master document
696 if (!master.empty()) {
697 os << "\\master " << master << '\n';
701 if (!removedModules_.empty()) {
702 os << "\\begin_removed_modules" << '\n';
703 set<string>::const_iterator it = removedModules_.begin();
704 set<string>::const_iterator en = removedModules_.end();
705 for (; it != en; it++)
707 os << "\\end_removed_modules" << '\n';
711 if (!layoutModules_.empty()) {
712 os << "\\begin_modules" << '\n';
713 LayoutModuleList::const_iterator it = layoutModules_.begin();
714 LayoutModuleList::const_iterator en = layoutModules_.end();
715 for (; it != en; it++)
717 os << "\\end_modules" << '\n';
720 // local layout information
721 if (!local_layout.empty()) {
722 // remove '\n' from the end
723 string const tmplocal = rtrim(local_layout, "\n");
724 os << "\\begin_local_layout\n"
726 << "\n\\end_local_layout\n";
729 // then the text parameters
730 if (language != ignore_language)
731 os << "\\language " << language->lang() << '\n';
732 os << "\\inputencoding " << inputenc
733 << "\n\\font_roman " << fontsRoman
734 << "\n\\font_sans " << fontsSans
735 << "\n\\font_typewriter " << fontsTypewriter
736 << "\n\\font_default_family " << fontsDefaultFamily
737 << "\n\\font_sc " << convert<string>(fontsSC)
738 << "\n\\font_osf " << convert<string>(fontsOSF)
739 << "\n\\font_sf_scale " << fontsSansScale
740 << "\n\\font_tt_scale " << fontsTypewriterScale
742 if (!fontsCJK.empty()) {
743 os << "\\font_cjk " << fontsCJK << '\n';
745 os << "\n\\graphics " << graphicsDriver << '\n';
747 if (!float_placement.empty()) {
748 os << "\\float_placement " << float_placement << '\n';
750 os << "\\paperfontsize " << fontsize << '\n';
752 spacing().writeFile(os);
753 pdfoptions().writeFile(os);
755 os << "\\papersize " << string_papersize[papersize]
756 << "\n\\use_geometry " << convert<string>(use_geometry)
757 << "\n\\use_amsmath " << use_amsmath
758 << "\n\\use_esint " << use_esint
759 << "\n\\cite_engine " << citeenginetranslator().find(cite_engine_)
760 << "\n\\use_bibtopic " << convert<string>(use_bibtopic)
761 << "\n\\paperorientation " << string_orientation[orientation]
764 BranchList::const_iterator it = branchlist().begin();
765 BranchList::const_iterator end = branchlist().end();
766 for (; it != end; ++it) {
767 os << "\\branch " << to_utf8(it->branch())
768 << "\n\\selected " << it->isSelected()
769 << "\n\\color " << lyx::X11hexname(it->color())
774 if (!paperwidth.empty())
775 os << "\\paperwidth "
776 << VSpace(paperwidth).asLyXCommand() << '\n';
777 if (!paperheight.empty())
778 os << "\\paperheight "
779 << VSpace(paperheight).asLyXCommand() << '\n';
780 if (!leftmargin.empty())
781 os << "\\leftmargin "
782 << VSpace(leftmargin).asLyXCommand() << '\n';
783 if (!topmargin.empty())
785 << VSpace(topmargin).asLyXCommand() << '\n';
786 if (!rightmargin.empty())
787 os << "\\rightmargin "
788 << VSpace(rightmargin).asLyXCommand() << '\n';
789 if (!bottommargin.empty())
790 os << "\\bottommargin "
791 << VSpace(bottommargin).asLyXCommand() << '\n';
792 if (!headheight.empty())
793 os << "\\headheight "
794 << VSpace(headheight).asLyXCommand() << '\n';
795 if (!headsep.empty())
797 << VSpace(headsep).asLyXCommand() << '\n';
798 if (!footskip.empty())
800 << VSpace(footskip).asLyXCommand() << '\n';
801 if (!columnsep.empty())
803 << VSpace(columnsep).asLyXCommand() << '\n';
804 os << "\\secnumdepth " << secnumdepth
805 << "\n\\tocdepth " << tocdepth
806 << "\n\\paragraph_separation "
807 << string_paragraph_separation[paragraph_separation]
808 << "\n\\defskip " << getDefSkip().asLyXCommand()
809 << "\n\\quotes_language "
810 << string_quotes_language[quotes_language]
811 << "\n\\papercolumns " << columns
812 << "\n\\papersides " << sides
813 << "\n\\paperpagestyle " << pagestyle << '\n';
814 if (!listings_params.empty())
815 os << "\\listings_params \"" <<
816 InsetListingsParams(listings_params).encodedString() << "\"\n";
817 for (int i = 0; i < 4; ++i) {
818 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
819 if (user_defined_bullet(i).getFont() != -1) {
820 os << "\\bullet " << i << " "
821 << user_defined_bullet(i).getFont() << " "
822 << user_defined_bullet(i).getCharacter() << " "
823 << user_defined_bullet(i).getSize() << "\n";
827 os << "\\bulletLaTeX " << i << " \""
828 << lyx::to_ascii(user_defined_bullet(i).getText())
834 os << "\\tracking_changes " << convert<string>(trackChanges) << "\n";
835 os << "\\output_changes " << convert<string>(outputChanges) << "\n";
837 AuthorList::Authors::const_iterator a_it = pimpl_->authorlist.begin();
838 AuthorList::Authors::const_iterator a_end = pimpl_->authorlist.end();
839 for (; a_it != a_end; ++a_it) {
840 if (a_it->second.used())
841 os << "\\author " << a_it->second << "\n";
843 os << "\\author " << Author() << "\n";
848 void BufferParams::validate(LaTeXFeatures & features) const
850 features.require(documentClass().requires());
853 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
854 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
855 LaTeXFeatures::isAvailable("xcolor");
857 switch (features.runparams().flavor) {
858 case OutputParams::LATEX:
860 features.require("ct-dvipost");
861 features.require("dvipost");
862 } else if (xcolorsoul) {
863 features.require("ct-xcolor-soul");
864 features.require("soul");
865 features.require("xcolor");
867 features.require("ct-none");
870 case OutputParams::PDFLATEX:
872 features.require("ct-xcolor-soul");
873 features.require("soul");
874 features.require("xcolor");
875 // improves color handling in PDF output
876 features.require("pdfcolmk");
878 features.require("ct-none");
886 // Floats with 'Here definitely' as default setting.
887 if (float_placement.find('H') != string::npos)
888 features.require("float");
890 // AMS Style is at document level
891 if (use_amsmath == package_on
892 || documentClass().provides("amsmath"))
893 features.require("amsmath");
894 if (use_esint == package_on)
895 features.require("esint");
897 // Document-level line spacing
898 if (spacing().getSpace() != Spacing::Single && !spacing().isDefault())
899 features.require("setspace");
901 // the bullet shapes are buffer level not paragraph level
902 // so they are tested here
903 for (int i = 0; i < 4; ++i) {
904 if (user_defined_bullet(i) == ITEMIZE_DEFAULTS[i])
906 int const font = user_defined_bullet(i).getFont();
908 int const c = user_defined_bullet(i).getCharacter();
914 features.require("latexsym");
916 } else if (font == 1) {
917 features.require("amssymb");
918 } else if (font >= 2 && font <= 5) {
919 features.require("pifont");
923 if (pdfoptions().use_hyperref) {
924 features.require("hyperref");
925 // due to interferences with babel and hyperref, the color package has to
926 // be loaded after hyperref when hyperref is used with the colorlinks
927 // option, see http://bugzilla.lyx.org/show_bug.cgi?id=5291
928 if (pdfoptions().colorlinks)
929 features.require("color");
932 if (language->lang() == "vietnamese")
933 features.require("vietnamese");
934 else if (language->lang() == "japanese")
935 features.require("japanese");
939 bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
940 TexRow & texrow) const
942 os << "\\documentclass";
944 DocumentClass const & tclass = documentClass();
946 ostringstream clsoptions; // the document class options.
948 if (tokenPos(tclass.opt_fontsize(),
949 '|', fontsize) >= 0) {
950 // only write if existing in list (and not default)
951 clsoptions << fontsize << "pt,";
954 // custom, A3, B3 and B4 paper sizes need geometry
955 bool nonstandard_papersize = papersize == PAPER_B3
956 || papersize == PAPER_B4
957 || papersize == PAPER_A3
958 || papersize == PAPER_CUSTOM;
963 clsoptions << "a4paper,";
966 clsoptions << "letterpaper,";
969 clsoptions << "a5paper,";
972 clsoptions << "b5paper,";
974 case PAPER_USEXECUTIVE:
975 clsoptions << "executivepaper,";
978 clsoptions << "legalpaper,";
990 if (sides != tclass.sides()) {
993 clsoptions << "oneside,";
996 clsoptions << "twoside,";
1002 if (columns != tclass.columns()) {
1004 clsoptions << "twocolumn,";
1006 clsoptions << "onecolumn,";
1010 && orientation == ORIENTATION_LANDSCAPE)
1011 clsoptions << "landscape,";
1013 // language should be a parameter to \documentclass
1014 if (language->babel() == "hebrew"
1015 && default_language->babel() != "hebrew")
1016 // This seems necessary
1017 features.useLanguage(default_language);
1019 ostringstream language_options;
1020 bool const use_babel = features.useBabel();
1022 language_options << features.getLanguages();
1023 if (!language->babel().empty()) {
1024 if (!language_options.str().empty())
1025 language_options << ',';
1026 language_options << language->babel();
1028 // FIXME: don't hardcode this!
1029 // if Vietnamese is used, babel must directly be loaded
1030 // with language options, not in the class options, see
1031 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129417.html
1033 // the same is for all other languages that are not directly supported by
1034 // babel, but where LaTeX-packages add babel support.
1035 // this is currently the case for Latvian, Lithuanian, and Mongolian
1037 // if Japanese is used, babel must directly be loaded
1038 // with language options, not in the class options, see
1039 // http://bugzilla.lyx.org/show_bug.cgi?id=4597#c4
1040 if (lyxrc.language_global_options && !language_options.str().empty()
1041 && !features.hasLanguage("vietnam")
1042 && !features.hasLanguage("latvian")
1043 && !features.hasLanguage("lithuanian")
1044 && !features.hasLanguage("mongolian")
1045 && !features.hasLanguage("japanese"))
1046 clsoptions << language_options.str() << ',';
1049 // the user-defined options
1050 if (!options.empty()) {
1051 clsoptions << options << ',';
1054 string strOptions(clsoptions.str());
1055 if (!strOptions.empty()) {
1056 strOptions = rtrim(strOptions, ",");
1058 os << '[' << from_utf8(strOptions) << ']';
1061 os << '{' << from_ascii(tclass.latexname()) << "}\n";
1063 // end of \documentclass defs
1065 // font selection must be done before loading fontenc.sty
1066 string const fonts =
1067 loadFonts(fontsRoman, fontsSans,
1068 fontsTypewriter, fontsSC, fontsOSF,
1069 fontsSansScale, fontsTypewriterScale);
1070 if (!fonts.empty()) {
1071 os << from_ascii(fonts);
1074 if (fontsDefaultFamily != "default")
1075 os << "\\renewcommand{\\familydefault}{\\"
1076 << from_ascii(fontsDefaultFamily) << "}\n";
1078 // set font encoding
1079 // this one is not per buffer
1080 // for arabic_arabi and farsi we also need to load the LAE and
1082 if (lyxrc.fontenc != "default" && language->lang() != "japanese") {
1083 if (language->lang() == "arabic_arabi"
1084 || language->lang() == "farsi") {
1085 os << "\\usepackage[" << from_ascii(lyxrc.fontenc)
1086 << ",LFE,LAE]{fontenc}\n";
1089 os << "\\usepackage[" << from_ascii(lyxrc.fontenc)
1095 // handle inputenc etc.
1096 writeEncodingPreamble(os, features, texrow);
1098 if (!listings_params.empty() || features.isRequired("listings")) {
1099 os << "\\usepackage{listings}\n";
1102 if (!listings_params.empty()) {
1104 // do not test validity because listings_params is
1105 // supposed to be valid
1107 InsetListingsParams(listings_params).separatedParams(true);
1108 // we can't support all packages, but we should load the color package
1109 if (par.find("\\color", 0) != string::npos)
1110 features.require("color");
1111 os << from_utf8(par);
1112 // count the number of newlines
1113 for (size_t i = 0; i < par.size(); ++i)
1119 if (use_geometry || nonstandard_papersize) {
1120 os << "\\usepackage{geometry}\n";
1122 os << "\\geometry{verbose";
1123 if (orientation == ORIENTATION_LANDSCAPE)
1125 switch (papersize) {
1127 if (!paperwidth.empty())
1128 os << ",paperwidth="
1129 << from_ascii(paperwidth);
1130 if (!paperheight.empty())
1131 os << ",paperheight="
1132 << from_ascii(paperheight);
1134 case PAPER_USLETTER:
1135 os << ",letterpaper";
1138 os << ",legalpaper";
1140 case PAPER_USEXECUTIVE:
1141 os << ",executivepaper";
1162 // default papersize ie PAPER_DEFAULT
1163 switch (lyxrc.default_papersize) {
1164 case PAPER_DEFAULT: // keep compiler happy
1165 case PAPER_USLETTER:
1166 os << ",letterpaper";
1169 os << ",legalpaper";
1171 case PAPER_USEXECUTIVE:
1172 os << ",executivepaper";
1192 if (!topmargin.empty())
1193 os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1194 if (!bottommargin.empty())
1195 os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1196 if (!leftmargin.empty())
1197 os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1198 if (!rightmargin.empty())
1199 os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1200 if (!headheight.empty())
1201 os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1202 if (!headsep.empty())
1203 os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1204 if (!footskip.empty())
1205 os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1206 if (!columnsep.empty())
1207 os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
1210 } else if (orientation == ORIENTATION_LANDSCAPE) {
1211 features.require("papersize");
1214 if (tokenPos(tclass.opt_pagestyle(),
1215 '|', pagestyle) >= 0) {
1216 if (pagestyle == "fancy") {
1217 os << "\\usepackage{fancyhdr}\n";
1220 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1224 // Only if class has a ToC hierarchy
1225 if (tclass.hasTocLevels()) {
1226 if (secnumdepth != tclass.secnumdepth()) {
1227 os << "\\setcounter{secnumdepth}{"
1232 if (tocdepth != tclass.tocdepth()) {
1233 os << "\\setcounter{tocdepth}{"
1240 if (paragraph_separation) {
1241 switch (getDefSkip().kind()) {
1242 case VSpace::SMALLSKIP:
1243 os << "\\setlength{\\parskip}{\\smallskipamount}\n";
1245 case VSpace::MEDSKIP:
1246 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1248 case VSpace::BIGSKIP:
1249 os << "\\setlength{\\parskip}{\\bigskipamount}\n";
1251 case VSpace::LENGTH:
1252 os << "\\setlength{\\parskip}{"
1253 << from_utf8(getDefSkip().length().asLatexString())
1256 default: // should never happen // Then delete it.
1257 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1262 os << "\\setlength{\\parindent}{0pt}\n";
1266 // Now insert the LyX specific LaTeX commands...
1267 docstring lyxpreamble;
1269 // due to interferences with babel and hyperref, the color package has to
1270 // be loaded (when it is not already loaded) before babel when hyperref
1271 // is used with the colorlinks option, see
1272 // http://bugzilla.lyx.org/show_bug.cgi?id=5291
1273 // we decided therefore to load color always before babel, see
1274 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
1275 lyxpreamble += from_ascii(features.getColorOptions());
1277 // If we use hyperref, jurabib, japanese, or vietnamese, we have to call babel before them.
1279 && (features.isRequired("jurabib")
1280 || features.isRequired("hyperref")
1281 || features.isRequired("vietnamese")
1282 || features.isRequired("japanese") ) ) {
1284 lyxpreamble += from_utf8(babelCall(language_options.str())) + '\n';
1285 lyxpreamble += from_utf8(features.getBabelOptions()) + '\n';
1288 // The optional packages;
1289 lyxpreamble += from_ascii(features.getPackages());
1292 lyxpreamble += from_utf8(spacing().writePreamble(tclass.provides("SetSpace")));
1295 // * Hyperref manual: "Make sure it comes last of your loaded
1296 // packages, to give it a fighting chance of not being over-written,
1297 // since its job is to redefine many LaTeX commands."
1298 // * Email from Heiko Oberdiek: "It is usually better to load babel
1299 // before hyperref. Then hyperref has a chance to detect babel.
1300 // * Has to be loaded before the "LyX specific LaTeX commands" to
1301 // avoid errors with algorithm floats.
1302 // use hyperref explicitely when it is required
1303 if (features.isRequired("hyperref")) {
1304 odocstringstream oss;
1305 pdfoptions().writeLaTeX(oss, documentClass().provides("hyperref"));
1306 lyxpreamble += oss.str();
1309 // Will be surrounded by \makeatletter and \makeatother when needed
1310 docstring atlyxpreamble;
1312 // Some macros LyX will need
1313 docstring tmppreamble(from_ascii(features.getMacros()));
1315 if (!tmppreamble.empty())
1316 atlyxpreamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1317 "LyX specific LaTeX commands.\n"
1318 + tmppreamble + '\n';
1320 // the text class specific preamble
1321 tmppreamble = features.getTClassPreamble();
1322 if (!tmppreamble.empty())
1323 atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1324 "Textclass specific LaTeX commands.\n"
1325 + tmppreamble + '\n';
1327 /* the user-defined preamble */
1328 if (!preamble.empty())
1330 atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1331 "User specified LaTeX commands.\n"
1332 + from_utf8(preamble) + '\n';
1334 // subfig loads internally the LaTeX package "caption". As
1335 // caption is a very popular package, users will load it in
1336 // the preamble. Therefore we must load subfig behind the
1337 // user-defined preamble and check if the caption package was
1338 // loaded or not. For the case that caption is loaded before
1339 // subfig, there is the subfig option "caption=false". This
1340 // option also works when a koma-script class is used and
1341 // koma's own caption commands are used instead of caption. We
1342 // use \PassOptionsToPackage here because the user could have
1343 // already loaded subfig in the preamble.
1344 if (features.isRequired("subfig")) {
1345 atlyxpreamble += "\\@ifundefined{showcaptionsetup}{}{%\n"
1346 " \\PassOptionsToPackage{caption=false}{subfig}}\n"
1347 "\\usepackage{subfig}\n";
1350 // Itemize bullet settings need to be last in case the user
1351 // defines their own bullets that use a package included
1352 // in the user-defined preamble -- ARRae
1353 // Actually it has to be done much later than that
1354 // since some packages like frenchb make modifications
1355 // at \begin{document} time -- JMarc
1356 docstring bullets_def;
1357 for (int i = 0; i < 4; ++i) {
1358 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1359 if (bullets_def.empty())
1360 bullets_def += "\\AtBeginDocument{\n";
1361 bullets_def += " \\def\\labelitemi";
1363 // `i' is one less than the item to modify
1370 bullets_def += "ii";
1376 bullets_def += '{' +
1377 user_defined_bullet(i).getText()
1382 if (!bullets_def.empty())
1383 atlyxpreamble += bullets_def + "}\n\n";
1385 if (atlyxpreamble.find(from_ascii("@")) != docstring::npos)
1386 lyxpreamble += "\n\\makeatletter\n"
1387 + atlyxpreamble + "\\makeatother\n\n";
1389 lyxpreamble += '\n' + atlyxpreamble;
1391 // We try to load babel late, in case it interferes with other packages.
1392 // Jurabib and Hyperref have to be called after babel, though.
1393 if (use_babel && !features.isRequired("jurabib")
1394 && !features.isRequired("hyperref")
1395 && !features.isRequired("vietnamese")
1396 && !features.isRequired("japanese")) {
1398 lyxpreamble += from_utf8(babelCall(language_options.str())) + '\n';
1399 lyxpreamble += from_utf8(features.getBabelOptions()) + '\n';
1403 int(count(lyxpreamble.begin(), lyxpreamble.end(), '\n'));
1404 for (int j = 0; j != nlines; ++j) {
1413 void BufferParams::useClassDefaults()
1415 DocumentClass const & tclass = documentClass();
1417 sides = tclass.sides();
1418 columns = tclass.columns();
1419 pagestyle = tclass.pagestyle();
1420 options = tclass.options();
1421 // Only if class has a ToC hierarchy
1422 if (tclass.hasTocLevels()) {
1423 secnumdepth = tclass.secnumdepth();
1424 tocdepth = tclass.tocdepth();
1429 bool BufferParams::hasClassDefaults() const
1431 DocumentClass const & tclass = documentClass();
1433 return sides == tclass.sides()
1434 && columns == tclass.columns()
1435 && pagestyle == tclass.pagestyle()
1436 && options == tclass.options()
1437 && secnumdepth == tclass.secnumdepth()
1438 && tocdepth == tclass.tocdepth();
1442 DocumentClass const & BufferParams::documentClass() const
1448 DocumentClass const * BufferParams::documentClassPtr() const {
1453 void BufferParams::setDocumentClass(DocumentClass const * const tc) {
1454 // evil, but this function is evil
1455 doc_class_ = const_cast<DocumentClass *>(tc);
1459 bool BufferParams::setBaseClass(string const & classname)
1461 LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
1462 LayoutFileList & bcl = LayoutFileList::get();
1463 if (!bcl.haveClass(classname)) {
1465 bformat(_("The document class %1$s could not be found. "
1466 "A default textclass with default layouts will be used. "
1467 "LyX might not be able to produce output unless a correct "
1468 "textclass is selected from the document settings dialog."),
1469 from_utf8(classname));
1470 frontend::Alert::error(_("Document class not found"), s);
1471 bcl.addEmptyClass(classname);
1474 bool const success = bcl[classname].load();
1477 bformat(_("The document class %1$s could not be loaded."),
1478 from_utf8(classname));
1479 frontend::Alert::error(_("Could not load class"), s);
1483 pimpl_->baseClass_ = classname;
1485 // add any required modules not already in use
1486 list<string> const & mods = baseClass()->defaultModules();
1487 list<string>::const_iterator mit = mods.begin();
1488 list<string>::const_iterator men = mods.end();
1489 for (; mit != men; mit++) {
1490 string const & modName = *mit;
1491 // see if we're already in use
1492 if (find(layoutModules_.begin(), layoutModules_.end(), modName) !=
1493 layoutModules_.end()) {
1494 LYXERR(Debug::TCLASS, "Default module `" << modName <<
1495 "' not added because already used.");
1498 // make sure the user hasn't removed it
1499 if (find(removedModules_.begin(), removedModules_.end(), modName) !=
1500 removedModules_.end()) {
1501 LYXERR(Debug::TCLASS, "Default module `" << modName <<
1502 "' not added because removed by user.");
1505 // Now we want to check the list of selected modules to see if any of them
1506 // exclude this one.
1507 bool foundit = false;
1508 // so iterate over the selected modules...
1509 LayoutModuleList::const_iterator lit = layoutModules_.begin();
1510 LayoutModuleList::const_iterator len = layoutModules_.end();
1511 for (; lit != len; lit++) {
1512 LyXModule * lm = moduleList[*lit];
1515 vector<string> const & exc = lm->getExcludedModules();
1516 // ...and see if this one excludes us.
1517 if (find(exc.begin(), exc.end(), modName) != exc.end()) {
1519 LYXERR(Debug::TCLASS, "Default module `" << modName <<
1520 "' not added because excluded by loaded module `" <<
1526 LYXERR(Debug::TCLASS, "Default module `" << modName << "' added.");
1527 layoutModules_.push_back(modName);
1534 LayoutFile const * BufferParams::baseClass() const
1536 if (LayoutFileList::get().haveClass(pimpl_->baseClass_))
1537 return &(LayoutFileList::get()[pimpl_->baseClass_]);
1543 LayoutFileIndex const & BufferParams::baseClassID() const
1545 return pimpl_->baseClass_;
1549 void BufferParams::makeDocumentClass()
1554 doc_class_ = &(DocumentClassBundle::get().newClass(*baseClass()));
1556 // FIXME It might be worth loading the children's modules here,
1557 // just as we load their bibliographies and such, instead of just
1558 // doing a check in InsetInclude.
1559 LayoutModuleList::const_iterator it = layoutModules_.begin();
1560 for (; it != layoutModules_.end(); it++) {
1561 string const modName = *it;
1562 LyXModule * lm = moduleList[modName];
1564 docstring const msg =
1565 bformat(_("The module %1$s has been requested by\n"
1566 "this document but has not been found in the list of\n"
1567 "available modules. If you recently installed it, you\n"
1568 "probably need to reconfigure LyX.\n"), from_utf8(modName));
1569 frontend::Alert::warning(_("Module not available"),
1570 msg + _("Some layouts may not be available."));
1571 LYXERR0("BufferParams::makeDocumentClass(): Module " <<
1572 modName << " requested but not found in module list.");
1575 if (!lm->isAvailable()) {
1576 docstring const msg =
1577 bformat(_("The module %1$s requires a package that is\n"
1578 "not available in your LaTeX installation. LaTeX output\n"
1579 "may not be possible.\n"), from_utf8(modName));
1580 frontend::Alert::warning(_("Package not available"), msg);
1582 FileName layout_file = libFileSearch("layouts", lm->getFilename());
1583 if (!doc_class_->read(layout_file, TextClass::MODULE)) {
1584 docstring const msg =
1585 bformat(_("Error reading module %1$s\n"), from_utf8(modName));
1586 frontend::Alert::warning(_("Read Error"), msg);
1589 if (!local_layout.empty()) {
1590 if (!doc_class_->read(local_layout, TextClass::MODULE)) {
1591 docstring const msg = _("Error reading internal layout information");
1592 frontend::Alert::warning(_("Read Error"), msg);
1598 bool BufferParams::addLayoutModule(string const & modName)
1600 LayoutModuleList::const_iterator it = layoutModules_.begin();
1601 LayoutModuleList::const_iterator end = layoutModules_.end();
1602 for (; it != end; it++)
1605 layoutModules_.push_back(modName);
1610 Font const BufferParams::getFont() const
1612 FontInfo f = documentClass().defaultfont();
1613 if (fontsDefaultFamily == "rmdefault")
1614 f.setFamily(ROMAN_FAMILY);
1615 else if (fontsDefaultFamily == "sfdefault")
1616 f.setFamily(SANS_FAMILY);
1617 else if (fontsDefaultFamily == "ttdefault")
1618 f.setFamily(TYPEWRITER_FAMILY);
1619 return Font(f, language);
1623 void BufferParams::readPreamble(Lexer & lex)
1625 if (lex.getString() != "\\begin_preamble")
1626 lyxerr << "Error (BufferParams::readPreamble):"
1627 "consistency check failed." << endl;
1629 preamble = lex.getLongString("\\end_preamble");
1633 void BufferParams::readLocalLayout(Lexer & lex)
1635 if (lex.getString() != "\\begin_local_layout")
1636 lyxerr << "Error (BufferParams::readLocalLayout):"
1637 "consistency check failed." << endl;
1639 local_layout = lex.getLongString("\\end_local_layout");
1643 void BufferParams::readLanguage(Lexer & lex)
1645 if (!lex.next()) return;
1647 string const tmptok = lex.getString();
1649 // check if tmptok is part of tex_babel in tex-defs.h
1650 language = languages.getLanguage(tmptok);
1652 // Language tmptok was not found
1653 language = default_language;
1654 lyxerr << "Warning: Setting language `"
1655 << tmptok << "' to `" << language->lang()
1661 void BufferParams::readGraphicsDriver(Lexer & lex)
1666 string const tmptok = lex.getString();
1667 // check if tmptok is part of tex_graphics in tex_defs.h
1670 string const test = tex_graphics[n++];
1672 if (test == tmptok) {
1673 graphicsDriver = tmptok;
1678 "Warning: graphics driver `$$Token' not recognized!\n"
1679 " Setting graphics driver to `default'.\n");
1680 graphicsDriver = "default";
1687 void BufferParams::readBullets(Lexer & lex)
1692 int const index = lex.getInteger();
1694 int temp_int = lex.getInteger();
1695 user_defined_bullet(index).setFont(temp_int);
1696 temp_bullet(index).setFont(temp_int);
1698 user_defined_bullet(index).setCharacter(temp_int);
1699 temp_bullet(index).setCharacter(temp_int);
1701 user_defined_bullet(index).setSize(temp_int);
1702 temp_bullet(index).setSize(temp_int);
1706 void BufferParams::readBulletsLaTeX(Lexer & lex)
1708 // The bullet class should be able to read this.
1711 int const index = lex.getInteger();
1713 docstring const temp_str = lex.getDocString();
1715 user_defined_bullet(index).setText(temp_str);
1716 temp_bullet(index).setText(temp_str);
1720 void BufferParams::readModules(Lexer & lex)
1722 if (!lex.eatLine()) {
1723 lyxerr << "Error (BufferParams::readModules):"
1724 "Unexpected end of input." << endl;
1728 string mod = lex.getString();
1729 if (mod == "\\end_modules")
1731 addLayoutModule(mod);
1737 void BufferParams::readRemovedModules(Lexer & lex)
1739 if (!lex.eatLine()) {
1740 lyxerr << "Error (BufferParams::readRemovedModules):"
1741 "Unexpected end of input." << endl;
1745 string mod = lex.getString();
1746 if (mod == "\\end_removed_modules")
1748 removedModules_.insert(mod);
1751 // now we want to remove any removed modules that were previously
1752 // added. normally, that will be because default modules were added in
1753 // setBaseClass(), which gets called when \textclass is read at the
1754 // start of the read.
1755 set<string>::const_iterator rit = removedModules_.begin();
1756 set<string>::const_iterator const ren = removedModules_.end();
1757 for (; rit != ren; rit++) {
1758 LayoutModuleList::iterator const mit = layoutModules_.begin();
1759 LayoutModuleList::iterator const men = layoutModules_.end();
1760 LayoutModuleList::iterator found = find(mit, men, *rit);
1763 layoutModules_.erase(found);
1768 string BufferParams::paperSizeName(PapersizePurpose purpose) const
1770 char real_papersize = papersize;
1771 if (real_papersize == PAPER_DEFAULT)
1772 real_papersize = lyxrc.default_papersize;
1774 switch (real_papersize) {
1776 // could be anything, so don't guess
1778 case PAPER_CUSTOM: {
1779 if (purpose == XDVI && !paperwidth.empty() &&
1780 !paperheight.empty()) {
1781 // heightxwidth<unit>
1782 string first = paperwidth;
1783 string second = paperheight;
1784 if (orientation == ORIENTATION_LANDSCAPE)
1787 return first.erase(first.length() - 2)
1799 // dvips and dvipdfm do not know this
1800 if (purpose == DVIPS || purpose == DVIPDFM)
1804 // dvipdfm does not know this
1805 if (purpose == DVIPDFM)
1809 // dvipdfm does not know this
1810 if (purpose == DVIPDFM)
1813 case PAPER_USEXECUTIVE:
1814 // dvipdfm does not know this
1815 if (purpose == DVIPDFM)
1820 case PAPER_USLETTER:
1822 if (purpose == XDVI)
1829 string const BufferParams::dvips_options() const
1834 && papersize == PAPER_CUSTOM
1835 && !lyxrc.print_paper_dimension_flag.empty()
1836 && !paperwidth.empty()
1837 && !paperheight.empty()) {
1838 // using a custom papersize
1839 result = lyxrc.print_paper_dimension_flag;
1840 result += ' ' + paperwidth;
1841 result += ',' + paperheight;
1843 string const paper_option = paperSizeName(DVIPS);
1844 if (!paper_option.empty() && (paper_option != "letter" ||
1845 orientation != ORIENTATION_LANDSCAPE)) {
1846 // dvips won't accept -t letter -t landscape.
1847 // In all other cases, include the paper size
1849 result = lyxrc.print_paper_flag;
1850 result += ' ' + paper_option;
1853 if (orientation == ORIENTATION_LANDSCAPE &&
1854 papersize != PAPER_CUSTOM)
1855 result += ' ' + lyxrc.print_landscape_flag;
1860 string BufferParams::babelCall(string const & lang_opts) const
1862 string lang_pack = lyxrc.language_package;
1863 if (lang_pack != "\\usepackage{babel}")
1865 // suppress the babel call when there is no babel language defined
1866 // for the document language in the lib/languages file and if no
1867 // other languages are used (lang_opts is then empty)
1868 if (lang_opts.empty())
1870 // If Vietnamese is used, babel must directly be loaded with the
1871 // language options, see
1872 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129417.html
1873 size_t viet = lang_opts.find("vietnam");
1874 // viet = string::npos when not found
1875 // the same is for all other languages that are not directly supported by
1876 // babel, but where LaTeX-packages add babel support.
1877 // this is currently the case for Latvian, Lithuanian, and Mongolian
1878 size_t latvian = lang_opts.find("latvian");
1879 size_t lithu = lang_opts.find("lithuanian");
1880 size_t mongo = lang_opts.find("mongolian");
1881 // If Japanese is used, babel must directly be loaded with the
1882 // language options, see
1883 // http://bugzilla.lyx.org/show_bug.cgi?id=4597#c4
1884 size_t japan = lang_opts.find("japanese");
1885 if (!lyxrc.language_global_options || viet != string::npos
1886 || japan != string::npos || latvian != string::npos
1887 || lithu != string::npos || mongo != string::npos)
1888 return "\\usepackage[" + lang_opts + "]{babel}";
1893 void BufferParams::writeEncodingPreamble(odocstream & os,
1894 LaTeXFeatures & features, TexRow & texrow) const
1896 if (inputenc == "auto") {
1897 string const doc_encoding =
1898 language->encoding()->latexName();
1899 Encoding::Package const package =
1900 language->encoding()->package();
1902 // Create a list with all the input encodings used
1904 set<string> encodings =
1905 features.getEncodingSet(doc_encoding);
1907 // If the "japanese" package (i.e. pLaTeX) is used,
1908 // inputenc must be omitted.
1909 // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
1910 if (package == Encoding::japanese)
1911 features.require("japanese");
1913 if ((!encodings.empty() || package == Encoding::inputenc)
1914 && !features.isRequired("japanese")) {
1915 os << "\\usepackage[";
1916 set<string>::const_iterator it = encodings.begin();
1917 set<string>::const_iterator const end = encodings.end();
1919 os << from_ascii(*it);
1922 for (; it != end; ++it)
1923 os << ',' << from_ascii(*it);
1924 if (package == Encoding::inputenc) {
1925 if (!encodings.empty())
1927 os << from_ascii(doc_encoding);
1929 os << "]{inputenc}\n";
1932 if (package == Encoding::CJK || features.mustProvide("CJK")) {
1933 os << "\\usepackage{CJK}\n";
1936 } else if (inputenc != "default") {
1937 switch (encoding().package()) {
1938 case Encoding::none:
1939 case Encoding::japanese:
1941 case Encoding::inputenc:
1942 // do not load inputenc if japanese is used
1943 if (features.isRequired("japanese"))
1945 os << "\\usepackage[" << from_ascii(inputenc)
1950 os << "\\usepackage{CJK}\n";
1956 // The encoding "armscii8" (for Armenian) is only available when
1957 // the package "armtex" is loaded.
1958 if (language->encoding()->latexName() == "armscii8"
1959 || inputenc == "armscii8") {
1960 os << "\\usepackage{armtex}\n";
1966 string const BufferParams::loadFonts(string const & rm,
1967 string const & sf, string const & tt,
1968 bool const & sc, bool const & osf,
1969 int const & sfscale, int const & ttscale) const
1971 /* The LaTeX font world is in a flux. In the PSNFSS font interface,
1972 several packages have been replaced by others, that might not
1973 be installed on every system. We have to take care for that
1974 (see psnfss.pdf). We try to support all psnfss fonts as well
1975 as the fonts that have become de facto standard in the LaTeX
1976 world (e.g. Latin Modern). We do not support obsolete fonts
1977 (like PSLatex). In general, it should be possible to mix any
1978 rm font with any sf or tt font, respectively. (JSpitzm)
1980 -- separate math fonts.
1983 if (rm == "default" && sf == "default" && tt == "default")
1990 // Computer Modern (must be explicitely selectable -- there might be classes
1991 // that define a different default font!
1993 os << "\\renewcommand{\\rmdefault}{cmr}\n";
1994 // osf for Computer Modern needs eco.sty
1996 os << "\\usepackage{eco}\n";
1998 // Latin Modern Roman
1999 else if (rm == "lmodern")
2000 os << "\\usepackage{lmodern}\n";
2002 else if (rm == "ae") {
2003 // not needed when using OT1 font encoding.
2004 if (lyxrc.fontenc != "default")
2005 os << "\\usepackage{ae,aecompl}\n";
2008 else if (rm == "times") {
2009 // try to load the best available package
2010 if (LaTeXFeatures::isAvailable("mathptmx"))
2011 os << "\\usepackage{mathptmx}\n";
2012 else if (LaTeXFeatures::isAvailable("mathptm"))
2013 os << "\\usepackage{mathptm}\n";
2015 os << "\\usepackage{times}\n";
2018 else if (rm == "palatino") {
2019 // try to load the best available package
2020 if (LaTeXFeatures::isAvailable("mathpazo")) {
2021 os << "\\usepackage";
2027 // "osf" includes "sc"!
2031 os << "{mathpazo}\n";
2033 else if (LaTeXFeatures::isAvailable("mathpple"))
2034 os << "\\usepackage{mathpple}\n";
2036 os << "\\usepackage{palatino}\n";
2039 else if (rm == "utopia") {
2040 // fourier supersedes utopia.sty, but does
2041 // not work with OT1 encoding.
2042 if (LaTeXFeatures::isAvailable("fourier")
2043 && lyxrc.fontenc != "default") {
2044 os << "\\usepackage";
2055 os << "{fourier}\n";
2058 os << "\\usepackage{utopia}\n";
2060 // Bera (complete fontset)
2061 else if (rm == "bera" && sf == "default" && tt == "default")
2062 os << "\\usepackage{bera}\n";
2064 else if (rm != "default")
2065 os << "\\usepackage" << "{" << rm << "}\n";
2068 // Helvetica, Bera Sans
2069 if (sf == "helvet" || sf == "berasans") {
2071 os << "\\usepackage[scaled=" << float(sfscale) / 100
2072 << "]{" << sf << "}\n";
2074 os << "\\usepackage{" << sf << "}\n";
2077 else if (sf == "avant")
2078 os << "\\usepackage{" << sf << "}\n";
2079 // Computer Modern, Latin Modern, CM Bright
2080 else if (sf != "default")
2081 os << "\\renewcommand{\\sfdefault}{" << sf << "}\n";
2083 // monospaced/typewriter
2084 // Courier, LuxiMono
2085 if (tt == "luximono" || tt == "beramono") {
2087 os << "\\usepackage[scaled=" << float(ttscale) / 100
2088 << "]{" << tt << "}\n";
2090 os << "\\usepackage{" << tt << "}\n";
2093 else if (tt == "courier" )
2094 os << "\\usepackage{" << tt << "}\n";
2095 // Computer Modern, Latin Modern, CM Bright
2096 else if (tt != "default")
2097 os << "\\renewcommand{\\ttdefault}{" << tt << "}\n";
2103 Encoding const & BufferParams::encoding() const
2105 if (inputenc == "auto" || inputenc == "default")
2106 return *language->encoding();
2107 Encoding const * const enc = encodings.fromLaTeXName(inputenc);
2110 LYXERR0("Unknown inputenc value `" << inputenc
2111 << "'. Using `auto' instead.");
2112 return *language->encoding();
2116 CiteEngine BufferParams::citeEngine() const
2118 // FIXME the class should provide the numerical/
2119 // authoryear choice
2120 if (documentClass().provides("natbib")
2121 && cite_engine_ != ENGINE_NATBIB_NUMERICAL)
2122 return ENGINE_NATBIB_AUTHORYEAR;
2123 return cite_engine_;
2127 void BufferParams::setCiteEngine(CiteEngine cite_engine)
2129 cite_engine_ = cite_engine;