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;
338 use_default_options = true;
341 language = default_language;
342 fontsRoman = "default";
343 fontsSans = "default";
344 fontsTypewriter = "default";
345 fontsDefaultFamily = "default";
348 fontsSansScale = 100;
349 fontsTypewriterScale = 100;
351 graphicsDriver = "default";
354 listings_params = string();
355 pagestyle = "default";
357 for (int iter = 0; iter < 4; ++iter) {
358 user_defined_bullet(iter) = ITEMIZE_DEFAULTS[iter];
359 temp_bullet(iter) = ITEMIZE_DEFAULTS[iter];
364 docstring BufferParams::B_(string const & l10n) const
366 LASSERT(language, /**/);
367 return getMessages(language->code()).get(l10n);
371 AuthorList & BufferParams::authors()
373 return pimpl_->authorlist;
377 AuthorList const & BufferParams::authors() const
379 return pimpl_->authorlist;
383 BranchList & BufferParams::branchlist()
385 return pimpl_->branchlist;
389 BranchList const & BufferParams::branchlist() const
391 return pimpl_->branchlist;
395 Bullet & BufferParams::temp_bullet(lyx::size_type const index)
397 LASSERT(index < 4, /**/);
398 return pimpl_->temp_bullets[index];
402 Bullet const & BufferParams::temp_bullet(lyx::size_type const index) const
404 LASSERT(index < 4, /**/);
405 return pimpl_->temp_bullets[index];
409 Bullet & BufferParams::user_defined_bullet(lyx::size_type const index)
411 LASSERT(index < 4, /**/);
412 return pimpl_->user_defined_bullets[index];
416 Bullet const & BufferParams::user_defined_bullet(lyx::size_type const index) const
418 LASSERT(index < 4, /**/);
419 return pimpl_->user_defined_bullets[index];
423 Spacing & BufferParams::spacing()
425 return pimpl_->spacing;
429 Spacing const & BufferParams::spacing() const
431 return pimpl_->spacing;
435 PDFOptions & BufferParams::pdfoptions()
437 return pimpl_->pdfoptions;
441 PDFOptions const & BufferParams::pdfoptions() const
443 return pimpl_->pdfoptions;
447 VSpace const & BufferParams::getDefSkip() const
449 return pimpl_->defskip;
453 void BufferParams::setDefSkip(VSpace const & vs)
455 pimpl_->defskip = vs;
459 string BufferParams::readToken(Lexer & lex, string const & token,
460 FileName const & filepath)
462 if (token == "\\textclass") {
464 string const classname = lex.getString();
465 // if there exists a local layout file, ignore the system one
466 // NOTE: in this case, the textclass (.cls file) is assumed to be available.
468 LayoutFileList & bcl = LayoutFileList::get();
469 if (tcp.empty() && !filepath.empty())
470 tcp = bcl.addLocalLayout(classname, filepath.absFilename());
474 setBaseClass(classname);
475 // We assume that a tex class exists for local or unknown layouts so this warning
476 // will only be given for system layouts.
477 if (!baseClass()->isTeXClassAvailable()) {
478 docstring const msg =
479 bformat(_("The layout file requested by this document,\n"
481 "is not usable. This is probably because a LaTeX\n"
482 "class or style file required by it is not\n"
483 "available. See the Customization documentation\n"
484 "for more information.\n"), from_utf8(classname));
485 frontend::Alert::warning(_("Document class not available"),
486 msg + _("LyX will not be able to produce output."));
488 } else if (token == "\\begin_preamble") {
490 } else if (token == "\\begin_local_layout") {
491 readLocalLayout(lex);
492 } else if (token == "\\begin_modules") {
494 } else if (token == "\\begin_removed_modules") {
495 readRemovedModules(lex);
496 } else if (token == "\\options") {
498 options = lex.getString();
499 } else if (token == "\\use_default_options") {
500 lex >> use_default_options;
501 } else if (token == "\\master") {
503 master = lex.getString();
504 } else if (token == "\\language") {
506 } else if (token == "\\inputencoding") {
508 } else if (token == "\\graphics") {
509 readGraphicsDriver(lex);
510 } else if (token == "\\font_roman") {
512 } else if (token == "\\font_sans") {
514 } else if (token == "\\font_typewriter") {
515 lex >> fontsTypewriter;
516 } else if (token == "\\font_default_family") {
517 lex >> fontsDefaultFamily;
518 } else if (token == "\\font_sc") {
520 } else if (token == "\\font_osf") {
522 } else if (token == "\\font_sf_scale") {
523 lex >> fontsSansScale;
524 } else if (token == "\\font_tt_scale") {
525 lex >> fontsTypewriterScale;
526 } else if (token == "\\font_cjk") {
528 } else if (token == "\\paragraph_separation") {
531 paragraph_separation = parseptranslator().find(parsep);
532 } else if (token == "\\defskip") {
534 string defskip = lex.getString();
535 if (defskip == "defskip")
538 pimpl_->defskip = VSpace(defskip);
539 } else if (token == "\\quotes_language") {
542 quotes_language = quoteslangtranslator().find(quotes_lang);
543 } else if (token == "\\papersize") {
546 papersize = papersizetranslator().find(ppsize);
547 } else if (token == "\\use_geometry") {
549 } else if (token == "\\use_amsmath") {
552 use_amsmath = packagetranslator().find(use_ams);
553 } else if (token == "\\use_esint") {
556 use_esint = packagetranslator().find(useesint);
557 } else if (token == "\\cite_engine") {
560 cite_engine_ = citeenginetranslator().find(engine);
561 } else if (token == "\\use_bibtopic") {
563 } else if (token == "\\tracking_changes") {
565 } else if (token == "\\output_changes") {
566 lex >> outputChanges;
567 } else if (token == "\\branch") {
569 docstring branch = lex.getDocString();
570 branchlist().add(branch);
573 string const tok = lex.getString();
574 if (tok == "\\end_branch")
576 Branch * branch_ptr = branchlist().find(branch);
577 if (tok == "\\selected") {
580 branch_ptr->setSelected(lex.getInteger());
582 // not yet operational
583 if (tok == "\\color") {
585 string color = lex.getString();
587 branch_ptr->setColor(color);
588 // Update also the Color table:
590 color = lcolor.getX11Name(Color_background);
592 lcolor.setColor(to_utf8(branch), color);
596 } else if (token == "\\author") {
598 istringstream ss(lex.getString());
601 author_map.push_back(pimpl_->authorlist.record(a));
602 } else if (token == "\\paperorientation") {
605 orientation = paperorientationtranslator().find(orient);
606 } else if (token == "\\paperwidth") {
608 } else if (token == "\\paperheight") {
610 } else if (token == "\\leftmargin") {
612 } else if (token == "\\topmargin") {
614 } else if (token == "\\rightmargin") {
616 } else if (token == "\\bottommargin") {
618 } else if (token == "\\headheight") {
620 } else if (token == "\\headsep") {
622 } else if (token == "\\footskip") {
624 } else if (token == "\\columnsep") {
626 } else if (token == "\\paperfontsize") {
628 } else if (token == "\\papercolumns") {
630 } else if (token == "\\listings_params") {
633 listings_params = InsetListingsParams(par).params();
634 } else if (token == "\\papersides") {
637 sides = sidestranslator().find(psides);
638 } else if (token == "\\paperpagestyle") {
640 } else if (token == "\\bullet") {
642 } else if (token == "\\bulletLaTeX") {
643 readBulletsLaTeX(lex);
644 } else if (token == "\\secnumdepth") {
646 } else if (token == "\\tocdepth") {
648 } else if (token == "\\spacing") {
652 if (nspacing == "other") {
655 spacing().set(spacetranslator().find(nspacing), tmp_val);
656 } else if (token == "\\float_placement") {
657 lex >> float_placement;
659 } else if (prefixIs(token, "\\pdf_") || token == "\\use_hyperref") {
660 string toktmp = pdfoptions().readToken(lex, token);
661 if (!toktmp.empty()) {
662 lyxerr << "PDFOptions::readToken(): Unknown token: " <<
667 lyxerr << "BufferParams::readToken(): Unknown token: " <<
676 void BufferParams::writeFile(ostream & os) const
678 // The top of the file is written by the buffer.
679 // Prints out the buffer info into the .lyx file given by file
682 os << "\\textclass " << baseClass()->name() << '\n';
685 if (!preamble.empty()) {
686 // remove '\n' from the end of preamble
687 string const tmppreamble = rtrim(preamble, "\n");
688 os << "\\begin_preamble\n"
690 << "\n\\end_preamble\n";
694 if (!options.empty()) {
695 os << "\\options " << options << '\n';
698 // use the class options defined in the layout?
699 os << "\\use_default_options "
700 << convert<string>(use_default_options) << "\n";
702 // the master document
703 if (!master.empty()) {
704 os << "\\master " << master << '\n';
708 if (!removedModules_.empty()) {
709 os << "\\begin_removed_modules" << '\n';
710 set<string>::const_iterator it = removedModules_.begin();
711 set<string>::const_iterator en = removedModules_.end();
712 for (; it != en; it++)
714 os << "\\end_removed_modules" << '\n';
718 if (!layoutModules_.empty()) {
719 os << "\\begin_modules" << '\n';
720 LayoutModuleList::const_iterator it = layoutModules_.begin();
721 LayoutModuleList::const_iterator en = layoutModules_.end();
722 for (; it != en; it++)
724 os << "\\end_modules" << '\n';
727 // local layout information
728 if (!local_layout.empty()) {
729 // remove '\n' from the end
730 string const tmplocal = rtrim(local_layout, "\n");
731 os << "\\begin_local_layout\n"
733 << "\n\\end_local_layout\n";
736 // then the text parameters
737 if (language != ignore_language)
738 os << "\\language " << language->lang() << '\n';
739 os << "\\inputencoding " << inputenc
740 << "\n\\font_roman " << fontsRoman
741 << "\n\\font_sans " << fontsSans
742 << "\n\\font_typewriter " << fontsTypewriter
743 << "\n\\font_default_family " << fontsDefaultFamily
744 << "\n\\font_sc " << convert<string>(fontsSC)
745 << "\n\\font_osf " << convert<string>(fontsOSF)
746 << "\n\\font_sf_scale " << fontsSansScale
747 << "\n\\font_tt_scale " << fontsTypewriterScale
749 if (!fontsCJK.empty()) {
750 os << "\\font_cjk " << fontsCJK << '\n';
752 os << "\n\\graphics " << graphicsDriver << '\n';
754 if (!float_placement.empty()) {
755 os << "\\float_placement " << float_placement << '\n';
757 os << "\\paperfontsize " << fontsize << '\n';
759 spacing().writeFile(os);
760 pdfoptions().writeFile(os);
762 os << "\\papersize " << string_papersize[papersize]
763 << "\n\\use_geometry " << convert<string>(use_geometry)
764 << "\n\\use_amsmath " << use_amsmath
765 << "\n\\use_esint " << use_esint
766 << "\n\\cite_engine " << citeenginetranslator().find(cite_engine_)
767 << "\n\\use_bibtopic " << convert<string>(use_bibtopic)
768 << "\n\\paperorientation " << string_orientation[orientation]
771 BranchList::const_iterator it = branchlist().begin();
772 BranchList::const_iterator end = branchlist().end();
773 for (; it != end; ++it) {
774 os << "\\branch " << to_utf8(it->branch())
775 << "\n\\selected " << it->isSelected()
776 << "\n\\color " << lyx::X11hexname(it->color())
781 if (!paperwidth.empty())
782 os << "\\paperwidth "
783 << VSpace(paperwidth).asLyXCommand() << '\n';
784 if (!paperheight.empty())
785 os << "\\paperheight "
786 << VSpace(paperheight).asLyXCommand() << '\n';
787 if (!leftmargin.empty())
788 os << "\\leftmargin "
789 << VSpace(leftmargin).asLyXCommand() << '\n';
790 if (!topmargin.empty())
792 << VSpace(topmargin).asLyXCommand() << '\n';
793 if (!rightmargin.empty())
794 os << "\\rightmargin "
795 << VSpace(rightmargin).asLyXCommand() << '\n';
796 if (!bottommargin.empty())
797 os << "\\bottommargin "
798 << VSpace(bottommargin).asLyXCommand() << '\n';
799 if (!headheight.empty())
800 os << "\\headheight "
801 << VSpace(headheight).asLyXCommand() << '\n';
802 if (!headsep.empty())
804 << VSpace(headsep).asLyXCommand() << '\n';
805 if (!footskip.empty())
807 << VSpace(footskip).asLyXCommand() << '\n';
808 if (!columnsep.empty())
810 << VSpace(columnsep).asLyXCommand() << '\n';
811 os << "\\secnumdepth " << secnumdepth
812 << "\n\\tocdepth " << tocdepth
813 << "\n\\paragraph_separation "
814 << string_paragraph_separation[paragraph_separation]
815 << "\n\\defskip " << getDefSkip().asLyXCommand()
816 << "\n\\quotes_language "
817 << string_quotes_language[quotes_language]
818 << "\n\\papercolumns " << columns
819 << "\n\\papersides " << sides
820 << "\n\\paperpagestyle " << pagestyle << '\n';
821 if (!listings_params.empty())
822 os << "\\listings_params \"" <<
823 InsetListingsParams(listings_params).encodedString() << "\"\n";
824 for (int i = 0; i < 4; ++i) {
825 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
826 if (user_defined_bullet(i).getFont() != -1) {
827 os << "\\bullet " << i << " "
828 << user_defined_bullet(i).getFont() << " "
829 << user_defined_bullet(i).getCharacter() << " "
830 << user_defined_bullet(i).getSize() << "\n";
834 os << "\\bulletLaTeX " << i << " \""
835 << lyx::to_ascii(user_defined_bullet(i).getText())
841 os << "\\tracking_changes " << convert<string>(trackChanges) << "\n";
842 os << "\\output_changes " << convert<string>(outputChanges) << "\n";
844 AuthorList::Authors::const_iterator a_it = pimpl_->authorlist.begin();
845 AuthorList::Authors::const_iterator a_end = pimpl_->authorlist.end();
846 for (; a_it != a_end; ++a_it) {
847 if (a_it->second.used())
848 os << "\\author " << a_it->second << "\n";
850 os << "\\author " << Author() << "\n";
855 void BufferParams::validate(LaTeXFeatures & features) const
857 features.require(documentClass().requires());
860 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
861 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
862 LaTeXFeatures::isAvailable("xcolor");
864 switch (features.runparams().flavor) {
865 case OutputParams::LATEX:
867 features.require("ct-dvipost");
868 features.require("dvipost");
869 } else if (xcolorsoul) {
870 features.require("ct-xcolor-soul");
871 features.require("soul");
872 features.require("xcolor");
874 features.require("ct-none");
877 case OutputParams::PDFLATEX:
879 features.require("ct-xcolor-soul");
880 features.require("soul");
881 features.require("xcolor");
882 // improves color handling in PDF output
883 features.require("pdfcolmk");
885 features.require("ct-none");
893 // Floats with 'Here definitely' as default setting.
894 if (float_placement.find('H') != string::npos)
895 features.require("float");
897 // AMS Style is at document level
898 if (use_amsmath == package_on
899 || documentClass().provides("amsmath"))
900 features.require("amsmath");
901 if (use_esint == package_on)
902 features.require("esint");
904 // Document-level line spacing
905 if (spacing().getSpace() != Spacing::Single && !spacing().isDefault())
906 features.require("setspace");
908 // the bullet shapes are buffer level not paragraph level
909 // so they are tested here
910 for (int i = 0; i < 4; ++i) {
911 if (user_defined_bullet(i) == ITEMIZE_DEFAULTS[i])
913 int const font = user_defined_bullet(i).getFont();
915 int const c = user_defined_bullet(i).getCharacter();
921 features.require("latexsym");
923 } else if (font == 1) {
924 features.require("amssymb");
925 } else if (font >= 2 && font <= 5) {
926 features.require("pifont");
930 if (pdfoptions().use_hyperref) {
931 features.require("hyperref");
932 // due to interferences with babel and hyperref, the color package has to
933 // be loaded after hyperref when hyperref is used with the colorlinks
934 // option, see http://bugzilla.lyx.org/show_bug.cgi?id=5291
935 if (pdfoptions().colorlinks)
936 features.require("color");
939 if (language->lang() == "vietnamese")
940 features.require("vietnamese");
941 else if (language->lang() == "japanese")
942 features.require("japanese");
946 bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
947 TexRow & texrow) const
949 os << "\\documentclass";
951 DocumentClass const & tclass = documentClass();
953 ostringstream clsoptions; // the document class options.
955 if (tokenPos(tclass.opt_fontsize(),
956 '|', fontsize) >= 0) {
957 // only write if existing in list (and not default)
958 clsoptions << fontsize << "pt,";
961 // custom, A3, B3 and B4 paper sizes need geometry
962 bool nonstandard_papersize = papersize == PAPER_B3
963 || papersize == PAPER_B4
964 || papersize == PAPER_A3
965 || papersize == PAPER_CUSTOM;
970 clsoptions << "a4paper,";
973 clsoptions << "letterpaper,";
976 clsoptions << "a5paper,";
979 clsoptions << "b5paper,";
981 case PAPER_USEXECUTIVE:
982 clsoptions << "executivepaper,";
985 clsoptions << "legalpaper,";
997 if (sides != tclass.sides()) {
1000 clsoptions << "oneside,";
1003 clsoptions << "twoside,";
1009 if (columns != tclass.columns()) {
1011 clsoptions << "twocolumn,";
1013 clsoptions << "onecolumn,";
1017 && orientation == ORIENTATION_LANDSCAPE)
1018 clsoptions << "landscape,";
1020 // language should be a parameter to \documentclass
1021 if (language->babel() == "hebrew"
1022 && default_language->babel() != "hebrew")
1023 // This seems necessary
1024 features.useLanguage(default_language);
1026 ostringstream language_options;
1027 bool const use_babel = features.useBabel();
1029 language_options << features.getLanguages();
1030 if (!language->babel().empty()) {
1031 if (!language_options.str().empty())
1032 language_options << ',';
1033 language_options << language->babel();
1035 // if Vietnamese is used, babel must directly be loaded
1036 // with language options, not in the class options, see
1037 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129417.html
1038 size_t viet = language_options.str().find("vietnam");
1039 // viet = string::npos when not found
1040 // the same is for all other languages that are not directly supported by
1041 // babel, but where LaTeX-packages add babel support.
1042 // this is currently the case for Latvian, Lithuanian, and Mongolian
1043 size_t latvian = language_options.str().find("latvian");
1044 size_t lithu = language_options.str().find("lithuanian");
1045 size_t mongo = language_options.str().find("mongolian");
1046 // if Japanese is used, babel must directly be loaded
1047 // with language options, not in the class options, see
1048 // http://bugzilla.lyx.org/show_bug.cgi?id=4597#c4
1049 size_t japan = language_options.str().find("japanese");
1050 if (lyxrc.language_global_options && !language_options.str().empty()
1051 && viet == string::npos && japan == string::npos
1052 && latvian == string::npos && lithu == string::npos
1053 && mongo == string::npos)
1054 clsoptions << language_options.str() << ',';
1057 // the predefined options from the layout
1058 if (use_default_options && !tclass.options().empty())
1059 clsoptions << tclass.options() << ',';
1061 // the user-defined options
1062 if (!options.empty()) {
1063 clsoptions << options << ',';
1066 string strOptions(clsoptions.str());
1067 if (!strOptions.empty()) {
1068 strOptions = rtrim(strOptions, ",");
1070 os << '[' << from_utf8(strOptions) << ']';
1073 os << '{' << from_ascii(tclass.latexname()) << "}\n";
1075 // end of \documentclass defs
1077 // font selection must be done before loading fontenc.sty
1078 string const fonts =
1079 loadFonts(fontsRoman, fontsSans,
1080 fontsTypewriter, fontsSC, fontsOSF,
1081 fontsSansScale, fontsTypewriterScale);
1082 if (!fonts.empty()) {
1083 os << from_ascii(fonts);
1086 if (fontsDefaultFamily != "default")
1087 os << "\\renewcommand{\\familydefault}{\\"
1088 << from_ascii(fontsDefaultFamily) << "}\n";
1090 // set font encoding
1091 // this one is not per buffer
1092 // for arabic_arabi and farsi we also need to load the LAE and
1094 if (lyxrc.fontenc != "default" && language->lang() != "japanese") {
1095 if (language->lang() == "arabic_arabi"
1096 || language->lang() == "farsi") {
1097 os << "\\usepackage[" << from_ascii(lyxrc.fontenc)
1098 << ",LFE,LAE]{fontenc}\n";
1101 os << "\\usepackage[" << from_ascii(lyxrc.fontenc)
1107 // handle inputenc etc.
1108 writeEncodingPreamble(os, features, texrow);
1110 if (!listings_params.empty() || features.isRequired("listings")) {
1111 os << "\\usepackage{listings}\n";
1114 if (!listings_params.empty()) {
1116 // do not test validity because listings_params is
1117 // supposed to be valid
1119 InsetListingsParams(listings_params).separatedParams(true);
1120 // we can't support all packages, but we should load the color package
1121 if (par.find("\\color", 0) != string::npos)
1122 features.require("color");
1123 os << from_utf8(par);
1124 // count the number of newlines
1125 for (size_t i = 0; i < par.size(); ++i)
1131 if (use_geometry || nonstandard_papersize) {
1132 os << "\\usepackage{geometry}\n";
1134 os << "\\geometry{verbose";
1135 if (orientation == ORIENTATION_LANDSCAPE)
1137 switch (papersize) {
1139 if (!paperwidth.empty())
1140 os << ",paperwidth="
1141 << from_ascii(paperwidth);
1142 if (!paperheight.empty())
1143 os << ",paperheight="
1144 << from_ascii(paperheight);
1146 case PAPER_USLETTER:
1147 os << ",letterpaper";
1150 os << ",legalpaper";
1152 case PAPER_USEXECUTIVE:
1153 os << ",executivepaper";
1174 // default papersize ie PAPER_DEFAULT
1175 switch (lyxrc.default_papersize) {
1176 case PAPER_DEFAULT: // keep compiler happy
1177 case PAPER_USLETTER:
1178 os << ",letterpaper";
1181 os << ",legalpaper";
1183 case PAPER_USEXECUTIVE:
1184 os << ",executivepaper";
1204 if (!topmargin.empty())
1205 os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1206 if (!bottommargin.empty())
1207 os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1208 if (!leftmargin.empty())
1209 os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1210 if (!rightmargin.empty())
1211 os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1212 if (!headheight.empty())
1213 os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1214 if (!headsep.empty())
1215 os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1216 if (!footskip.empty())
1217 os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1218 if (!columnsep.empty())
1219 os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
1222 } else if (orientation == ORIENTATION_LANDSCAPE) {
1223 features.require("papersize");
1226 if (tokenPos(tclass.opt_pagestyle(),
1227 '|', pagestyle) >= 0) {
1228 if (pagestyle == "fancy") {
1229 os << "\\usepackage{fancyhdr}\n";
1232 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1236 // Only if class has a ToC hierarchy
1237 if (tclass.hasTocLevels()) {
1238 if (secnumdepth != tclass.secnumdepth()) {
1239 os << "\\setcounter{secnumdepth}{"
1244 if (tocdepth != tclass.tocdepth()) {
1245 os << "\\setcounter{tocdepth}{"
1252 if (paragraph_separation) {
1253 switch (getDefSkip().kind()) {
1254 case VSpace::SMALLSKIP:
1255 os << "\\setlength{\\parskip}{\\smallskipamount}\n";
1257 case VSpace::MEDSKIP:
1258 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1260 case VSpace::BIGSKIP:
1261 os << "\\setlength{\\parskip}{\\bigskipamount}\n";
1263 case VSpace::LENGTH:
1264 os << "\\setlength{\\parskip}{"
1265 << from_utf8(getDefSkip().length().asLatexString())
1268 default: // should never happen // Then delete it.
1269 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1274 os << "\\setlength{\\parindent}{0pt}\n";
1278 // Now insert the LyX specific LaTeX commands...
1279 docstring lyxpreamble;
1281 // due to interferences with babel and hyperref, the color package has to
1282 // be loaded (when it is not already loaded) before babel when hyperref
1283 // is used with the colorlinks option, see
1284 // http://bugzilla.lyx.org/show_bug.cgi?id=5291
1285 // we decided therefore to load color always before babel, see
1286 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
1287 lyxpreamble += from_ascii(features.getColorOptions());
1289 // If we use hyperref, jurabib, japanese, or vietnamese, we have to call babel before them.
1291 && (features.isRequired("jurabib")
1292 || features.isRequired("hyperref")
1293 || features.isRequired("vietnamese")
1294 || features.isRequired("japanese") ) ) {
1296 lyxpreamble += from_utf8(babelCall(language_options.str())) + '\n';
1297 lyxpreamble += from_utf8(features.getBabelOptions()) + '\n';
1300 // The optional packages;
1301 lyxpreamble += from_ascii(features.getPackages());
1304 lyxpreamble += from_utf8(spacing().writePreamble(tclass.provides("SetSpace")));
1307 // * Hyperref manual: "Make sure it comes last of your loaded
1308 // packages, to give it a fighting chance of not being over-written,
1309 // since its job is to redefine many LaTeX commands."
1310 // * Email from Heiko Oberdiek: "It is usually better to load babel
1311 // before hyperref. Then hyperref has a chance to detect babel.
1312 // * Has to be loaded before the "LyX specific LaTeX commands" to
1313 // avoid errors with algorithm floats.
1314 // use hyperref explicitely when it is required
1315 if (features.isRequired("hyperref")) {
1316 odocstringstream oss;
1317 pdfoptions().writeLaTeX(oss, documentClass().provides("hyperref"));
1318 lyxpreamble += oss.str();
1321 // Will be surrounded by \makeatletter and \makeatother when needed
1322 docstring atlyxpreamble;
1324 // Some macros LyX will need
1325 docstring tmppreamble(from_ascii(features.getMacros()));
1327 if (!tmppreamble.empty())
1328 atlyxpreamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1329 "LyX specific LaTeX commands.\n"
1330 + tmppreamble + '\n';
1332 // the text class specific preamble
1333 tmppreamble = features.getTClassPreamble();
1334 if (!tmppreamble.empty())
1335 atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1336 "Textclass specific LaTeX commands.\n"
1337 + tmppreamble + '\n';
1339 /* the user-defined preamble */
1340 if (!preamble.empty())
1342 atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1343 "User specified LaTeX commands.\n"
1344 + from_utf8(preamble) + '\n';
1346 // subfig loads internally the LaTeX package "caption". As
1347 // caption is a very popular package, users will load it in
1348 // the preamble. Therefore we must load subfig behind the
1349 // user-defined preamble and check if the caption package was
1350 // loaded or not. For the case that caption is loaded before
1351 // subfig, there is the subfig option "caption=false". This
1352 // option also works when a koma-script class is used and
1353 // koma's own caption commands are used instead of caption. We
1354 // use \PassOptionsToPackage here because the user could have
1355 // already loaded subfig in the preamble.
1356 if (features.isRequired("subfig")) {
1357 atlyxpreamble += "\\@ifundefined{showcaptionsetup}{}{%\n"
1358 " \\PassOptionsToPackage{caption=false}{subfig}}\n"
1359 "\\usepackage{subfig}\n";
1362 // Itemize bullet settings need to be last in case the user
1363 // defines their own bullets that use a package included
1364 // in the user-defined preamble -- ARRae
1365 // Actually it has to be done much later than that
1366 // since some packages like frenchb make modifications
1367 // at \begin{document} time -- JMarc
1368 docstring bullets_def;
1369 for (int i = 0; i < 4; ++i) {
1370 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1371 if (bullets_def.empty())
1372 bullets_def += "\\AtBeginDocument{\n";
1373 bullets_def += " \\def\\labelitemi";
1375 // `i' is one less than the item to modify
1382 bullets_def += "ii";
1388 bullets_def += '{' +
1389 user_defined_bullet(i).getText()
1394 if (!bullets_def.empty())
1395 atlyxpreamble += bullets_def + "}\n\n";
1397 if (atlyxpreamble.find(from_ascii("@")) != docstring::npos)
1398 lyxpreamble += "\n\\makeatletter\n"
1399 + atlyxpreamble + "\\makeatother\n\n";
1401 lyxpreamble += '\n' + atlyxpreamble;
1403 // We try to load babel late, in case it interferes with other packages.
1404 // Jurabib and Hyperref have to be called after babel, though.
1405 if (use_babel && !features.isRequired("jurabib")
1406 && !features.isRequired("hyperref")
1407 && !features.isRequired("vietnamese")
1408 && !features.isRequired("japanese")) {
1410 lyxpreamble += from_utf8(babelCall(language_options.str())) + '\n';
1411 lyxpreamble += from_utf8(features.getBabelOptions()) + '\n';
1415 int(count(lyxpreamble.begin(), lyxpreamble.end(), '\n'));
1416 for (int j = 0; j != nlines; ++j) {
1425 void BufferParams::useClassDefaults()
1427 DocumentClass const & tclass = documentClass();
1429 sides = tclass.sides();
1430 columns = tclass.columns();
1431 pagestyle = tclass.pagestyle();
1432 use_default_options = true;
1433 // Only if class has a ToC hierarchy
1434 if (tclass.hasTocLevels()) {
1435 secnumdepth = tclass.secnumdepth();
1436 tocdepth = tclass.tocdepth();
1441 bool BufferParams::hasClassDefaults() const
1443 DocumentClass const & tclass = documentClass();
1445 return sides == tclass.sides()
1446 && columns == tclass.columns()
1447 && pagestyle == tclass.pagestyle()
1448 && use_default_options
1449 && secnumdepth == tclass.secnumdepth()
1450 && tocdepth == tclass.tocdepth();
1454 DocumentClass const & BufferParams::documentClass() const
1460 DocumentClass const * BufferParams::documentClassPtr() const {
1465 void BufferParams::setDocumentClass(DocumentClass const * const tc) {
1466 // evil, but this function is evil
1467 doc_class_ = const_cast<DocumentClass *>(tc);
1471 void BufferParams::addDefaultModules()
1473 // add any default modules not already in use
1474 list<string> const & mods = baseClass()->defaultModules();
1475 list<string>::const_iterator mit = mods.begin();
1476 list<string>::const_iterator men = mods.end();
1478 // we want to add these to the front, but in the right order,
1479 // so we collect them here first.
1480 list<string> modulesToAdd;
1482 for (; mit != men; mit++) {
1483 string const & modName = *mit;
1484 // make sure the user hasn't removed it
1485 if (find(removedModules_.begin(), removedModules_.end(), modName) !=
1486 removedModules_.end()) {
1487 LYXERR(Debug::TCLASS, "Default module `" << modName <<
1488 "' not added because removed by user.");
1492 if (moduleCanBeAdded(modName)) {
1493 LYXERR(Debug::TCLASS, "Default module `" << modName << "' added.");
1494 modulesToAdd.push_back(modName);
1496 LYXERR(Debug::TCLASS,
1497 "Default module `" << modName << "' could not be added.");
1500 // OK, now we can add the default modules.
1501 layoutModules_.insert(
1502 layoutModules_.begin(), modulesToAdd.begin(), modulesToAdd.end());
1506 bool BufferParams::checkModuleConsistency() {
1507 bool consistent = true;
1508 // Perform a consistency check on the set of modules.
1509 // In particular, we need to check that modules provided by this class
1510 // do not conflict with modules chosen by the user.
1511 list<string> oldModules = getModules();
1512 clearLayoutModules();
1513 list<string>::const_iterator oit = oldModules.begin();
1514 list<string>::const_iterator oen = oldModules.end();
1515 list<string> const & provmods = baseClass()->providedModules();
1516 list<string> const & exclmods = baseClass()->excludedModules();
1517 for (; oit != oen; ++oit) {
1518 string const & modname = *oit;
1519 // skip modules that the class provides
1520 if (find(provmods.begin(), provmods.end(), modname) != provmods.end()) {
1522 LYXERR0("Module " << modname << " dropped because provided by document class.");
1525 // are we excluded by the document class?
1526 if (find(exclmods.begin(), exclmods.end(), modname) != exclmods.end()) {
1528 LYXERR0("Module " << modname << " dropped because excluded by document class.");
1532 // determine whether some provided module excludes us or we exclude it
1533 list<string>::const_iterator pit = provmods.begin();
1534 list<string>::const_iterator pen = provmods.end();
1535 bool excluded = false;
1536 for (; !excluded && pit != pen; ++pit) {
1537 if (!LyXModule::areCompatible(modname, *pit)) {
1539 LYXERR0("Module " << modname <<
1540 " dropped becuase it conflicts with provided module " << *pit);
1548 // Determine whether some prior module excludes us, or we exclude it
1549 list<string>::const_iterator lit = layoutModules_.begin();
1550 list<string>::const_iterator len = layoutModules_.end();
1551 for (; !excluded && lit != len; ++lit) {
1552 if (!LyXModule::areCompatible(modname, *lit)) {
1554 LYXERR0("Module " << modname <<
1555 " dropped because it is excluded by prior module " << *lit);
1563 // determine whether some provided module or some prior module
1564 // satisfies our requirements
1565 LyXModule const * const oldmod = moduleList[modname];
1567 LYXERR0("Default module " << modname <<
1568 " added although it is unavailable and can't check requirements.");
1572 vector<string> const & reqs = oldmod->getRequiredModules();
1573 if (!reqs.empty()) {
1574 // we now set excluded to true, meaning that we haven't
1575 // yet found a required module.
1577 vector<string>::const_iterator rit = reqs.begin();
1578 vector<string>::const_iterator ren = reqs.end();
1579 for (; rit != ren; ++rit) {
1580 string const reqmod = *rit;
1581 if (find(provmods.begin(), provmods.end(), reqmod) !=
1586 if (find(layoutModules_.begin(), layoutModules_.end(), reqmod) !=
1587 layoutModules_.end()) {
1595 LYXERR0("Module " << modname << " dropped because requirements not met.");
1597 LYXERR(Debug::TCLASS, "Module " << modname << " passed consistency check.");
1598 layoutModules_.push_back(modname);
1605 bool BufferParams::setBaseClass(string const & classname)
1607 LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
1608 LayoutFileList & bcl = LayoutFileList::get();
1609 if (!bcl.haveClass(classname)) {
1611 bformat(_("The document class %1$s could not be found. "
1612 "A default textclass with default layouts will be used. "
1613 "LyX might not be able to produce output unless a correct "
1614 "textclass is selected from the document settings dialog."),
1615 from_utf8(classname));
1616 frontend::Alert::error(_("Document class not found"), s);
1617 bcl.addEmptyClass(classname);
1620 bool const success = bcl[classname].load();
1623 bformat(_("The document class %1$s could not be loaded."),
1624 from_utf8(classname));
1625 frontend::Alert::error(_("Could not load class"), s);
1629 pimpl_->baseClass_ = classname;
1630 addDefaultModules();
1631 checkModuleConsistency();
1637 LayoutFile const * BufferParams::baseClass() const
1639 if (LayoutFileList::get().haveClass(pimpl_->baseClass_))
1640 return &(LayoutFileList::get()[pimpl_->baseClass_]);
1646 LayoutFileIndex const & BufferParams::baseClassID() const
1648 return pimpl_->baseClass_;
1652 void BufferParams::makeDocumentClass()
1657 doc_class_ = &(DocumentClassBundle::get().newClass(*baseClass()));
1659 // FIXME It might be worth loading the children's modules here,
1660 // just as we load their bibliographies and such, instead of just
1661 // doing a check in InsetInclude.
1662 LayoutModuleList::const_iterator it = layoutModules_.begin();
1663 for (; it != layoutModules_.end(); it++) {
1664 string const modName = *it;
1665 LyXModule * lm = moduleList[modName];
1667 docstring const msg =
1668 bformat(_("The module %1$s has been requested by\n"
1669 "this document but has not been found in the list of\n"
1670 "available modules. If you recently installed it, you\n"
1671 "probably need to reconfigure LyX.\n"), from_utf8(modName));
1672 frontend::Alert::warning(_("Module not available"),
1673 msg + _("Some layouts may not be available."));
1674 LYXERR0("BufferParams::makeDocumentClass(): Module " <<
1675 modName << " requested but not found in module list.");
1678 if (!lm->isAvailable()) {
1679 docstring const msg =
1680 bformat(_("The module %1$s requires a package that is\n"
1681 "not available in your LaTeX installation. LaTeX output\n"
1682 "may not be possible.\n"), from_utf8(modName));
1683 frontend::Alert::warning(_("Package not available"), msg);
1685 FileName layout_file = libFileSearch("layouts", lm->getFilename());
1686 if (!doc_class_->read(layout_file, TextClass::MODULE)) {
1687 docstring const msg =
1688 bformat(_("Error reading module %1$s\n"), from_utf8(modName));
1689 frontend::Alert::warning(_("Read Error"), msg);
1692 if (!local_layout.empty()) {
1693 if (!doc_class_->read(local_layout, TextClass::MODULE)) {
1694 docstring const msg = _("Error reading internal layout information");
1695 frontend::Alert::warning(_("Read Error"), msg);
1701 bool BufferParams::moduleCanBeAdded(string const & modName) const
1703 // Is the module already present?
1704 LayoutModuleList::const_iterator it = layoutModules_.begin();
1705 LayoutModuleList::const_iterator end = layoutModules_.end();
1706 for (; it != end; it++)
1710 LyXModule const * const lm = moduleList[modName];
1714 // Is this module explicitly excluded by the document class?
1715 list<string>::const_iterator const exclmodstart =
1716 baseClass()->excludedModules().begin();
1717 list<string>::const_iterator const exclmodend =
1718 baseClass()->excludedModules().end();
1719 if (find(exclmodstart, exclmodend, modName) != exclmodend)
1722 // Is this module already provided by the document class?
1723 list<string>::const_iterator const provmodstart =
1724 baseClass()->providedModules().begin();
1725 list<string>::const_iterator const provmodend =
1726 baseClass()->providedModules().end();
1727 if (find(provmodstart, provmodend, modName) != provmodend)
1730 // Check for conflicts with used modules
1731 // first the provided modules...
1732 list<string>::const_iterator provmodit = provmodstart;
1733 for (; provmodit != provmodend; ++provmodit) {
1734 if (!LyXModule::areCompatible(modName, *provmodit))
1737 // and then the selected modules
1738 LayoutModuleList::const_iterator mit = getModules().begin();
1739 LayoutModuleList::const_iterator const men = getModules().end();
1740 for (; mit != men; ++mit)
1741 if (!LyXModule::areCompatible(modName, *mit))
1744 // Check whether some required module is available
1745 vector<string> const reqs = lm->getRequiredModules();
1749 mit = getModules().begin(); // reset
1750 vector<string>::const_iterator rit = reqs.begin();
1751 vector<string>::const_iterator ren = reqs.end();
1752 bool foundone = false;
1753 for (; rit != ren; ++rit) {
1754 if (find(mit, men, *rit) != men ||
1755 find(provmodstart, provmodend, *rit) != provmodend) {
1765 bool BufferParams::addLayoutModule(string const & modName)
1767 LayoutModuleList::const_iterator it = layoutModules_.begin();
1768 LayoutModuleList::const_iterator end = layoutModules_.end();
1769 for (; it != end; it++)
1772 layoutModules_.push_back(modName);
1777 Font const BufferParams::getFont() const
1779 FontInfo f = documentClass().defaultfont();
1780 if (fontsDefaultFamily == "rmdefault")
1781 f.setFamily(ROMAN_FAMILY);
1782 else if (fontsDefaultFamily == "sfdefault")
1783 f.setFamily(SANS_FAMILY);
1784 else if (fontsDefaultFamily == "ttdefault")
1785 f.setFamily(TYPEWRITER_FAMILY);
1786 return Font(f, language);
1790 void BufferParams::readPreamble(Lexer & lex)
1792 if (lex.getString() != "\\begin_preamble")
1793 lyxerr << "Error (BufferParams::readPreamble):"
1794 "consistency check failed." << endl;
1796 preamble = lex.getLongString("\\end_preamble");
1800 void BufferParams::readLocalLayout(Lexer & lex)
1802 if (lex.getString() != "\\begin_local_layout")
1803 lyxerr << "Error (BufferParams::readLocalLayout):"
1804 "consistency check failed." << endl;
1806 local_layout = lex.getLongString("\\end_local_layout");
1810 void BufferParams::readLanguage(Lexer & lex)
1812 if (!lex.next()) return;
1814 string const tmptok = lex.getString();
1816 // check if tmptok is part of tex_babel in tex-defs.h
1817 language = languages.getLanguage(tmptok);
1819 // Language tmptok was not found
1820 language = default_language;
1821 lyxerr << "Warning: Setting language `"
1822 << tmptok << "' to `" << language->lang()
1828 void BufferParams::readGraphicsDriver(Lexer & lex)
1833 string const tmptok = lex.getString();
1834 // check if tmptok is part of tex_graphics in tex_defs.h
1837 string const test = tex_graphics[n++];
1839 if (test == tmptok) {
1840 graphicsDriver = tmptok;
1845 "Warning: graphics driver `$$Token' not recognized!\n"
1846 " Setting graphics driver to `default'.\n");
1847 graphicsDriver = "default";
1854 void BufferParams::readBullets(Lexer & lex)
1859 int const index = lex.getInteger();
1861 int temp_int = lex.getInteger();
1862 user_defined_bullet(index).setFont(temp_int);
1863 temp_bullet(index).setFont(temp_int);
1865 user_defined_bullet(index).setCharacter(temp_int);
1866 temp_bullet(index).setCharacter(temp_int);
1868 user_defined_bullet(index).setSize(temp_int);
1869 temp_bullet(index).setSize(temp_int);
1873 void BufferParams::readBulletsLaTeX(Lexer & lex)
1875 // The bullet class should be able to read this.
1878 int const index = lex.getInteger();
1880 docstring const temp_str = lex.getDocString();
1882 user_defined_bullet(index).setText(temp_str);
1883 temp_bullet(index).setText(temp_str);
1887 void BufferParams::readModules(Lexer & lex)
1889 if (!lex.eatLine()) {
1890 lyxerr << "Error (BufferParams::readModules):"
1891 "Unexpected end of input." << endl;
1895 string mod = lex.getString();
1896 if (mod == "\\end_modules")
1898 addLayoutModule(mod);
1904 void BufferParams::readRemovedModules(Lexer & lex)
1906 if (!lex.eatLine()) {
1907 lyxerr << "Error (BufferParams::readRemovedModules):"
1908 "Unexpected end of input." << endl;
1912 string mod = lex.getString();
1913 if (mod == "\\end_removed_modules")
1915 removedModules_.insert(mod);
1918 // now we want to remove any removed modules that were previously
1919 // added. normally, that will be because default modules were added in
1920 // setBaseClass(), which gets called when \textclass is read at the
1921 // start of the read.
1922 set<string>::const_iterator rit = removedModules_.begin();
1923 set<string>::const_iterator const ren = removedModules_.end();
1924 for (; rit != ren; rit++) {
1925 LayoutModuleList::iterator const mit = layoutModules_.begin();
1926 LayoutModuleList::iterator const men = layoutModules_.end();
1927 LayoutModuleList::iterator found = find(mit, men, *rit);
1930 layoutModules_.erase(found);
1935 string BufferParams::paperSizeName(PapersizePurpose purpose) const
1937 char real_papersize = papersize;
1938 if (real_papersize == PAPER_DEFAULT)
1939 real_papersize = lyxrc.default_papersize;
1941 switch (real_papersize) {
1943 // could be anything, so don't guess
1945 case PAPER_CUSTOM: {
1946 if (purpose == XDVI && !paperwidth.empty() &&
1947 !paperheight.empty()) {
1948 // heightxwidth<unit>
1949 string first = paperwidth;
1950 string second = paperheight;
1951 if (orientation == ORIENTATION_LANDSCAPE)
1954 return first.erase(first.length() - 2)
1966 // dvips and dvipdfm do not know this
1967 if (purpose == DVIPS || purpose == DVIPDFM)
1971 // dvipdfm does not know this
1972 if (purpose == DVIPDFM)
1976 // dvipdfm does not know this
1977 if (purpose == DVIPDFM)
1980 case PAPER_USEXECUTIVE:
1981 // dvipdfm does not know this
1982 if (purpose == DVIPDFM)
1987 case PAPER_USLETTER:
1989 if (purpose == XDVI)
1996 string const BufferParams::dvips_options() const
2001 && papersize == PAPER_CUSTOM
2002 && !lyxrc.print_paper_dimension_flag.empty()
2003 && !paperwidth.empty()
2004 && !paperheight.empty()) {
2005 // using a custom papersize
2006 result = lyxrc.print_paper_dimension_flag;
2007 result += ' ' + paperwidth;
2008 result += ',' + paperheight;
2010 string const paper_option = paperSizeName(DVIPS);
2011 if (!paper_option.empty() && (paper_option != "letter" ||
2012 orientation != ORIENTATION_LANDSCAPE)) {
2013 // dvips won't accept -t letter -t landscape.
2014 // In all other cases, include the paper size
2016 result = lyxrc.print_paper_flag;
2017 result += ' ' + paper_option;
2020 if (orientation == ORIENTATION_LANDSCAPE &&
2021 papersize != PAPER_CUSTOM)
2022 result += ' ' + lyxrc.print_landscape_flag;
2027 string BufferParams::babelCall(string const & lang_opts) const
2029 string lang_pack = lyxrc.language_package;
2030 if (lang_pack != "\\usepackage{babel}")
2032 // suppress the babel call when there is no babel language defined
2033 // for the document language in the lib/languages file and if no
2034 // other languages are used (lang_opts is then empty)
2035 if (lang_opts.empty())
2037 // If Vietnamese is used, babel must directly be loaded with the
2038 // language options, see
2039 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129417.html
2040 size_t viet = lang_opts.find("vietnam");
2041 // viet = string::npos when not found
2042 // the same is for all other languages that are not directly supported by
2043 // babel, but where LaTeX-packages add babel support.
2044 // this is currently the case for Latvian, Lithuanian, and Mongolian
2045 size_t latvian = lang_opts.find("latvian");
2046 size_t lithu = lang_opts.find("lithuanian");
2047 size_t mongo = lang_opts.find("mongolian");
2048 // If Japanese is used, babel must directly be loaded with the
2049 // language options, see
2050 // http://bugzilla.lyx.org/show_bug.cgi?id=4597#c4
2051 size_t japan = lang_opts.find("japanese");
2052 if (!lyxrc.language_global_options || viet != string::npos
2053 || japan != string::npos || latvian != string::npos
2054 || lithu != string::npos || mongo != string::npos)
2055 return "\\usepackage[" + lang_opts + "]{babel}";
2060 void BufferParams::writeEncodingPreamble(odocstream & os,
2061 LaTeXFeatures & features, TexRow & texrow) const
2063 if (inputenc == "auto") {
2064 string const doc_encoding =
2065 language->encoding()->latexName();
2066 Encoding::Package const package =
2067 language->encoding()->package();
2069 // Create a list with all the input encodings used
2071 set<string> encodings =
2072 features.getEncodingSet(doc_encoding);
2074 // If the "japanese" package (i.e. pLaTeX) is used,
2075 // inputenc must be omitted.
2076 // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
2077 if (package == Encoding::japanese)
2078 features.require("japanese");
2080 if ((!encodings.empty() || package == Encoding::inputenc)
2081 && !features.isRequired("japanese")) {
2082 os << "\\usepackage[";
2083 set<string>::const_iterator it = encodings.begin();
2084 set<string>::const_iterator const end = encodings.end();
2086 os << from_ascii(*it);
2089 for (; it != end; ++it)
2090 os << ',' << from_ascii(*it);
2091 if (package == Encoding::inputenc) {
2092 if (!encodings.empty())
2094 os << from_ascii(doc_encoding);
2096 os << "]{inputenc}\n";
2099 if (package == Encoding::CJK || features.mustProvide("CJK")) {
2100 os << "\\usepackage{CJK}\n";
2103 } else if (inputenc != "default") {
2104 switch (encoding().package()) {
2105 case Encoding::none:
2106 case Encoding::japanese:
2108 case Encoding::inputenc:
2109 // do not load inputenc if japanese is used
2110 if (features.isRequired("japanese"))
2112 os << "\\usepackage[" << from_ascii(inputenc)
2117 os << "\\usepackage{CJK}\n";
2123 // The encoding "armscii8" (for Armenian) is only available when
2124 // the package "armtex" is loaded.
2125 if (language->encoding()->latexName() == "armscii8"
2126 || inputenc == "armscii8") {
2127 os << "\\usepackage{armtex}\n";
2133 string const BufferParams::loadFonts(string const & rm,
2134 string const & sf, string const & tt,
2135 bool const & sc, bool const & osf,
2136 int const & sfscale, int const & ttscale) const
2138 /* The LaTeX font world is in a flux. In the PSNFSS font interface,
2139 several packages have been replaced by others, that might not
2140 be installed on every system. We have to take care for that
2141 (see psnfss.pdf). We try to support all psnfss fonts as well
2142 as the fonts that have become de facto standard in the LaTeX
2143 world (e.g. Latin Modern). We do not support obsolete fonts
2144 (like PSLatex). In general, it should be possible to mix any
2145 rm font with any sf or tt font, respectively. (JSpitzm)
2147 -- separate math fonts.
2150 if (rm == "default" && sf == "default" && tt == "default")
2157 // Computer Modern (must be explicitely selectable -- there might be classes
2158 // that define a different default font!
2160 os << "\\renewcommand{\\rmdefault}{cmr}\n";
2161 // osf for Computer Modern needs eco.sty
2163 os << "\\usepackage{eco}\n";
2165 // Latin Modern Roman
2166 else if (rm == "lmodern")
2167 os << "\\usepackage{lmodern}\n";
2169 else if (rm == "ae") {
2170 // not needed when using OT1 font encoding.
2171 if (lyxrc.fontenc != "default")
2172 os << "\\usepackage{ae,aecompl}\n";
2175 else if (rm == "times") {
2176 // try to load the best available package
2177 if (LaTeXFeatures::isAvailable("mathptmx"))
2178 os << "\\usepackage{mathptmx}\n";
2179 else if (LaTeXFeatures::isAvailable("mathptm"))
2180 os << "\\usepackage{mathptm}\n";
2182 os << "\\usepackage{times}\n";
2185 else if (rm == "palatino") {
2186 // try to load the best available package
2187 if (LaTeXFeatures::isAvailable("mathpazo")) {
2188 os << "\\usepackage";
2194 // "osf" includes "sc"!
2198 os << "{mathpazo}\n";
2200 else if (LaTeXFeatures::isAvailable("mathpple"))
2201 os << "\\usepackage{mathpple}\n";
2203 os << "\\usepackage{palatino}\n";
2206 else if (rm == "utopia") {
2207 // fourier supersedes utopia.sty, but does
2208 // not work with OT1 encoding.
2209 if (LaTeXFeatures::isAvailable("fourier")
2210 && lyxrc.fontenc != "default") {
2211 os << "\\usepackage";
2222 os << "{fourier}\n";
2225 os << "\\usepackage{utopia}\n";
2227 // Bera (complete fontset)
2228 else if (rm == "bera" && sf == "default" && tt == "default")
2229 os << "\\usepackage{bera}\n";
2231 else if (rm != "default")
2232 os << "\\usepackage" << "{" << rm << "}\n";
2235 // Helvetica, Bera Sans
2236 if (sf == "helvet" || sf == "berasans") {
2238 os << "\\usepackage[scaled=" << float(sfscale) / 100
2239 << "]{" << sf << "}\n";
2241 os << "\\usepackage{" << sf << "}\n";
2244 else if (sf == "avant")
2245 os << "\\usepackage{" << sf << "}\n";
2246 // Computer Modern, Latin Modern, CM Bright
2247 else if (sf != "default")
2248 os << "\\renewcommand{\\sfdefault}{" << sf << "}\n";
2250 // monospaced/typewriter
2251 // Courier, LuxiMono
2252 if (tt == "luximono" || tt == "beramono") {
2254 os << "\\usepackage[scaled=" << float(ttscale) / 100
2255 << "]{" << tt << "}\n";
2257 os << "\\usepackage{" << tt << "}\n";
2260 else if (tt == "courier" )
2261 os << "\\usepackage{" << tt << "}\n";
2262 // Computer Modern, Latin Modern, CM Bright
2263 else if (tt != "default")
2264 os << "\\renewcommand{\\ttdefault}{" << tt << "}\n";
2270 Encoding const & BufferParams::encoding() const
2272 if (inputenc == "auto" || inputenc == "default")
2273 return *language->encoding();
2274 Encoding const * const enc = encodings.fromLaTeXName(inputenc);
2277 LYXERR0("Unknown inputenc value `" << inputenc
2278 << "'. Using `auto' instead.");
2279 return *language->encoding();
2283 CiteEngine BufferParams::citeEngine() const
2285 // FIXME the class should provide the numerical/
2286 // authoryear choice
2287 if (documentClass().provides("natbib")
2288 && cite_engine_ != ENGINE_NATBIB_NUMERICAL)
2289 return ENGINE_NATBIB_AUTHORYEAR;
2290 return cite_engine_;
2294 void BufferParams::setCiteEngine(CiteEngine cite_engine)
2296 cite_engine_ = cite_engine;