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 "BranchList.h"
22 #include "buffer_funcs.h"
28 #include "LaTeXFeatures.h"
30 #include "ModuleList.h"
35 #include "TextClassList.h"
36 #include "OutputParams.h"
40 #include "PDFOptions.h"
42 #include "frontends/alert.h"
43 #include "insets/InsetListingsParams.h"
45 #include "support/convert.h"
46 #include "support/filetools.h"
47 #include "support/Translator.h"
48 #include "support/lstrings.h"
50 #include <boost/array.hpp>
59 using std::istringstream;
61 using std::ostringstream;
64 using lyx::support::FileName;
65 using lyx::support::libFileSearch;
66 using lyx::support::bformat;
67 using lyx::support::rtrim;
68 using lyx::support::tokenPos;
69 using lyx::support::prefixIs;
72 static char const * const string_paragraph_separation[] = {
77 static char const * const string_quotes_language[] = {
78 "english", "swedish", "german", "polish", "french", "danish", ""
82 static char const * const string_papersize[] = {
83 "default", "custom", "letterpaper", "executivepaper", "legalpaper",
84 "a3paper", "a4paper", "a5paper", "b3paper", "b4paper", "b5paper", ""
88 static char const * const string_orientation[] = {
89 "portrait", "landscape", ""
93 static char const * const string_footnotekinds[] = {
94 "footnote", "margin", "fig", "tab", "alg", "wide-fig", "wide-tab", ""
98 static char const * const tex_graphics[] = {
99 "default", "dvips", "dvitops", "emtex",
100 "ln", "oztex", "textures", "none", ""
109 // Paragraph separation
110 typedef Translator<string, BufferParams::PARSEP> ParSepTranslator;
113 ParSepTranslator const init_parseptranslator()
115 ParSepTranslator translator(string_paragraph_separation[0], BufferParams::PARSEP_INDENT);
116 translator.addPair(string_paragraph_separation[1], BufferParams::PARSEP_SKIP);
121 ParSepTranslator const & parseptranslator()
123 static ParSepTranslator translator = init_parseptranslator();
129 typedef Translator<string, InsetQuotes::quote_language> QuotesLangTranslator;
132 QuotesLangTranslator const init_quoteslangtranslator()
134 QuotesLangTranslator translator(string_quotes_language[0], InsetQuotes::EnglishQ);
135 translator.addPair(string_quotes_language[1], InsetQuotes::SwedishQ);
136 translator.addPair(string_quotes_language[2], InsetQuotes::GermanQ);
137 translator.addPair(string_quotes_language[3], InsetQuotes::PolishQ);
138 translator.addPair(string_quotes_language[4], InsetQuotes::FrenchQ);
139 translator.addPair(string_quotes_language[5], InsetQuotes::DanishQ);
144 QuotesLangTranslator const & quoteslangtranslator()
146 static QuotesLangTranslator translator = init_quoteslangtranslator();
152 typedef Translator<std::string, PAPER_SIZE> PaperSizeTranslator;
155 PaperSizeTranslator const init_papersizetranslator()
157 PaperSizeTranslator translator(string_papersize[0], PAPER_DEFAULT);
158 translator.addPair(string_papersize[1], PAPER_CUSTOM);
159 translator.addPair(string_papersize[2], PAPER_USLETTER);
160 translator.addPair(string_papersize[3], PAPER_USLEGAL);
161 translator.addPair(string_papersize[4], PAPER_USEXECUTIVE);
162 translator.addPair(string_papersize[5], PAPER_A3);
163 translator.addPair(string_papersize[6], PAPER_A4);
164 translator.addPair(string_papersize[7], PAPER_A5);
165 translator.addPair(string_papersize[8], PAPER_B3);
166 translator.addPair(string_papersize[9], PAPER_B4);
167 translator.addPair(string_papersize[10], PAPER_B5);
172 PaperSizeTranslator const & papersizetranslator()
174 static PaperSizeTranslator translator = init_papersizetranslator();
180 typedef Translator<string, PAPER_ORIENTATION> PaperOrientationTranslator;
183 PaperOrientationTranslator const init_paperorientationtranslator()
185 PaperOrientationTranslator translator(string_orientation[0], ORIENTATION_PORTRAIT);
186 translator.addPair(string_orientation[1], ORIENTATION_LANDSCAPE);
191 PaperOrientationTranslator const & paperorientationtranslator()
193 static PaperOrientationTranslator translator = init_paperorientationtranslator();
199 typedef Translator<int, TextClass::PageSides> SidesTranslator;
202 SidesTranslator const init_sidestranslator()
204 SidesTranslator translator(1, TextClass::OneSide);
205 translator.addPair(2, TextClass::TwoSides);
210 SidesTranslator const & sidestranslator()
212 static SidesTranslator translator = init_sidestranslator();
218 typedef Translator<int, BufferParams::Package> PackageTranslator;
221 PackageTranslator const init_packagetranslator()
223 PackageTranslator translator(0, BufferParams::package_off);
224 translator.addPair(1, BufferParams::package_auto);
225 translator.addPair(2, BufferParams::package_on);
230 PackageTranslator const & packagetranslator()
232 static PackageTranslator translator = init_packagetranslator();
238 typedef Translator<string, biblio::CiteEngine> CiteEngineTranslator;
241 CiteEngineTranslator const init_citeenginetranslator()
243 CiteEngineTranslator translator("basic", biblio::ENGINE_BASIC);
244 translator.addPair("natbib_numerical", biblio::ENGINE_NATBIB_NUMERICAL);
245 translator.addPair("natbib_authoryear", biblio::ENGINE_NATBIB_AUTHORYEAR);
246 translator.addPair("jurabib", biblio::ENGINE_JURABIB);
251 CiteEngineTranslator const & citeenginetranslator()
253 static CiteEngineTranslator translator = init_citeenginetranslator();
259 typedef Translator<string, Spacing::Space> SpaceTranslator;
262 SpaceTranslator const init_spacetranslator()
264 SpaceTranslator translator("default", Spacing::Default);
265 translator.addPair("single", Spacing::Single);
266 translator.addPair("onehalf", Spacing::Onehalf);
267 translator.addPair("double", Spacing::Double);
268 translator.addPair("other", Spacing::Other);
273 SpaceTranslator const & spacetranslator()
275 static SpaceTranslator translator = init_spacetranslator();
283 class BufferParams::Impl
288 AuthorList authorlist;
289 BranchList branchlist;
290 boost::array<Bullet, 4> temp_bullets;
291 boost::array<Bullet, 4> user_defined_bullets;
293 /** This is the amount of space used for paragraph_separation "skip",
294 * and for detached paragraphs in "indented" documents.
297 PDFOptions pdfoptions;
301 BufferParams::Impl::Impl()
302 : defskip(VSpace::MEDSKIP)
304 // set initial author
306 authorlist.record(Author(from_utf8(lyxrc.user_name), from_utf8(lyxrc.user_email)));
311 BufferParams::MemoryTraits::clone(BufferParams::Impl const * ptr)
315 return new BufferParams::Impl(*ptr);
319 void BufferParams::MemoryTraits::destroy(BufferParams::Impl * ptr)
325 BufferParams::BufferParams()
328 setBaseClass(defaultTextclass());
329 paragraph_separation = PARSEP_INDENT;
330 quotes_language = InsetQuotes::EnglishQ;
331 fontsize = "default";
334 papersize = PAPER_DEFAULT;
335 orientation = ORIENTATION_PORTRAIT;
336 use_geometry = false;
337 use_amsmath = package_auto;
338 use_esint = package_auto;
339 cite_engine_ = biblio::ENGINE_BASIC;
340 use_bibtopic = false;
341 trackChanges = false;
342 outputChanges = false;
345 language = default_language;
346 fontsRoman = "default";
347 fontsSans = "default";
348 fontsTypewriter = "default";
349 fontsDefaultFamily = "default";
352 fontsSansScale = 100;
353 fontsTypewriterScale = 100;
355 graphicsDriver = "default";
356 sides = TextClass::OneSide;
358 listings_params = string();
359 pagestyle = "default";
362 for (int iter = 0; iter < 4; ++iter) {
363 user_defined_bullet(iter) = ITEMIZE_DEFAULTS[iter];
364 temp_bullet(iter) = ITEMIZE_DEFAULTS[iter];
369 BufferParams::~BufferParams()
373 docstring const BufferParams::B_(string const & l10n) const
375 BOOST_ASSERT(language);
376 return getMessages(language->code()).get(l10n);
380 AuthorList & BufferParams::authors()
382 return pimpl_->authorlist;
386 AuthorList const & BufferParams::authors() const
388 return pimpl_->authorlist;
392 BranchList & BufferParams::branchlist()
394 return pimpl_->branchlist;
398 BranchList const & BufferParams::branchlist() const
400 return pimpl_->branchlist;
404 Bullet & BufferParams::temp_bullet(lyx::size_type const index)
406 BOOST_ASSERT(index < 4);
407 return pimpl_->temp_bullets[index];
411 Bullet const & BufferParams::temp_bullet(lyx::size_type const index) const
413 BOOST_ASSERT(index < 4);
414 return pimpl_->temp_bullets[index];
418 Bullet & BufferParams::user_defined_bullet(lyx::size_type const index)
420 BOOST_ASSERT(index < 4);
421 return pimpl_->user_defined_bullets[index];
425 Bullet const & BufferParams::user_defined_bullet(lyx::size_type const index) const
427 BOOST_ASSERT(index < 4);
428 return pimpl_->user_defined_bullets[index];
432 Spacing & BufferParams::spacing()
434 return pimpl_->spacing;
438 Spacing const & BufferParams::spacing() const
440 return pimpl_->spacing;
444 PDFOptions & BufferParams::pdfoptions()
446 return pimpl_->pdfoptions;
450 PDFOptions const & BufferParams::pdfoptions() const
452 return pimpl_->pdfoptions;
456 VSpace const & BufferParams::getDefSkip() const
458 return pimpl_->defskip;
462 void BufferParams::setDefSkip(VSpace const & vs)
464 pimpl_->defskip = vs;
468 string const BufferParams::readToken(Lexer & lex, string const & token)
470 if (token == "\\textclass") {
472 string const classname = lex.getString();
473 pair<bool, lyx::textclass_type> pp =
474 textclasslist.numberOfClass(classname);
476 setBaseClass(pp.second);
478 // if text class does not exist, try to load it from filepath
479 pp = textclasslist.addTextClass(classname, filepath);
481 setBaseClass(pp.second);
483 setBaseClass(defaultTextclass());
487 if (!getTextClass().isTeXClassAvailable()) {
488 docstring const msg =
489 bformat(_("The layout file requested by this document,\n"
491 "is not usable. This is probably because a LaTeX\n"
492 "class or style file required by it is not\n"
493 "available. See the Customization documentation\n"
494 "for more information.\n"), from_utf8(classname));
495 frontend::Alert::warning(_("Document class not available"),
496 msg + _("LyX will not be able to produce output."));
499 } else if (token == "\\begin_preamble") {
501 } else if (token == "\\begin_modules") {
504 } else if (token == "\\options") {
506 options = lex.getString();
507 } else if (token == "\\language") {
509 } else if (token == "\\inputencoding") {
511 } else if (token == "\\graphics") {
512 readGraphicsDriver(lex);
513 } else if (token == "\\font_roman") {
515 } else if (token == "\\font_sans") {
517 } else if (token == "\\font_typewriter") {
518 lex >> fontsTypewriter;
519 } else if (token == "\\font_default_family") {
520 lex >> fontsDefaultFamily;
521 } else if (token == "\\font_sc") {
523 } else if (token == "\\font_osf") {
525 } else if (token == "\\font_sf_scale") {
526 lex >> fontsSansScale;
527 } else if (token == "\\font_tt_scale") {
528 lex >> fontsTypewriterScale;
529 } else if (token == "\\paragraph_separation") {
532 paragraph_separation = parseptranslator().find(parsep);
533 } else if (token == "\\defskip") {
535 pimpl_->defskip = VSpace(lex.getString());
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 == "\\paperfontsize") {
623 } else if (token == "\\papercolumns") {
625 } else if (token == "\\listings_params") {
628 listings_params = InsetListingsParams(par).params();
629 } else if (token == "\\papersides") {
632 sides = sidestranslator().find(psides);
633 } else if (token == "\\paperpagestyle") {
635 } else if (token == "\\bullet") {
637 } else if (token == "\\bulletLaTeX") {
638 readBulletsLaTeX(lex);
639 } else if (token == "\\secnumdepth") {
641 } else if (token == "\\tocdepth") {
643 } else if (token == "\\spacing") {
647 if (nspacing == "other") {
650 spacing().set(spacetranslator().find(nspacing), tmp_val);
651 } else if (token == "\\float_placement") {
652 lex >> float_placement;
654 } else if (prefixIs(token, "\\pdf_") || token == "\\use_hyperref") {
655 string toktmp = pdfoptions().readToken(lex, token);
656 if (!toktmp.empty()) {
657 lyxerr << "PDFOptions::readToken(): Unknown token: " <<
662 lyxerr << "BufferParams::readToken(): Unknown token: " <<
671 void BufferParams::writeFile(ostream & os) const
673 // The top of the file is written by the buffer.
674 // Prints out the buffer info into the .lyx file given by file
677 os << "\\textclass " << textclasslist[baseClass_].name() << '\n';
680 if (!preamble.empty()) {
681 // remove '\n' from the end of preamble
682 string const tmppreamble = rtrim(preamble, "\n");
683 os << "\\begin_preamble\n"
685 << "\n\\end_preamble\n";
689 if (!options.empty()) {
690 os << "\\options " << options << '\n';
694 if (!layoutModules_.empty()) {
695 os << "\\begin_modules" << '\n';
696 LayoutModuleList::const_iterator it = layoutModules_.begin();
697 for (; it != layoutModules_.end(); it++)
699 os << "\\end_modules" << '\n';
702 // then the text parameters
703 if (language != ignore_language)
704 os << "\\language " << language->lang() << '\n';
705 os << "\\inputencoding " << inputenc
706 << "\n\\font_roman " << fontsRoman
707 << "\n\\font_sans " << fontsSans
708 << "\n\\font_typewriter " << fontsTypewriter
709 << "\n\\font_default_family " << fontsDefaultFamily
710 << "\n\\font_sc " << convert<string>(fontsSC)
711 << "\n\\font_osf " << convert<string>(fontsOSF)
712 << "\n\\font_sf_scale " << fontsSansScale
713 << "\n\\font_tt_scale " << fontsTypewriterScale
714 << "\n\\graphics " << graphicsDriver << '\n';
716 if (!float_placement.empty()) {
717 os << "\\float_placement " << float_placement << '\n';
719 os << "\\paperfontsize " << fontsize << '\n';
721 spacing().writeFile(os);
722 pdfoptions().writeFile(os);
724 os << "\\papersize " << string_papersize[papersize]
725 << "\n\\use_geometry " << convert<string>(use_geometry)
726 << "\n\\use_amsmath " << use_amsmath
727 << "\n\\use_esint " << use_esint
728 << "\n\\cite_engine " << citeenginetranslator().find(cite_engine_)
729 << "\n\\use_bibtopic " << convert<string>(use_bibtopic)
730 << "\n\\paperorientation " << string_orientation[orientation]
733 BranchList::const_iterator it = branchlist().begin();
734 BranchList::const_iterator end = branchlist().end();
735 for (; it != end; ++it) {
736 os << "\\branch " << to_utf8(it->getBranch())
737 << "\n\\selected " << it->getSelected()
738 << "\n\\color " << lyx::X11hexname(it->getColor())
743 if (!paperwidth.empty())
744 os << "\\paperwidth "
745 << VSpace(paperwidth).asLyXCommand() << '\n';
746 if (!paperheight.empty())
747 os << "\\paperheight "
748 << VSpace(paperheight).asLyXCommand() << '\n';
749 if (!leftmargin.empty())
750 os << "\\leftmargin "
751 << VSpace(leftmargin).asLyXCommand() << '\n';
752 if (!topmargin.empty())
754 << VSpace(topmargin).asLyXCommand() << '\n';
755 if (!rightmargin.empty())
756 os << "\\rightmargin "
757 << VSpace(rightmargin).asLyXCommand() << '\n';
758 if (!bottommargin.empty())
759 os << "\\bottommargin "
760 << VSpace(bottommargin).asLyXCommand() << '\n';
761 if (!headheight.empty())
762 os << "\\headheight "
763 << VSpace(headheight).asLyXCommand() << '\n';
764 if (!headsep.empty())
766 << VSpace(headsep).asLyXCommand() << '\n';
767 if (!footskip.empty())
769 << VSpace(footskip).asLyXCommand() << '\n';
770 os << "\\secnumdepth " << secnumdepth
771 << "\n\\tocdepth " << tocdepth
772 << "\n\\paragraph_separation "
773 << string_paragraph_separation[paragraph_separation]
774 << "\n\\defskip " << getDefSkip().asLyXCommand()
775 << "\n\\quotes_language "
776 << string_quotes_language[quotes_language]
777 << "\n\\papercolumns " << columns
778 << "\n\\papersides " << sides
779 << "\n\\paperpagestyle " << pagestyle << '\n';
780 if (!listings_params.empty())
781 os << "\\listings_params \"" <<
782 InsetListingsParams(listings_params).encodedString() << "\"\n";
783 for (int i = 0; i < 4; ++i) {
784 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
785 if (user_defined_bullet(i).getFont() != -1) {
786 os << "\\bullet " << i << " "
787 << user_defined_bullet(i).getFont() << " "
788 << user_defined_bullet(i).getCharacter() << " "
789 << user_defined_bullet(i).getSize() << "\n";
793 os << "\\bulletLaTeX " << i << " \""
794 << lyx::to_ascii(user_defined_bullet(i).getText())
800 os << "\\tracking_changes " << convert<string>(trackChanges) << "\n";
801 os << "\\output_changes " << convert<string>(outputChanges) << "\n";
803 AuthorList::Authors::const_iterator a_it = pimpl_->authorlist.begin();
804 AuthorList::Authors::const_iterator a_end = pimpl_->authorlist.end();
805 for (; a_it != a_end; ++a_it) {
806 if (a_it->second.used())
807 os << "\\author " << a_it->second << "\n";
809 os << "\\author " << Author() << "\n";
814 bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
815 TexRow & texrow) const
817 os << "\\documentclass";
819 TextClass const & tclass = getTextClass();
821 ostringstream clsoptions; // the document class options.
823 if (tokenPos(tclass.opt_fontsize(),
824 '|', fontsize) >= 0) {
825 // only write if existing in list (and not default)
826 clsoptions << fontsize << "pt,";
829 // custom, A3, B3 and B4 paper sizes need geometry
830 bool nonstandard_papersize = papersize == PAPER_B3
831 || papersize == PAPER_B4
832 || papersize == PAPER_A3
833 || papersize == PAPER_CUSTOM;
838 clsoptions << "a4paper,";
841 clsoptions << "letterpaper,";
844 clsoptions << "a5paper,";
847 clsoptions << "b5paper,";
849 case PAPER_USEXECUTIVE:
850 clsoptions << "executivepaper,";
853 clsoptions << "legalpaper,";
865 if (sides != tclass.sides()) {
867 case TextClass::OneSide:
868 clsoptions << "oneside,";
870 case TextClass::TwoSides:
871 clsoptions << "twoside,";
877 if (columns != tclass.columns()) {
879 clsoptions << "twocolumn,";
881 clsoptions << "onecolumn,";
885 && orientation == ORIENTATION_LANDSCAPE)
886 clsoptions << "landscape,";
888 // language should be a parameter to \documentclass
889 if (language->babel() == "hebrew"
890 && default_language->babel() != "hebrew")
891 // This seems necessary
892 features.useLanguage(default_language);
894 ostringstream language_options;
895 bool const use_babel = features.useBabel();
897 language_options << features.getLanguages();
898 if (!language->babel().empty()) {
899 if (!language_options.str().empty())
900 language_options << ',';
901 language_options << language->babel();
903 // when Vietnamese is used, babel must directly be loaded with the
904 // language options, not in the class options, see
905 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129417.html
906 int viet = language_options.str().find("vietnam");
907 // viet = string::npos when not found
908 if (lyxrc.language_global_options && !language_options.str().empty()
909 && viet == string::npos)
910 clsoptions << language_options.str() << ',';
913 // the user-defined options
914 if (!options.empty()) {
915 clsoptions << options << ',';
918 string strOptions(clsoptions.str());
919 if (!strOptions.empty()) {
920 strOptions = rtrim(strOptions, ",");
922 os << '[' << from_utf8(strOptions) << ']';
925 os << '{' << from_ascii(tclass.latexname()) << "}\n";
927 // end of \documentclass defs
929 // font selection must be done before loading fontenc.sty
931 loadFonts(fontsRoman, fontsSans,
932 fontsTypewriter, fontsSC, fontsOSF,
933 fontsSansScale, fontsTypewriterScale);
934 if (!fonts.empty()) {
935 os << from_ascii(fonts);
938 if (fontsDefaultFamily != "default")
939 os << "\\renewcommand{\\familydefault}{\\"
940 << from_ascii(fontsDefaultFamily) << "}\n";
943 // this one is not per buffer
944 // for arabic_arabi and farsi we also need to load the LAE and LFE encoding
945 if (lyxrc.fontenc != "default") {
946 if (language->lang() == "arabic_arabi" || language->lang() == "farsi") {
947 os << "\\usepackage[" << from_ascii(lyxrc.fontenc)
948 << ",LFE,LAE]{fontenc}\n";
951 os << "\\usepackage[" << from_ascii(lyxrc.fontenc)
957 // handle inputenc etc.
958 writeEncodingPreamble(os, features, texrow);
960 if (!listings_params.empty()) {
961 os << "\\usepackage{listings}\n";
964 // do not test validity because listings_params is supposed to be valid
965 string par = InsetListingsParams(listings_params).separatedParams(true);
966 os << from_ascii(par);
967 // count the number of newlines
968 for (size_t i = 0; i < par.size(); ++i)
974 if (use_geometry || nonstandard_papersize) {
975 os << "\\usepackage{geometry}\n";
977 os << "\\geometry{verbose";
978 if (orientation == ORIENTATION_LANDSCAPE)
982 if (!paperwidth.empty())
984 << from_ascii(paperwidth);
985 if (!paperheight.empty())
986 os << ",paperheight="
987 << from_ascii(paperheight);
990 os << ",letterpaper";
995 case PAPER_USEXECUTIVE:
996 os << ",executivepaper";
1017 // default papersize ie PAPER_DEFAULT
1018 switch (lyxrc.default_papersize) {
1019 case PAPER_DEFAULT: // keep compiler happy
1020 case PAPER_USLETTER:
1021 os << ",letterpaper";
1024 os << ",legalpaper";
1026 case PAPER_USEXECUTIVE:
1027 os << ",executivepaper";
1047 if (!topmargin.empty())
1048 os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1049 if (!bottommargin.empty())
1050 os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1051 if (!leftmargin.empty())
1052 os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1053 if (!rightmargin.empty())
1054 os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1055 if (!headheight.empty())
1056 os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1057 if (!headsep.empty())
1058 os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1059 if (!footskip.empty())
1060 os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1065 if (tokenPos(tclass.opt_pagestyle(),
1066 '|', pagestyle) >= 0) {
1067 if (pagestyle == "fancy") {
1068 os << "\\usepackage{fancyhdr}\n";
1071 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1075 // Only if class has a ToC hierarchy
1076 if (tclass.hasTocLevels()) {
1077 if (secnumdepth != tclass.secnumdepth()) {
1078 os << "\\setcounter{secnumdepth}{"
1083 if (tocdepth != tclass.tocdepth()) {
1084 os << "\\setcounter{tocdepth}{"
1091 if (paragraph_separation) {
1092 switch (getDefSkip().kind()) {
1093 case VSpace::SMALLSKIP:
1094 os << "\\setlength{\\parskip}{\\smallskipamount}\n";
1096 case VSpace::MEDSKIP:
1097 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1099 case VSpace::BIGSKIP:
1100 os << "\\setlength{\\parskip}{\\bigskipamount}\n";
1102 case VSpace::LENGTH:
1103 os << "\\setlength{\\parskip}{"
1104 << from_utf8(getDefSkip().length().asLatexString())
1107 default: // should never happen // Then delete it.
1108 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1113 os << "\\setlength{\\parindent}{0pt}\n";
1117 // If we use jurabib, we have to call babel here.
1118 if (use_babel && features.isRequired("jurabib")) {
1119 os << from_ascii(babelCall(language_options.str()))
1121 << from_ascii(features.getBabelOptions());
1125 // Now insert the LyX specific LaTeX commands...
1127 // The optional packages;
1128 docstring lyxpreamble(from_ascii(features.getPackages()));
1130 // We try to load babel late, in case it interferes
1131 // with other packages. But some packages also need babel to be loaded
1132 // before, e.g. jurabib has to be called after babel.
1133 // So load babel after the optional packages but before the user-defined
1134 // preamble. This allows the users to redefine babel commands, e.g. to
1135 // translate the word "Index" to the German "Stichwortverzeichnis".
1136 // For more infos why this place was chosen, see
1137 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg128425.html
1138 // If you encounter problems, you can shift babel to its old place behind
1139 // the user-defined preamble. But in this case you must change the Vietnamese
1140 // support from currently "\usepackage[vietnamese]{babel}" to:
1141 // \usepackage{vietnamese}
1142 // \usepackage{babel}
1143 // because vietnamese must be loaded before hyperref
1144 if (use_babel && !features.isRequired("jurabib")) {
1146 lyxpreamble += from_utf8(babelCall(language_options.str())) + '\n';
1147 lyxpreamble += from_utf8(features.getBabelOptions());
1150 // When the language "japanese-plain" is used, the package "japanese" must
1151 // be loaded behind babel (it provides babel support for Japanese) but before
1153 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
1154 if (language->lang() == "japanese-plain" &&
1155 !getTextClass().provides("japanese")) {
1156 //load babel in case it was not loaded due to an empty language list
1157 if (language_options.str().empty())
1158 lyxpreamble += "\\usepackage{babel}\n";
1159 lyxpreamble += "\\usepackage{japanese}\n";
1163 // * Hyperref manual: "Make sure it comes last of your loaded
1164 // packages, to give it a fighting chance of not being over-written,
1165 // since its job is to redefine many LATEX commands."
1166 // * Email from Heiko Oberdiek: "It is usually better to load babel
1167 // before hyperref. Then hyperref has a chance to detect babel.
1168 // * Has to be loaded before the "LyX specific LaTeX commands" to
1169 // avoid errors with algorithm floats.
1170 odocstringstream oss;
1171 pdfoptions().writeLaTeX(oss);
1172 lyxpreamble += oss.str();
1174 // this might be useful...
1175 lyxpreamble += "\n\\makeatletter\n";
1177 // Some macros LyX will need
1178 docstring tmppreamble(from_ascii(features.getMacros()));
1180 if (!tmppreamble.empty()) {
1181 lyxpreamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1182 "LyX specific LaTeX commands.\n"
1183 + tmppreamble + '\n';
1186 // the text class specific preamble
1187 tmppreamble = features.getTClassPreamble();
1188 if (!tmppreamble.empty()) {
1189 lyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1190 "Textclass specific LaTeX commands.\n"
1191 + tmppreamble + '\n';
1194 /* the user-defined preamble */
1195 if (!preamble.empty()) {
1197 lyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1198 "User specified LaTeX commands.\n"
1199 + from_utf8(preamble) + '\n';
1202 // Itemize bullet settings need to be last in case the user
1203 // defines their own bullets that use a package included
1204 // in the user-defined preamble -- ARRae
1205 // Actually it has to be done much later than that
1206 // since some packages like frenchb make modifications
1207 // at \begin{document} time -- JMarc
1208 docstring bullets_def;
1209 for (int i = 0; i < 4; ++i) {
1210 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1211 if (bullets_def.empty())
1212 bullets_def += "\\AtBeginDocument{\n";
1213 bullets_def += " \\def\\labelitemi";
1215 // `i' is one less than the item to modify
1222 bullets_def += "ii";
1228 bullets_def += '{' +
1229 user_defined_bullet(i).getText()
1234 if (!bullets_def.empty())
1235 lyxpreamble += bullets_def + "}\n\n";
1237 lyxpreamble += "\\makeatother\n\n";
1240 int(count(lyxpreamble.begin(), lyxpreamble.end(), '\n'));
1241 for (int j = 0; j != nlines; ++j) {
1250 void BufferParams::useClassDefaults()
1252 TextClass const & tclass = textclasslist[baseClass_];
1254 sides = tclass.sides();
1255 columns = tclass.columns();
1256 pagestyle = tclass.pagestyle();
1257 options = tclass.options();
1258 // Only if class has a ToC hierarchy
1259 if (tclass.hasTocLevels()) {
1260 secnumdepth = tclass.secnumdepth();
1261 tocdepth = tclass.tocdepth();
1266 bool BufferParams::hasClassDefaults() const
1268 TextClass const & tclass = textclasslist[baseClass_];
1270 return (sides == tclass.sides()
1271 && columns == tclass.columns()
1272 && pagestyle == tclass.pagestyle()
1273 && options == tclass.options()
1274 && secnumdepth == tclass.secnumdepth()
1275 && tocdepth == tclass.tocdepth());
1279 TextClass const & BufferParams::getTextClass() const
1285 TextClassPtr BufferParams::getTextClassPtr() const {
1290 void BufferParams::setTextClass(TextClassPtr tc) {
1295 bool BufferParams::setBaseClass(textclass_type tc)
1298 if (textclasslist[tc].load())
1302 bformat(_("The document class %1$s could not be loaded."),
1303 from_utf8(textclasslist[tc].name()));
1304 frontend::Alert::error(_("Could not load class"), s);
1312 void BufferParams::setJustBaseClass(textclass_type tc)
1318 textclass_type BufferParams::getBaseClass() const
1324 void BufferParams::makeTextClass()
1326 textClass_.reset(new TextClass(textclasslist[getBaseClass()]));
1327 //FIXME It might be worth loading the children's modules here,
1328 //just as we load their bibliographies and such, instead of just
1329 //doing a check in InsetInclude.
1330 LayoutModuleList::const_iterator it = layoutModules_.begin();
1331 for (; it != layoutModules_.end(); it++) {
1332 string const modName = *it;
1333 LyXModule * lm = moduleList[modName];
1335 docstring const msg =
1336 bformat(_("The module %1$s has been requested by\n"
1337 "this document but has not been found in the list of\n"
1338 "available modules. If you recently installed it, you\n"
1339 "probalby need to reconfigure LyX.\n"), from_utf8(modName));
1340 frontend::Alert::warning(_("Module not available"),
1341 msg + _("Some layouts may not be available."));
1342 lyxerr << "BufferParams::makeTextClass(): Module " <<
1343 modName << " requested but not found in module list." <<
1347 FileName layout_file = libFileSearch("layouts", lm->filename);
1348 textClass_->read(layout_file, TextClass::MODULE);
1353 std::vector<string> const & BufferParams::getModules() const {
1354 return layoutModules_;
1359 bool BufferParams::addLayoutModule(string modName, bool makeClass) {
1360 LayoutModuleList::const_iterator it = layoutModules_.begin();
1361 LayoutModuleList::const_iterator end = layoutModules_.end();
1362 for (; it != end; it++) {
1366 if (it != layoutModules_.end())
1368 layoutModules_.push_back(modName);
1375 bool BufferParams::addLayoutModules(std::vector<string>modNames)
1378 std::vector<string>::const_iterator it = modNames.begin();
1379 std::vector<string>::const_iterator end = modNames.end();
1380 for (; it != end; ++it)
1381 retval &= addLayoutModule(*it, false);
1387 void BufferParams::clearLayoutModules() {
1388 layoutModules_.clear();
1393 Font const BufferParams::getFont() const
1395 Font f = getTextClass().defaultfont();
1396 f.setLanguage(language);
1397 if (fontsDefaultFamily == "rmdefault")
1398 f.setFamily(Font::ROMAN_FAMILY);
1399 else if (fontsDefaultFamily == "sfdefault")
1400 f.setFamily(Font::SANS_FAMILY);
1401 else if (fontsDefaultFamily == "ttdefault")
1402 f.setFamily(Font::TYPEWRITER_FAMILY);
1407 void BufferParams::readPreamble(Lexer & lex)
1409 if (lex.getString() != "\\begin_preamble")
1410 lyxerr << "Error (BufferParams::readPreamble):"
1411 "consistency check failed." << endl;
1413 preamble = lex.getLongString("\\end_preamble");
1417 void BufferParams::readLanguage(Lexer & lex)
1419 if (!lex.next()) return;
1421 string const tmptok = lex.getString();
1423 // check if tmptok is part of tex_babel in tex-defs.h
1424 language = languages.getLanguage(tmptok);
1426 // Language tmptok was not found
1427 language = default_language;
1428 lyxerr << "Warning: Setting language `"
1429 << tmptok << "' to `" << language->lang()
1435 void BufferParams::readGraphicsDriver(Lexer & lex)
1437 if (!lex.next()) return;
1439 string const tmptok = lex.getString();
1440 // check if tmptok is part of tex_graphics in tex_defs.h
1443 string const test = tex_graphics[n++];
1445 if (test == tmptok) {
1446 graphicsDriver = tmptok;
1448 } else if (test == "") {
1450 "Warning: graphics driver `$$Token' not recognized!\n"
1451 " Setting graphics driver to `default'.\n");
1452 graphicsDriver = "default";
1459 void BufferParams::readBullets(Lexer & lex)
1461 if (!lex.next()) return;
1463 int const index = lex.getInteger();
1465 int temp_int = lex.getInteger();
1466 user_defined_bullet(index).setFont(temp_int);
1467 temp_bullet(index).setFont(temp_int);
1469 user_defined_bullet(index).setCharacter(temp_int);
1470 temp_bullet(index).setCharacter(temp_int);
1472 user_defined_bullet(index).setSize(temp_int);
1473 temp_bullet(index).setSize(temp_int);
1477 void BufferParams::readBulletsLaTeX(Lexer & lex)
1479 // The bullet class should be able to read this.
1480 if (!lex.next()) return;
1481 int const index = lex.getInteger();
1483 docstring const temp_str = lex.getDocString();
1485 user_defined_bullet(index).setText(temp_str);
1486 temp_bullet(index).setText(temp_str);
1490 void BufferParams::readModules(Lexer & lex)
1492 if (!lex.eatLine()) {
1493 lyxerr << "Error (BufferParams::readModules):"
1494 "Unexpected end of input." << endl;
1498 string mod = lex.getString();
1499 if (mod == "\\end_modules")
1501 addLayoutModule(mod);
1507 string const BufferParams::paperSizeName() const
1509 char real_papersize = papersize;
1510 if (real_papersize == PAPER_DEFAULT)
1511 real_papersize = lyxrc.default_papersize;
1513 switch (real_papersize) {
1522 case PAPER_USEXECUTIVE:
1526 case PAPER_USLETTER:
1533 string const BufferParams::dvips_options() const
1538 && papersize == PAPER_CUSTOM
1539 && !lyxrc.print_paper_dimension_flag.empty()
1540 && !paperwidth.empty()
1541 && !paperheight.empty()) {
1542 // using a custom papersize
1543 result = lyxrc.print_paper_dimension_flag;
1544 result += ' ' + paperwidth;
1545 result += ',' + paperheight;
1547 string const paper_option = paperSizeName();
1548 if (paper_option != "letter" ||
1549 orientation != ORIENTATION_LANDSCAPE) {
1550 // dvips won't accept -t letter -t landscape.
1551 // In all other cases, include the paper size
1553 result = lyxrc.print_paper_flag;
1554 result += ' ' + paper_option;
1557 if (orientation == ORIENTATION_LANDSCAPE &&
1558 papersize != PAPER_CUSTOM)
1559 result += ' ' + lyxrc.print_landscape_flag;
1564 string const BufferParams::babelCall(string const & lang_opts) const
1566 string lang_pack = lyxrc.language_package;
1567 if (lang_pack != "\\usepackage{babel}")
1569 // suppress the babel call when there is no babel language defined
1570 // for the document language in the lib/languages file and if no
1571 // other languages are used (lang_opts is then empty)
1572 if (lang_opts.empty())
1574 // when Vietnamese is used, babel must directly be loaded with the
1575 // language options, see
1576 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129417.html
1577 int viet = lang_opts.find("vietnam");
1578 // viet = string::npos when not found
1579 if (!lyxrc.language_global_options || viet != string::npos)
1580 return "\\usepackage[" + lang_opts + "]{babel}";
1585 void BufferParams::writeEncodingPreamble(odocstream & os,
1586 LaTeXFeatures & features, TexRow & texrow) const
1588 if (inputenc == "auto") {
1589 string const doc_encoding =
1590 language->encoding()->latexName();
1591 Encoding::Package const package =
1592 language->encoding()->package();
1594 // Create a list with all the input encodings used
1596 std::set<string> encodings =
1597 features.getEncodingSet(doc_encoding);
1599 // When the encodings EUC-JP-plain, JIS-plain, or SJIS-plainare used, the
1600 // package inputenc must be omitted. Therefore set the encoding to empty.
1601 // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
1602 if (doc_encoding == "EUC-JP-plain" || doc_encoding == "JIS-plain" ||
1603 doc_encoding == "SJIS-plain")
1606 if (!encodings.empty() || package == Encoding::inputenc) {
1607 os << "\\usepackage[";
1608 std::set<string>::const_iterator it = encodings.begin();
1609 std::set<string>::const_iterator const end = encodings.end();
1611 os << from_ascii(*it);
1614 for (; it != end; ++it)
1615 os << ',' << from_ascii(*it);
1616 if (package == Encoding::inputenc) {
1617 if (!encodings.empty())
1619 os << from_ascii(doc_encoding);
1621 os << "]{inputenc}\n";
1624 if (package == Encoding::CJK) {
1625 os << "\\usepackage{CJK}\n";
1628 } else if (inputenc != "default") {
1629 switch (encoding().package()) {
1630 case Encoding::none:
1632 case Encoding::inputenc:
1633 os << "\\usepackage[" << from_ascii(inputenc)
1638 os << "\\usepackage{CJK}\n";
1644 // The encoding "armscii8" is only available when the package "armtex" is loaded.
1645 // armscii8 is used for Armenian.
1646 if (language->encoding()->latexName() == "armscii8" || inputenc == "armscii8") {
1647 os << "\\usepackage{armtex}\n";
1653 string const BufferParams::loadFonts(string const & rm,
1654 string const & sf, string const & tt,
1655 bool const & sc, bool const & osf,
1656 int const & sfscale, int const & ttscale) const
1658 /* The LaTeX font world is in a flux. In the PSNFSS font interface,
1659 several packages have been replaced by others, that might not
1660 be installed on every system. We have to take care for that
1661 (see psnfss.pdf). We try to support all psnfss fonts as well
1662 as the fonts that have become de facto standard in the LaTeX
1663 world (e.g. Latin Modern). We do not support obsolete fonts
1664 (like PSLatex). In general, it should be possible to mix any
1665 rm font with any sf or tt font, respectively. (JSpitzm)
1667 -- separate math fonts.
1670 if (rm == "default" && sf == "default" && tt == "default")
1677 // Computer Modern (must be explicitely selectable -- there might be classes
1678 // that define a different default font!
1680 os << "\\renewcommand{\\rmdefault}{cmr}\n";
1681 // osf for Computer Modern needs eco.sty
1683 os << "\\usepackage{eco}\n";
1685 // Latin Modern Roman
1686 else if (rm == "lmodern")
1687 os << "\\usepackage{lmodern}\n";
1689 else if (rm == "ae") {
1690 // not needed when using OT1 font encoding.
1691 if (lyxrc.fontenc != "default")
1692 os << "\\usepackage{ae,aecompl}\n";
1695 else if (rm == "times") {
1696 // try to load the best available package
1697 if (LaTeXFeatures::isAvailable("mathptmx"))
1698 os << "\\usepackage{mathptmx}\n";
1699 else if (LaTeXFeatures::isAvailable("mathptm"))
1700 os << "\\usepackage{mathptm}\n";
1702 os << "\\usepackage{times}\n";
1705 else if (rm == "palatino") {
1706 // try to load the best available package
1707 if (LaTeXFeatures::isAvailable("mathpazo")) {
1708 os << "\\usepackage";
1714 // "osf" includes "sc"!
1718 os << "{mathpazo}\n";
1720 else if (LaTeXFeatures::isAvailable("mathpple"))
1721 os << "\\usepackage{mathpple}\n";
1723 os << "\\usepackage{palatino}\n";
1726 else if (rm == "utopia") {
1727 // fourier supersedes utopia.sty, but does
1728 // not work with OT1 encoding.
1729 if (LaTeXFeatures::isAvailable("fourier")
1730 && lyxrc.fontenc != "default") {
1731 os << "\\usepackage";
1742 os << "{fourier}\n";
1745 os << "\\usepackage{utopia}\n";
1747 // Bera (complete fontset)
1748 else if (rm == "bera" && sf == "default" && tt == "default")
1749 os << "\\usepackage{bera}\n";
1751 else if (rm != "default")
1752 os << "\\usepackage" << "{" << rm << "}\n";
1755 // Helvetica, Bera Sans
1756 if (sf == "helvet" || sf == "berasans") {
1758 os << "\\usepackage[scaled=" << float(sfscale) / 100
1759 << "]{" << sf << "}\n";
1761 os << "\\usepackage{" << sf << "}\n";
1764 else if (sf == "avant")
1765 os << "\\usepackage{" << sf << "}\n";
1766 // Computer Modern, Latin Modern, CM Bright
1767 else if (sf != "default")
1768 os << "\\renewcommand{\\sfdefault}{" << sf << "}\n";
1770 // monospaced/typewriter
1771 // Courier, LuxiMono
1772 if (tt == "luximono" || tt == "beramono") {
1774 os << "\\usepackage[scaled=" << float(ttscale) / 100
1775 << "]{" << tt << "}\n";
1777 os << "\\usepackage{" << tt << "}\n";
1780 else if (tt == "courier" )
1781 os << "\\usepackage{" << tt << "}\n";
1782 // Computer Modern, Latin Modern, CM Bright
1783 else if (tt != "default")
1784 os << "\\renewcommand{\\ttdefault}{" << tt << "}\n";
1790 Encoding const & BufferParams::encoding() const
1792 if (inputenc == "auto" || inputenc == "default")
1793 return *(language->encoding());
1794 Encoding const * const enc =
1795 encodings.getFromLaTeXName(inputenc);
1798 lyxerr << "Unknown inputenc value `" << inputenc
1799 << "'. Using `auto' instead." << endl;
1800 return *(language->encoding());
1804 biblio::CiteEngine BufferParams::getEngine() const
1806 // FIXME the class should provide the numerical/
1807 // authoryear choice
1808 if (getTextClass().provides("natbib")
1809 && cite_engine_ != biblio::ENGINE_NATBIB_NUMERICAL)
1810 return biblio::ENGINE_NATBIB_AUTHORYEAR;
1811 return cite_engine_;
1815 void BufferParams::setCiteEngine(biblio::CiteEngine const cite_engine)
1817 cite_engine_ = cite_engine;