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"
27 #include "Converter.h"
30 #include "IndicesList.h"
32 #include "LaTeXFeatures.h"
33 #include "ModuleList.h"
37 #include "OutputParams.h"
41 #include "PDFOptions.h"
43 #include "frontends/alert.h"
45 #include "insets/InsetListingsParams.h"
47 #include "support/convert.h"
48 #include "support/debug.h"
49 #include "support/docstream.h"
50 #include "support/FileName.h"
51 #include "support/filetools.h"
52 #include "support/gettext.h"
53 #include "support/Messages.h"
54 #include "support/Translator.h"
55 #include "support/lstrings.h"
61 using namespace lyx::support;
64 static char const * const string_paragraph_separation[] = {
69 static char const * const string_quotes_language[] = {
70 "english", "swedish", "german", "polish", "french", "danish", ""
74 static char const * const string_papersize[] = {
75 "default", "custom", "letterpaper", "legalpaper", "executivepaper",
76 "a0paper", "a1paper", "a2paper", "a3paper", "a4paper", "a5paper",
77 "a6paper", "b0paper", "b1paper", "b2paper","b3paper", "b4paper",
78 "b5paper", "b6paper", "c0paper", "c1paper", "c2paper", "c3paper",
79 "c4paper", "c5paper", "c6paper", "b0j", "b1j", "b2j", "b3j", "b4j", "b5j",
84 static char const * const string_orientation[] = {
85 "portrait", "landscape", ""
89 static char const * const string_footnotekinds[] = {
90 "footnote", "margin", "fig", "tab", "alg", "wide-fig", "wide-tab", ""
94 static char const * const tex_graphics[] = {
95 "default", "dvialw", "dvilaser", "dvipdf", "dvipdfm", "dvipdfmx",
96 "dvips", "dvipsone", "dvitops", "dviwin", "dviwindo", "dvi2ps", "emtex",
97 "ln", "oztex", "pctexhp", "pctexps", "pctexwin", "pctex32", "pdftex",
98 "psprint", "pubps", "tcidvi", "textures", "truetex", "vtex", "xdvi",
109 // Paragraph separation
110 typedef Translator<string, BufferParams::ParagraphSeparation> ParSepTranslator;
113 ParSepTranslator const init_parseptranslator()
115 ParSepTranslator translator
116 (string_paragraph_separation[0], BufferParams::ParagraphIndentSeparation);
117 translator.addPair(string_paragraph_separation[1], BufferParams::ParagraphSkipSeparation);
122 ParSepTranslator const & parseptranslator()
124 static ParSepTranslator translator = init_parseptranslator();
130 typedef Translator<string, InsetQuotes::QuoteLanguage> QuotesLangTranslator;
133 QuotesLangTranslator const init_quoteslangtranslator()
135 QuotesLangTranslator translator
136 (string_quotes_language[0], InsetQuotes::EnglishQuotes);
137 translator.addPair(string_quotes_language[1], InsetQuotes::SwedishQuotes);
138 translator.addPair(string_quotes_language[2], InsetQuotes::GermanQuotes);
139 translator.addPair(string_quotes_language[3], InsetQuotes::PolishQuotes);
140 translator.addPair(string_quotes_language[4], InsetQuotes::FrenchQuotes);
141 translator.addPair(string_quotes_language[5], InsetQuotes::DanishQuotes);
146 QuotesLangTranslator const & quoteslangtranslator()
148 static QuotesLangTranslator translator = init_quoteslangtranslator();
154 typedef Translator<string, PAPER_SIZE> PaperSizeTranslator;
157 static PaperSizeTranslator initPaperSizeTranslator()
159 PaperSizeTranslator translator(string_papersize[0], PAPER_DEFAULT);
160 translator.addPair(string_papersize[1], PAPER_CUSTOM);
161 translator.addPair(string_papersize[2], PAPER_USLETTER);
162 translator.addPair(string_papersize[3], PAPER_USLEGAL);
163 translator.addPair(string_papersize[4], PAPER_USEXECUTIVE);
164 translator.addPair(string_papersize[5], PAPER_A0);
165 translator.addPair(string_papersize[6], PAPER_A1);
166 translator.addPair(string_papersize[7], PAPER_A2);
167 translator.addPair(string_papersize[8], PAPER_A3);
168 translator.addPair(string_papersize[9], PAPER_A4);
169 translator.addPair(string_papersize[10], PAPER_A5);
170 translator.addPair(string_papersize[11], PAPER_A6);
171 translator.addPair(string_papersize[12], PAPER_B0);
172 translator.addPair(string_papersize[13], PAPER_B1);
173 translator.addPair(string_papersize[14], PAPER_B2);
174 translator.addPair(string_papersize[15], PAPER_B3);
175 translator.addPair(string_papersize[16], PAPER_B4);
176 translator.addPair(string_papersize[17], PAPER_B5);
177 translator.addPair(string_papersize[18], PAPER_B6);
178 translator.addPair(string_papersize[19], PAPER_C0);
179 translator.addPair(string_papersize[20], PAPER_C1);
180 translator.addPair(string_papersize[21], PAPER_C2);
181 translator.addPair(string_papersize[22], PAPER_C3);
182 translator.addPair(string_papersize[23], PAPER_C4);
183 translator.addPair(string_papersize[24], PAPER_C5);
184 translator.addPair(string_papersize[25], PAPER_C6);
185 translator.addPair(string_papersize[26], PAPER_JISB0);
186 translator.addPair(string_papersize[27], PAPER_JISB1);
187 translator.addPair(string_papersize[28], PAPER_JISB2);
188 translator.addPair(string_papersize[29], PAPER_JISB3);
189 translator.addPair(string_papersize[30], PAPER_JISB4);
190 translator.addPair(string_papersize[31], PAPER_JISB5);
191 translator.addPair(string_papersize[32], PAPER_JISB6);
196 PaperSizeTranslator const & papersizetranslator()
198 static PaperSizeTranslator translator = initPaperSizeTranslator();
204 typedef Translator<string, PAPER_ORIENTATION> PaperOrientationTranslator;
207 PaperOrientationTranslator const init_paperorientationtranslator()
209 PaperOrientationTranslator translator(string_orientation[0], ORIENTATION_PORTRAIT);
210 translator.addPair(string_orientation[1], ORIENTATION_LANDSCAPE);
215 PaperOrientationTranslator const & paperorientationtranslator()
217 static PaperOrientationTranslator translator = init_paperorientationtranslator();
223 typedef Translator<int, PageSides> SidesTranslator;
226 SidesTranslator const init_sidestranslator()
228 SidesTranslator translator(1, OneSide);
229 translator.addPair(2, TwoSides);
234 SidesTranslator const & sidestranslator()
236 static SidesTranslator translator = init_sidestranslator();
242 typedef Translator<int, BufferParams::Package> PackageTranslator;
245 PackageTranslator const init_packagetranslator()
247 PackageTranslator translator(0, BufferParams::package_off);
248 translator.addPair(1, BufferParams::package_auto);
249 translator.addPair(2, BufferParams::package_on);
254 PackageTranslator const & packagetranslator()
256 static PackageTranslator translator = init_packagetranslator();
262 typedef Translator<string, CiteEngine> CiteEngineTranslator;
265 CiteEngineTranslator const init_citeenginetranslator()
267 CiteEngineTranslator translator("basic", ENGINE_BASIC);
268 translator.addPair("natbib_numerical", ENGINE_NATBIB_NUMERICAL);
269 translator.addPair("natbib_authoryear", ENGINE_NATBIB_AUTHORYEAR);
270 translator.addPair("jurabib", ENGINE_JURABIB);
275 CiteEngineTranslator const & citeenginetranslator()
277 static CiteEngineTranslator translator = init_citeenginetranslator();
283 typedef Translator<string, Spacing::Space> SpaceTranslator;
286 SpaceTranslator const init_spacetranslator()
288 SpaceTranslator translator("default", Spacing::Default);
289 translator.addPair("single", Spacing::Single);
290 translator.addPair("onehalf", Spacing::Onehalf);
291 translator.addPair("double", Spacing::Double);
292 translator.addPair("other", Spacing::Other);
297 SpaceTranslator const & spacetranslator()
299 static SpaceTranslator translator = init_spacetranslator();
306 class BufferParams::Impl
311 AuthorList authorlist;
312 BranchList branchlist;
313 Bullet temp_bullets[4];
314 Bullet user_defined_bullets[4];
315 IndicesList indiceslist;
317 /** This is the amount of space used for paragraph_separation "skip",
318 * and for detached paragraphs in "indented" documents.
322 PDFOptions pdfoptions;
323 LayoutFileIndex baseClass_;
327 BufferParams::Impl::Impl()
328 : defskip(VSpace::MEDSKIP), baseClass_(string(""))
330 // set initial author
332 authorlist.record(Author(from_utf8(lyxrc.user_name), from_utf8(lyxrc.user_email)));
337 BufferParams::MemoryTraits::clone(BufferParams::Impl const * ptr)
341 return new BufferParams::Impl(*ptr);
345 void BufferParams::MemoryTraits::destroy(BufferParams::Impl * ptr)
351 BufferParams::BufferParams()
354 setBaseClass(defaultBaseclass());
356 paragraph_separation = ParagraphIndentSeparation;
357 quotes_language = InsetQuotes::EnglishQuotes;
358 fontsize = "default";
361 papersize = PAPER_DEFAULT;
362 orientation = ORIENTATION_PORTRAIT;
363 use_geometry = false;
364 use_amsmath = package_auto;
365 use_esint = package_auto;
366 use_mhchem = package_auto;
367 use_mathdots = package_auto;
368 use_undertilde = package_auto;
369 cite_engine_ = ENGINE_BASIC;
370 use_bibtopic = false;
372 trackChanges = false;
373 outputChanges = false;
374 use_default_options = true;
375 maintain_unincluded_children = false;
378 language = default_language;
380 fonts_roman = "default";
381 fonts_sans = "default";
382 fonts_typewriter = "default";
383 fonts_default_family = "default";
384 useNonTeXFonts = false;
385 fonts_expert_sc = false;
386 fonts_old_figures = false;
387 fonts_sans_scale = 100;
388 fonts_typewriter_scale = 100;
390 lang_package = "default";
391 graphics_driver = "default";
392 default_output_format = "default";
393 bibtex_command = "default";
394 index_command = "default";
397 listings_params = string();
398 pagestyle = "default";
399 suppress_date = false;
400 // no color is the default (white)
401 backgroundcolor = lyx::rgbFromHexName("#ffffff");
402 isbackgroundcolor = false;
403 // no color is the default (black)
404 fontcolor = lyx::rgbFromHexName("#000000");
406 // light gray is the default font color for greyed-out notes
407 notefontcolor = lyx::rgbFromHexName("#cccccc");
408 boxbgcolor = lyx::rgbFromHexName("#ff0000");
409 compressed = lyxrc.save_compressed;
410 for (int iter = 0; iter < 4; ++iter) {
411 user_defined_bullet(iter) = ITEMIZE_DEFAULTS[iter];
412 temp_bullet(iter) = ITEMIZE_DEFAULTS[iter];
415 indiceslist().addDefault(B_("Index"));
416 html_be_strict = false;
417 html_math_output = MathML;
418 html_math_img_scale = 1.0;
419 html_css_as_file = false;
426 docstring BufferParams::B_(string const & l10n) const
428 LASSERT(language, /**/);
429 return getMessages(language->code()).get(l10n);
433 AuthorList & BufferParams::authors()
435 return pimpl_->authorlist;
439 AuthorList const & BufferParams::authors() const
441 return pimpl_->authorlist;
445 BranchList & BufferParams::branchlist()
447 return pimpl_->branchlist;
451 BranchList const & BufferParams::branchlist() const
453 return pimpl_->branchlist;
457 IndicesList & BufferParams::indiceslist()
459 return pimpl_->indiceslist;
463 IndicesList const & BufferParams::indiceslist() const
465 return pimpl_->indiceslist;
469 Bullet & BufferParams::temp_bullet(lyx::size_type const index)
471 LASSERT(index < 4, /**/);
472 return pimpl_->temp_bullets[index];
476 Bullet const & BufferParams::temp_bullet(lyx::size_type const index) const
478 LASSERT(index < 4, /**/);
479 return pimpl_->temp_bullets[index];
483 Bullet & BufferParams::user_defined_bullet(lyx::size_type const index)
485 LASSERT(index < 4, /**/);
486 return pimpl_->user_defined_bullets[index];
490 Bullet const & BufferParams::user_defined_bullet(lyx::size_type const index) const
492 LASSERT(index < 4, /**/);
493 return pimpl_->user_defined_bullets[index];
497 Spacing & BufferParams::spacing()
499 return pimpl_->spacing;
503 Spacing const & BufferParams::spacing() const
505 return pimpl_->spacing;
509 PDFOptions & BufferParams::pdfoptions()
511 return pimpl_->pdfoptions;
515 PDFOptions const & BufferParams::pdfoptions() const
517 return pimpl_->pdfoptions;
521 HSpace const & BufferParams::getIndentation() const
523 return pimpl_->indentation;
527 void BufferParams::setIndentation(HSpace const & indent)
529 pimpl_->indentation = indent;
533 VSpace const & BufferParams::getDefSkip() const
535 return pimpl_->defskip;
539 void BufferParams::setDefSkip(VSpace const & vs)
541 // DEFSKIP will cause an infinite loop
542 LASSERT(vs.kind() != VSpace::DEFSKIP, return);
543 pimpl_->defskip = vs;
547 string BufferParams::readToken(Lexer & lex, string const & token,
548 FileName const & filepath)
550 if (token == "\\textclass") {
552 string const classname = lex.getString();
553 // if there exists a local layout file, ignore the system one
554 // NOTE: in this case, the textclass (.cls file) is assumed to
557 LayoutFileList & bcl = LayoutFileList::get();
558 if (tcp.empty() && !filepath.empty())
559 tcp = bcl.addLocalLayout(classname, filepath.absFileName());
563 setBaseClass(classname);
564 // We assume that a tex class exists for local or unknown
565 // layouts so this warning, will only be given for system layouts.
566 if (!baseClass()->isTeXClassAvailable()) {
567 docstring const desc =
568 translateIfPossible(from_utf8(baseClass()->description()));
569 docstring const prereqs =
570 from_utf8(baseClass()->prerequisites());
571 docstring const msg =
572 bformat(_("The selected document class\n"
574 "requires external files that are not available.\n"
575 "The document class can still be used, but the\n"
576 "document cannot be compiled until the following\n"
577 "prerequisites are installed:\n"
579 "See section 3.1.2.2 (Class Availability) of the\n"
580 "User's Guide for more information."), desc, prereqs);
581 frontend::Alert::warning(_("Document class not available"),
584 } else if (token == "\\begin_preamble") {
586 } else if (token == "\\begin_local_layout") {
587 readLocalLayout(lex);
588 } else if (token == "\\begin_modules") {
590 } else if (token == "\\begin_removed_modules") {
591 readRemovedModules(lex);
592 } else if (token == "\\begin_includeonly") {
593 readIncludeonly(lex);
594 } else if (token == "\\maintain_unincluded_children") {
595 lex >> maintain_unincluded_children;
596 } else if (token == "\\options") {
598 options = lex.getString();
599 } else if (token == "\\use_default_options") {
600 lex >> use_default_options;
601 } else if (token == "\\master") {
603 master = lex.getString();
604 } else if (token == "\\suppress_date") {
605 lex >> suppress_date;
606 } else if (token == "\\language") {
608 } else if (token == "\\language_package") {
610 lang_package = lex.getString();
611 } else if (token == "\\inputencoding") {
613 } else if (token == "\\graphics") {
614 readGraphicsDriver(lex);
615 } else if (token == "\\default_output_format") {
616 lex >> default_output_format;
617 } else if (token == "\\bibtex_command") {
619 bibtex_command = lex.getString();
620 } else if (token == "\\index_command") {
622 index_command = lex.getString();
623 } else if (token == "\\fontencoding") {
625 fontenc = lex.getString();
626 } else if (token == "\\font_roman") {
628 fonts_roman = lex.getString();
629 } else if (token == "\\font_sans") {
631 fonts_sans = lex.getString();
632 } else if (token == "\\font_typewriter") {
634 fonts_typewriter = lex.getString();
635 } else if (token == "\\font_default_family") {
636 lex >> fonts_default_family;
637 } else if (token == "\\use_non_tex_fonts") {
638 lex >> useNonTeXFonts;
639 } else if (token == "\\font_sc") {
640 lex >> fonts_expert_sc;
641 } else if (token == "\\font_osf") {
642 lex >> fonts_old_figures;
643 } else if (token == "\\font_sf_scale") {
644 lex >> fonts_sans_scale;
645 } else if (token == "\\font_tt_scale") {
646 lex >> fonts_typewriter_scale;
647 } else if (token == "\\font_cjk") {
649 } else if (token == "\\paragraph_separation") {
652 paragraph_separation = parseptranslator().find(parsep);
653 } else if (token == "\\paragraph_indentation") {
655 string indentation = lex.getString();
656 pimpl_->indentation = HSpace(indentation);
657 } else if (token == "\\defskip") {
659 string const defskip = lex.getString();
660 pimpl_->defskip = VSpace(defskip);
661 if (pimpl_->defskip.kind() == VSpace::DEFSKIP)
663 pimpl_->defskip = VSpace(VSpace::MEDSKIP);
664 } else if (token == "\\quotes_language") {
667 quotes_language = quoteslangtranslator().find(quotes_lang);
668 } else if (token == "\\papersize") {
671 papersize = papersizetranslator().find(ppsize);
672 } else if (token == "\\use_geometry") {
674 } else if (token == "\\use_amsmath") {
677 use_amsmath = packagetranslator().find(use_ams);
678 } else if (token == "\\use_esint") {
681 use_esint = packagetranslator().find(useesint);
682 } else if (token == "\\use_mhchem") {
685 use_mhchem = packagetranslator().find(usemhchem);
686 } else if (token == "\\use_mathdots") {
689 use_mathdots = packagetranslator().find(usemathdots);
690 } else if (token == "\\use_undertilde") {
692 lex >> useundertilde;
693 use_undertilde = packagetranslator().find(useundertilde);
694 } else if (token == "\\cite_engine") {
697 cite_engine_ = citeenginetranslator().find(engine);
698 } else if (token == "\\use_bibtopic") {
700 } else if (token == "\\use_indices") {
702 } else if (token == "\\tracking_changes") {
704 } else if (token == "\\output_changes") {
705 lex >> outputChanges;
706 } else if (token == "\\branch") {
708 docstring branch = lex.getDocString();
709 branchlist().add(branch);
712 string const tok = lex.getString();
713 if (tok == "\\end_branch")
715 Branch * branch_ptr = branchlist().find(branch);
716 if (tok == "\\selected") {
719 branch_ptr->setSelected(lex.getInteger());
721 if (tok == "\\filename_suffix") {
724 branch_ptr->setFileNameSuffix(lex.getInteger());
726 if (tok == "\\color") {
728 string color = lex.getString();
730 branch_ptr->setColor(color);
731 // Update also the Color table:
733 color = lcolor.getX11Name(Color_background);
735 lcolor.setColor(to_utf8(branch), color);
738 } else if (token == "\\index") {
740 docstring index = lex.getDocString();
742 indiceslist().add(index);
745 string const tok = lex.getString();
746 if (tok == "\\end_index")
748 Index * index_ptr = indiceslist().find(index);
749 if (tok == "\\shortcut") {
751 shortcut = lex.getDocString();
753 index_ptr->setShortcut(shortcut);
755 if (tok == "\\color") {
757 string color = lex.getString();
759 index_ptr->setColor(color);
760 // Update also the Color table:
762 color = lcolor.getX11Name(Color_background);
764 if (!shortcut.empty())
765 lcolor.setColor(to_utf8(shortcut), color);
768 } else if (token == "\\author") {
770 istringstream ss(lex.getString());
773 author_map[a.bufferId()] = pimpl_->authorlist.record(a);
774 } else if (token == "\\paperorientation") {
777 orientation = paperorientationtranslator().find(orient);
778 } else if (token == "\\backgroundcolor") {
780 backgroundcolor = lyx::rgbFromHexName(lex.getString());
781 isbackgroundcolor = true;
782 } else if (token == "\\fontcolor") {
784 fontcolor = lyx::rgbFromHexName(lex.getString());
786 } else if (token == "\\notefontcolor") {
788 string color = lex.getString();
789 notefontcolor = lyx::rgbFromHexName(color);
790 } else if (token == "\\boxbgcolor") {
792 string color = lex.getString();
793 boxbgcolor = lyx::rgbFromHexName(color);
794 } else if (token == "\\paperwidth") {
796 } else if (token == "\\paperheight") {
798 } else if (token == "\\leftmargin") {
800 } else if (token == "\\topmargin") {
802 } else if (token == "\\rightmargin") {
804 } else if (token == "\\bottommargin") {
806 } else if (token == "\\headheight") {
808 } else if (token == "\\headsep") {
810 } else if (token == "\\footskip") {
812 } else if (token == "\\columnsep") {
814 } else if (token == "\\paperfontsize") {
816 } else if (token == "\\papercolumns") {
818 } else if (token == "\\listings_params") {
821 listings_params = InsetListingsParams(par).params();
822 } else if (token == "\\papersides") {
825 sides = sidestranslator().find(psides);
826 } else if (token == "\\paperpagestyle") {
828 } else if (token == "\\bullet") {
830 } else if (token == "\\bulletLaTeX") {
831 readBulletsLaTeX(lex);
832 } else if (token == "\\secnumdepth") {
834 } else if (token == "\\tocdepth") {
836 } else if (token == "\\spacing") {
840 if (nspacing == "other") {
843 spacing().set(spacetranslator().find(nspacing), tmp_val);
844 } else if (token == "\\float_placement") {
845 lex >> float_placement;
847 } else if (prefixIs(token, "\\pdf_") || token == "\\use_hyperref") {
848 string toktmp = pdfoptions().readToken(lex, token);
849 if (!toktmp.empty()) {
850 lyxerr << "PDFOptions::readToken(): Unknown token: " <<
854 } else if (token == "\\html_math_output") {
857 html_math_output = static_cast<MathOutput>(temp);
858 } else if (token == "\\html_be_strict") {
859 lex >> html_be_strict;
860 } else if (token == "\\html_css_as_file") {
861 lex >> html_css_as_file;
862 } else if (token == "\\html_math_img_scale") {
863 lex >> html_math_img_scale;
864 } else if (token == "\\html_latex_start") {
866 html_latex_start = lex.getString();
867 } else if (token == "\\html_latex_end") {
869 html_latex_end = lex.getString();
870 } else if (token == "\\output_sync") {
872 } else if (token == "\\output_sync_macro") {
873 lex >> output_sync_macro;
874 } else if (token == "\\use_refstyle") {
877 lyxerr << "BufferParams::readToken(): Unknown token: " <<
886 void BufferParams::writeFile(ostream & os) const
888 // The top of the file is written by the buffer.
889 // Prints out the buffer info into the .lyx file given by file
892 os << "\\textclass " << baseClass()->name() << '\n';
895 if (!preamble.empty()) {
896 // remove '\n' from the end of preamble
897 string const tmppreamble = rtrim(preamble, "\n");
898 os << "\\begin_preamble\n"
900 << "\n\\end_preamble\n";
904 if (!options.empty()) {
905 os << "\\options " << options << '\n';
908 // use the class options defined in the layout?
909 os << "\\use_default_options "
910 << convert<string>(use_default_options) << "\n";
912 // the master document
913 if (!master.empty()) {
914 os << "\\master " << master << '\n';
918 if (!removed_modules_.empty()) {
919 os << "\\begin_removed_modules" << '\n';
920 list<string>::const_iterator it = removed_modules_.begin();
921 list<string>::const_iterator en = removed_modules_.end();
922 for (; it != en; it++)
924 os << "\\end_removed_modules" << '\n';
928 if (!layout_modules_.empty()) {
929 os << "\\begin_modules" << '\n';
930 LayoutModuleList::const_iterator it = layout_modules_.begin();
931 LayoutModuleList::const_iterator en = layout_modules_.end();
932 for (; it != en; it++)
934 os << "\\end_modules" << '\n';
938 if (!included_children_.empty()) {
939 os << "\\begin_includeonly" << '\n';
940 list<string>::const_iterator it = included_children_.begin();
941 list<string>::const_iterator en = included_children_.end();
942 for (; it != en; it++)
944 os << "\\end_includeonly" << '\n';
946 os << "\\maintain_unincluded_children "
947 << convert<string>(maintain_unincluded_children) << '\n';
949 // local layout information
950 if (!local_layout.empty()) {
951 // remove '\n' from the end
952 string const tmplocal = rtrim(local_layout, "\n");
953 os << "\\begin_local_layout\n"
955 << "\n\\end_local_layout\n";
958 // then the text parameters
959 if (language != ignore_language)
960 os << "\\language " << language->lang() << '\n';
961 os << "\\language_package " << lang_package
962 << "\n\\inputencoding " << inputenc
963 << "\n\\fontencoding " << fontenc
964 << "\n\\font_roman " << fonts_roman
965 << "\n\\font_sans " << fonts_sans
966 << "\n\\font_typewriter " << fonts_typewriter
967 << "\n\\font_default_family " << fonts_default_family
968 << "\n\\use_non_tex_fonts " << convert<string>(useNonTeXFonts)
969 << "\n\\font_sc " << convert<string>(fonts_expert_sc)
970 << "\n\\font_osf " << convert<string>(fonts_old_figures)
971 << "\n\\font_sf_scale " << fonts_sans_scale
972 << "\n\\font_tt_scale " << fonts_typewriter_scale
974 if (!fonts_cjk.empty()) {
975 os << "\\font_cjk " << fonts_cjk << '\n';
977 os << "\n\\graphics " << graphics_driver << '\n';
978 os << "\\default_output_format " << default_output_format << '\n';
979 os << "\\output_sync " << output_sync << '\n';
980 if (!output_sync_macro.empty())
981 os << "\\output_sync_macro \"" << output_sync_macro << "\"\n";
982 os << "\\bibtex_command " << bibtex_command << '\n';
983 os << "\\index_command " << index_command << '\n';
985 if (!float_placement.empty()) {
986 os << "\\float_placement " << float_placement << '\n';
988 os << "\\paperfontsize " << fontsize << '\n';
990 spacing().writeFile(os);
991 pdfoptions().writeFile(os);
993 os << "\\papersize " << string_papersize[papersize]
994 << "\n\\use_geometry " << convert<string>(use_geometry)
995 << "\n\\use_amsmath " << use_amsmath
996 << "\n\\use_esint " << use_esint
997 << "\n\\use_mhchem " << use_mhchem
998 << "\n\\use_mathdots " << use_mathdots
999 << "\n\\use_undertilde " << use_undertilde
1000 << "\n\\cite_engine " << citeenginetranslator().find(cite_engine_)
1001 << "\n\\use_bibtopic " << convert<string>(use_bibtopic)
1002 << "\n\\use_indices " << convert<string>(use_indices)
1003 << "\n\\paperorientation " << string_orientation[orientation]
1004 << "\n\\suppress_date " << convert<string>(suppress_date)
1005 << "\n\\use_refstyle " << use_refstyle
1007 if (isbackgroundcolor == true)
1008 os << "\\backgroundcolor " << lyx::X11hexname(backgroundcolor) << '\n';
1009 if (isfontcolor == true)
1010 os << "\\fontcolor " << lyx::X11hexname(fontcolor) << '\n';
1011 if (notefontcolor != lyx::rgbFromHexName("#cccccc"))
1012 os << "\\notefontcolor " << lyx::X11hexname(notefontcolor) << '\n';
1013 if (boxbgcolor != lyx::rgbFromHexName("#ff0000"))
1014 os << "\\boxbgcolor " << lyx::X11hexname(boxbgcolor) << '\n';
1016 BranchList::const_iterator it = branchlist().begin();
1017 BranchList::const_iterator end = branchlist().end();
1018 for (; it != end; ++it) {
1019 os << "\\branch " << to_utf8(it->branch())
1020 << "\n\\selected " << it->isSelected()
1021 << "\n\\filename_suffix " << it->hasFileNameSuffix()
1022 << "\n\\color " << lyx::X11hexname(it->color())
1027 IndicesList::const_iterator iit = indiceslist().begin();
1028 IndicesList::const_iterator iend = indiceslist().end();
1029 for (; iit != iend; ++iit) {
1030 os << "\\index " << to_utf8(iit->index())
1031 << "\n\\shortcut " << to_utf8(iit->shortcut())
1032 << "\n\\color " << lyx::X11hexname(iit->color())
1037 if (!paperwidth.empty())
1038 os << "\\paperwidth "
1039 << VSpace(paperwidth).asLyXCommand() << '\n';
1040 if (!paperheight.empty())
1041 os << "\\paperheight "
1042 << VSpace(paperheight).asLyXCommand() << '\n';
1043 if (!leftmargin.empty())
1044 os << "\\leftmargin "
1045 << VSpace(leftmargin).asLyXCommand() << '\n';
1046 if (!topmargin.empty())
1047 os << "\\topmargin "
1048 << VSpace(topmargin).asLyXCommand() << '\n';
1049 if (!rightmargin.empty())
1050 os << "\\rightmargin "
1051 << VSpace(rightmargin).asLyXCommand() << '\n';
1052 if (!bottommargin.empty())
1053 os << "\\bottommargin "
1054 << VSpace(bottommargin).asLyXCommand() << '\n';
1055 if (!headheight.empty())
1056 os << "\\headheight "
1057 << VSpace(headheight).asLyXCommand() << '\n';
1058 if (!headsep.empty())
1060 << VSpace(headsep).asLyXCommand() << '\n';
1061 if (!footskip.empty())
1063 << VSpace(footskip).asLyXCommand() << '\n';
1064 if (!columnsep.empty())
1065 os << "\\columnsep "
1066 << VSpace(columnsep).asLyXCommand() << '\n';
1067 os << "\\secnumdepth " << secnumdepth
1068 << "\n\\tocdepth " << tocdepth
1069 << "\n\\paragraph_separation "
1070 << string_paragraph_separation[paragraph_separation];
1071 if (!paragraph_separation)
1072 os << "\n\\paragraph_indentation " << getIndentation().asLyXCommand();
1074 os << "\n\\defskip " << getDefSkip().asLyXCommand();
1075 os << "\n\\quotes_language "
1076 << string_quotes_language[quotes_language]
1077 << "\n\\papercolumns " << columns
1078 << "\n\\papersides " << sides
1079 << "\n\\paperpagestyle " << pagestyle << '\n';
1080 if (!listings_params.empty())
1081 os << "\\listings_params \"" <<
1082 InsetListingsParams(listings_params).encodedString() << "\"\n";
1083 for (int i = 0; i < 4; ++i) {
1084 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1085 if (user_defined_bullet(i).getFont() != -1) {
1086 os << "\\bullet " << i << " "
1087 << user_defined_bullet(i).getFont() << " "
1088 << user_defined_bullet(i).getCharacter() << " "
1089 << user_defined_bullet(i).getSize() << "\n";
1093 os << "\\bulletLaTeX " << i << " \""
1094 << lyx::to_ascii(user_defined_bullet(i).getText())
1100 os << "\\tracking_changes " << convert<string>(trackChanges) << '\n'
1101 << "\\output_changes " << convert<string>(outputChanges) << '\n'
1102 << "\\html_math_output " << html_math_output << '\n'
1103 << "\\html_css_as_file " << html_css_as_file << '\n'
1104 << "\\html_be_strict " << convert<string>(html_be_strict) << '\n';
1106 if (html_math_img_scale != 1.0)
1107 os << "\\html_math_img_scale " << convert<string>(html_math_img_scale) << '\n';
1108 if (!html_latex_start.empty())
1109 os << "\\html_latex_start " << html_latex_start << '\n';
1110 if (!html_latex_end.empty())
1111 os << "\\html_latex_end " << html_latex_end << '\n';
1113 os << pimpl_->authorlist;
1117 void BufferParams::validate(LaTeXFeatures & features) const
1119 features.require(documentClass().requires());
1121 if (outputChanges) {
1122 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1123 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1124 LaTeXFeatures::isAvailable("xcolor");
1126 switch (features.runparams().flavor) {
1127 case OutputParams::LATEX:
1128 case OutputParams::DVILUATEX:
1130 features.require("ct-dvipost");
1131 features.require("dvipost");
1132 } else if (xcolorulem) {
1133 features.require("ct-xcolor-ulem");
1134 features.require("ulem");
1135 features.require("xcolor");
1137 features.require("ct-none");
1140 case OutputParams::LUATEX:
1141 case OutputParams::PDFLATEX:
1142 case OutputParams::XETEX:
1144 features.require("ct-xcolor-ulem");
1145 features.require("ulem");
1146 features.require("xcolor");
1147 // improves color handling in PDF output
1148 features.require("pdfcolmk");
1150 features.require("ct-none");
1158 // Floats with 'Here definitely' as default setting.
1159 if (float_placement.find('H') != string::npos)
1160 features.require("float");
1162 // AMS Style is at document level
1163 if (use_amsmath == package_on
1164 || documentClass().provides("amsmath"))
1165 features.require("amsmath");
1166 if (use_esint == package_on)
1167 features.require("esint");
1168 if (use_mhchem == package_on)
1169 features.require("mhchem");
1170 if (use_mathdots == package_on)
1171 features.require("mathdots");
1172 if (use_undertilde == package_on)
1173 features.require("undertilde");
1175 // Document-level line spacing
1176 if (spacing().getSpace() != Spacing::Single && !spacing().isDefault())
1177 features.require("setspace");
1179 // the bullet shapes are buffer level not paragraph level
1180 // so they are tested here
1181 for (int i = 0; i < 4; ++i) {
1182 if (user_defined_bullet(i) == ITEMIZE_DEFAULTS[i])
1184 int const font = user_defined_bullet(i).getFont();
1186 int const c = user_defined_bullet(i).getCharacter();
1192 features.require("latexsym");
1194 } else if (font == 1) {
1195 features.require("amssymb");
1196 } else if (font >= 2 && font <= 5) {
1197 features.require("pifont");
1201 if (pdfoptions().use_hyperref) {
1202 features.require("hyperref");
1203 // due to interferences with babel and hyperref, the color package has to
1204 // be loaded after hyperref when hyperref is used with the colorlinks
1205 // option, see http://www.lyx.org/trac/ticket/5291
1206 if (pdfoptions().colorlinks)
1207 features.require("color");
1210 if (features.runparams().flavor == OutputParams::XETEX
1212 features.require("polyglossia");
1214 if (language->lang() == "vietnamese")
1215 features.require("vietnamese");
1216 else if (language->lang() == "japanese")
1217 features.require("japanese");
1221 bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
1222 FileName const & filepath) const
1224 // http://www.tug.org/texmf-dist/doc/latex/base/fixltx2e.pdf
1225 // !! To use the Fix-cm package, load it before \documentclass, and use the command
1226 // \RequirePackage to do so, rather than the normal \usepackage
1227 // Do not try to load any other package before the document class, unless you
1228 // have a thorough understanding of the LATEX internals and know exactly what you
1230 if (features.mustProvide("fix-cm"))
1231 os << "\\RequirePackage{fix-cm}\n";
1233 os << "\\documentclass";
1235 DocumentClass const & tclass = documentClass();
1237 ostringstream clsoptions; // the document class options.
1239 if (tokenPos(tclass.opt_fontsize(),
1240 '|', fontsize) >= 0) {
1241 // only write if existing in list (and not default)
1242 clsoptions << fontsize << "pt,";
1245 // all paper sizes except of A4, A5, B5 and the US sizes need the
1247 bool nonstandard_papersize = papersize != PAPER_DEFAULT
1248 && papersize != PAPER_USLETTER
1249 && papersize != PAPER_USLEGAL
1250 && papersize != PAPER_USEXECUTIVE
1251 && papersize != PAPER_A4
1252 && papersize != PAPER_A5
1253 && papersize != PAPER_B5;
1255 if (!use_geometry) {
1256 switch (papersize) {
1258 clsoptions << "a4paper,";
1260 case PAPER_USLETTER:
1261 clsoptions << "letterpaper,";
1264 clsoptions << "a5paper,";
1267 clsoptions << "b5paper,";
1269 case PAPER_USEXECUTIVE:
1270 clsoptions << "executivepaper,";
1273 clsoptions << "legalpaper,";
1307 if (sides != tclass.sides()) {
1310 clsoptions << "oneside,";
1313 clsoptions << "twoside,";
1319 if (columns != tclass.columns()) {
1321 clsoptions << "twocolumn,";
1323 clsoptions << "onecolumn,";
1327 && orientation == ORIENTATION_LANDSCAPE)
1328 clsoptions << "landscape,";
1330 // language should be a parameter to \documentclass
1331 if (language->babel() == "hebrew"
1332 && default_language->babel() != "hebrew")
1333 // This seems necessary
1334 features.useLanguage(default_language);
1336 ostringstream language_options;
1337 bool const use_babel = features.useBabel() && !tclass.provides("babel");
1338 bool const use_polyglossia = features.usePolyglossia();
1339 bool const global = lyxrc.language_global_options;
1340 if (use_babel || (use_polyglossia && global)) {
1341 language_options << features.getLanguages();
1342 if (!language->babel().empty()) {
1343 if (!language_options.str().empty())
1344 language_options << ',';
1345 language_options << language->babel();
1347 if (global && !features.needBabelLangOptions())
1348 clsoptions << language_options.str() << ',';
1351 // the predefined options from the layout
1352 if (use_default_options && !tclass.options().empty())
1353 clsoptions << tclass.options() << ',';
1355 // the user-defined options
1356 if (!options.empty()) {
1357 clsoptions << options << ',';
1360 string strOptions(clsoptions.str());
1361 if (!strOptions.empty()) {
1362 strOptions = rtrim(strOptions, ",");
1364 os << '[' << from_utf8(strOptions) << ']';
1367 os << '{' << from_ascii(tclass.latexname()) << "}\n";
1368 // end of \documentclass defs
1370 // if we use fontspec, we have to load the AMS packages here
1371 string const ams = features.loadAMSPackages();
1372 if (useNonTeXFonts && !ams.empty())
1373 os << from_ascii(ams);
1376 os << "\\usepackage{fontspec}\n";
1378 // font selection must be done before loading fontenc.sty
1379 string const fonts =
1380 loadFonts(fonts_roman, fonts_sans, fonts_typewriter,
1381 fonts_expert_sc, fonts_old_figures,
1382 fonts_sans_scale, fonts_typewriter_scale,
1383 useNonTeXFonts, features);
1385 os << from_utf8(fonts);
1387 if (fonts_default_family != "default")
1388 os << "\\renewcommand{\\familydefault}{\\"
1389 << from_ascii(fonts_default_family) << "}\n";
1391 // set font encoding
1392 // for arabic_arabi and farsi we also need to load the LAE and
1394 // XeTeX and LuaTeX (with OS fonts) work without fontenc
1395 if (font_encoding() != "default" && language->lang() != "japanese"
1396 && !useNonTeXFonts && !tclass.provides("fontenc")) {
1397 size_t fars = language_options.str().find("farsi");
1398 size_t arab = language_options.str().find("arabic");
1399 if (language->lang() == "arabic_arabi"
1400 || language->lang() == "farsi" || fars != string::npos
1401 || arab != string::npos) {
1402 os << "\\usepackage[" << from_ascii(font_encoding())
1403 << ",LFE,LAE]{fontenc}\n";
1405 os << "\\usepackage[" << from_ascii(font_encoding())
1410 // handle inputenc etc.
1411 writeEncodingPreamble(os, features);
1414 if (!features.runparams().includeall && !included_children_.empty()) {
1415 os << "\\includeonly{";
1416 list<string>::const_iterator it = included_children_.begin();
1417 list<string>::const_iterator en = included_children_.end();
1419 for (; it != en; ++it) {
1420 string incfile = *it;
1421 FileName inc = makeAbsPath(incfile, filepath.absFileName());
1422 string mangled = DocFileName(changeExtension(inc.absFileName(), ".tex")).
1424 if (!features.runparams().nice)
1426 // \includeonly doesn't want an extension
1427 incfile = changeExtension(incfile, string());
1428 incfile = support::latex_path(incfile);
1429 if (!incfile.empty()) {
1432 os << from_utf8(incfile);
1439 if (!listings_params.empty() || features.isRequired("listings"))
1440 os << "\\usepackage{listings}\n";
1442 if (!listings_params.empty()) {
1444 // do not test validity because listings_params is
1445 // supposed to be valid
1447 InsetListingsParams(listings_params).separatedParams(true);
1448 // we can't support all packages, but we should load the color package
1449 if (par.find("\\color", 0) != string::npos)
1450 features.require("color");
1451 os << from_utf8(par)
1454 if (!tclass.provides("geometry")
1455 && (use_geometry || nonstandard_papersize)) {
1456 odocstringstream ods;
1457 if (!getGraphicsDriver("geometry").empty())
1458 ods << getGraphicsDriver("geometry");
1459 if (orientation == ORIENTATION_LANDSCAPE)
1460 ods << ",landscape";
1461 switch (papersize) {
1463 if (!paperwidth.empty())
1464 ods << ",paperwidth="
1465 << from_ascii(paperwidth);
1466 if (!paperheight.empty())
1467 ods << ",paperheight="
1468 << from_ascii(paperheight);
1470 case PAPER_USLETTER:
1471 ods << ",letterpaper";
1474 ods << ",legalpaper";
1476 case PAPER_USEXECUTIVE:
1477 ods << ",executivepaper";
1566 docstring const g_options = trim(ods.str(), ",");
1567 os << "\\usepackage";
1568 if (!g_options.empty())
1569 os << '[' << g_options << ']';
1570 os << "{geometry}\n";
1571 // output this only if use_geometry is true
1573 os << "\\geometry{verbose";
1574 if (!topmargin.empty())
1575 os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1576 if (!bottommargin.empty())
1577 os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1578 if (!leftmargin.empty())
1579 os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1580 if (!rightmargin.empty())
1581 os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1582 if (!headheight.empty())
1583 os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1584 if (!headsep.empty())
1585 os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1586 if (!footskip.empty())
1587 os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1588 if (!columnsep.empty())
1589 os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
1592 } else if (orientation == ORIENTATION_LANDSCAPE
1593 || papersize != PAPER_DEFAULT) {
1594 features.require("papersize");
1597 if (tokenPos(tclass.opt_pagestyle(), '|', pagestyle) >= 0) {
1598 if (pagestyle == "fancy")
1599 os << "\\usepackage{fancyhdr}\n";
1600 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1603 // only output when the background color is not default
1604 if (isbackgroundcolor == true) {
1605 // only require color here, the background color will be defined
1606 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1608 features.require("color");
1609 features.require("pagecolor");
1612 // only output when the font color is not default
1613 if (isfontcolor == true) {
1614 // only require color here, the font color will be defined
1615 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1617 features.require("color");
1618 features.require("fontcolor");
1621 // Only if class has a ToC hierarchy
1622 if (tclass.hasTocLevels()) {
1623 if (secnumdepth != tclass.secnumdepth()) {
1624 os << "\\setcounter{secnumdepth}{"
1628 if (tocdepth != tclass.tocdepth()) {
1629 os << "\\setcounter{tocdepth}{"
1635 if (paragraph_separation) {
1636 // when skip separation
1637 switch (getDefSkip().kind()) {
1638 case VSpace::SMALLSKIP:
1639 os << "\\setlength{\\parskip}{\\smallskipamount}\n";
1641 case VSpace::MEDSKIP:
1642 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1644 case VSpace::BIGSKIP:
1645 os << "\\setlength{\\parskip}{\\bigskipamount}\n";
1647 case VSpace::LENGTH:
1648 os << "\\setlength{\\parskip}{"
1649 << from_utf8(getDefSkip().length().asLatexString())
1652 default: // should never happen // Then delete it.
1653 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1656 os << "\\setlength{\\parindent}{0pt}\n";
1658 // when separation by indentation
1659 // only output something when a width is given
1660 if (getIndentation().asLyXCommand() != "default") {
1661 os << "\\setlength{\\parindent}{"
1662 << from_utf8(getIndentation().asLatexCommand())
1667 // Now insert the LyX specific LaTeX commands...
1668 docstring lyxpreamble;
1669 features.resolveAlternatives();
1672 if (!output_sync_macro.empty())
1673 lyxpreamble += from_utf8(output_sync_macro) +"\n";
1674 else if (features.runparams().flavor == OutputParams::LATEX)
1675 lyxpreamble += "\\usepackage[active]{srcltx}\n";
1676 else if (features.runparams().flavor == OutputParams::PDFLATEX)
1677 lyxpreamble += "\\synctex=-1\n";
1680 // due to interferences with babel and hyperref, the color package has to
1681 // be loaded (when it is not already loaded) before babel when hyperref
1682 // is used with the colorlinks option, see
1683 // http://www.lyx.org/trac/ticket/5291
1684 // we decided therefore to load color always before babel, see
1685 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
1686 lyxpreamble += from_ascii(features.getColorOptions());
1688 // If we use hyperref, jurabib, japanese, or vietnamese, we have to call babel before them.
1690 && (features.isRequired("jurabib")
1691 || features.isRequired("hyperref")
1692 || features.isRequired("vietnamese")
1693 || features.isRequired("japanese"))) {
1695 lyxpreamble += from_utf8(features.getBabelPresettings());
1696 lyxpreamble += from_utf8(babelCall(language_options.str(),
1697 features.needBabelLangOptions())) + '\n';
1698 lyxpreamble += from_utf8(features.getBabelPostsettings());
1701 // The optional packages;
1702 lyxpreamble += from_ascii(features.getPackages());
1704 // Additional Indices
1705 if (features.isRequired("splitidx")) {
1706 IndicesList::const_iterator iit = indiceslist().begin();
1707 IndicesList::const_iterator iend = indiceslist().end();
1708 for (; iit != iend; ++iit) {
1709 lyxpreamble += "\\newindex[";
1710 lyxpreamble += iit->index();
1711 lyxpreamble += "]{";
1712 lyxpreamble += iit->shortcut();
1713 lyxpreamble += "}\n";
1718 lyxpreamble += from_utf8(spacing().writePreamble(tclass.provides("SetSpace")));
1721 // * Hyperref manual: "Make sure it comes last of your loaded
1722 // packages, to give it a fighting chance of not being over-written,
1723 // since its job is to redefine many LaTeX commands."
1724 // * Email from Heiko Oberdiek: "It is usually better to load babel
1725 // before hyperref. Then hyperref has a chance to detect babel.
1726 // * Has to be loaded before the "LyX specific LaTeX commands" to
1727 // avoid errors with algorithm floats.
1728 // use hyperref explicitly if it is required
1729 if (features.isRequired("hyperref")) {
1730 // pass what we have to stream here, since we need
1731 // to access the stream itself in PDFOptions.
1734 OutputParams tmp_params = features.runparams();
1735 pdfoptions().writeLaTeX(tmp_params, os,
1736 documentClass().provides("hyperref"));
1737 // set back for the rest
1738 lyxpreamble.clear();
1739 // correctly break URLs with hyperref and dvi output
1740 if (features.runparams().flavor == OutputParams::LATEX
1741 && features.isAvailable("breakurl"))
1742 lyxpreamble += "\\usepackage{breakurl}\n";
1743 } else if (features.isRequired("nameref"))
1744 // hyperref loads this automatically
1745 lyxpreamble += "\\usepackage{nameref}\n";
1747 // Will be surrounded by \makeatletter and \makeatother when not empty
1748 docstring atlyxpreamble;
1750 // Some macros LyX will need
1751 docstring tmppreamble(features.getMacros());
1753 if (!tmppreamble.empty())
1754 atlyxpreamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1755 "LyX specific LaTeX commands.\n"
1756 + tmppreamble + '\n';
1758 // the text class specific preamble
1759 tmppreamble = features.getTClassPreamble();
1760 if (!tmppreamble.empty())
1761 atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1762 "Textclass specific LaTeX commands.\n"
1763 + tmppreamble + '\n';
1765 // suppress date if selected
1766 // use \@ifundefined because we cannot be sure that every document class
1767 // has a \date command
1769 atlyxpreamble += "\\@ifundefined{date}{}{\\date{}}\n";
1771 /* the user-defined preamble */
1772 if (!containsOnly(preamble, " \n\t"))
1774 atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1775 "User specified LaTeX commands.\n"
1776 + from_utf8(preamble) + '\n';
1778 // subfig loads internally the LaTeX package "caption". As
1779 // caption is a very popular package, users will load it in
1780 // the preamble. Therefore we must load subfig behind the
1781 // user-defined preamble and check if the caption package was
1782 // loaded or not. For the case that caption is loaded before
1783 // subfig, there is the subfig option "caption=false". This
1784 // option also works when a koma-script class is used and
1785 // koma's own caption commands are used instead of caption. We
1786 // use \PassOptionsToPackage here because the user could have
1787 // already loaded subfig in the preamble.
1788 if (features.isRequired("subfig")) {
1789 atlyxpreamble += "\\@ifundefined{showcaptionsetup}{}{%\n"
1790 " \\PassOptionsToPackage{caption=false}{subfig}}\n"
1791 "\\usepackage{subfig}\n";
1794 // Itemize bullet settings need to be last in case the user
1795 // defines their own bullets that use a package included
1796 // in the user-defined preamble -- ARRae
1797 // Actually it has to be done much later than that
1798 // since some packages like frenchb make modifications
1799 // at \begin{document} time -- JMarc
1800 docstring bullets_def;
1801 for (int i = 0; i < 4; ++i) {
1802 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1803 if (bullets_def.empty())
1804 bullets_def += "\\AtBeginDocument{\n";
1805 bullets_def += " \\def\\labelitemi";
1807 // `i' is one less than the item to modify
1814 bullets_def += "ii";
1820 bullets_def += '{' +
1821 user_defined_bullet(i).getText()
1826 if (!bullets_def.empty())
1827 atlyxpreamble += bullets_def + "}\n\n";
1829 if (!atlyxpreamble.empty())
1830 lyxpreamble += "\n\\makeatletter\n"
1831 + atlyxpreamble + "\\makeatother\n\n";
1833 // We try to load babel late, in case it interferes with other packages.
1834 // Jurabib and Hyperref have to be called after babel, though.
1835 if (use_babel && !features.isRequired("jurabib")
1836 && !features.isRequired("hyperref")
1837 && !features.isRequired("vietnamese")
1838 && !features.isRequired("japanese")) {
1840 lyxpreamble += from_utf8(features.getBabelPresettings());
1841 lyxpreamble += from_utf8(babelCall(language_options.str(),
1842 features.needBabelLangOptions())) + '\n';
1843 lyxpreamble += from_utf8(features.getBabelPostsettings());
1846 // xunicode needs to be loaded at least after amsmath, amssymb,
1847 // esint and the other packages that provide special glyphs
1848 if (features.runparams().flavor == OutputParams::XETEX)
1849 lyxpreamble += "\\usepackage{xunicode}\n";
1851 // Polyglossia must be loaded last
1852 if (use_polyglossia) {
1854 lyxpreamble += "\\usepackage{polyglossia}\n";
1855 // set the main language
1856 lyxpreamble += "\\setdefaultlanguage";
1857 if (!language->polyglossiaOpts().empty())
1858 lyxpreamble += "[" + from_ascii(language->polyglossiaOpts()) + "]";
1859 lyxpreamble += "{" + from_ascii(language->polyglossia()) + "}\n";
1860 // now setup the other languages
1861 std::map<std::string, std::string> const polylangs =
1862 features.getPolyglossiaLanguages();
1863 for (std::map<std::string, std::string>::const_iterator mit = polylangs.begin();
1864 mit != polylangs.end() ; ++mit) {
1865 lyxpreamble += "\\setotherlanguage";
1866 if (!mit->second.empty())
1867 lyxpreamble += "[" + from_ascii(mit->second) + "]";
1868 lyxpreamble += "{" + from_ascii(mit->first) + "}\n";
1872 docstring const i18npreamble =
1873 features.getTClassI18nPreamble(use_babel, use_polyglossia);
1874 if (!i18npreamble.empty())
1875 lyxpreamble += i18npreamble + '\n';
1883 void BufferParams::useClassDefaults()
1885 DocumentClass const & tclass = documentClass();
1887 sides = tclass.sides();
1888 columns = tclass.columns();
1889 pagestyle = tclass.pagestyle();
1890 use_default_options = true;
1891 // Only if class has a ToC hierarchy
1892 if (tclass.hasTocLevels()) {
1893 secnumdepth = tclass.secnumdepth();
1894 tocdepth = tclass.tocdepth();
1899 bool BufferParams::hasClassDefaults() const
1901 DocumentClass const & tclass = documentClass();
1903 return sides == tclass.sides()
1904 && columns == tclass.columns()
1905 && pagestyle == tclass.pagestyle()
1906 && use_default_options
1907 && secnumdepth == tclass.secnumdepth()
1908 && tocdepth == tclass.tocdepth();
1912 DocumentClass const & BufferParams::documentClass() const
1918 DocumentClass const * BufferParams::documentClassPtr() const
1924 void BufferParams::setDocumentClass(DocumentClass const * const tc)
1926 // evil, but this function is evil
1927 doc_class_ = const_cast<DocumentClass *>(tc);
1931 bool BufferParams::setBaseClass(string const & classname)
1933 LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
1934 LayoutFileList & bcl = LayoutFileList::get();
1935 if (!bcl.haveClass(classname)) {
1937 bformat(_("The layout file:\n"
1939 "could not be found. A default textclass with default\n"
1940 "layouts will be used. LyX will not be able to produce\n"
1942 from_utf8(classname));
1943 frontend::Alert::error(_("Document class not found"), s);
1944 bcl.addEmptyClass(classname);
1947 bool const success = bcl[classname].load();
1950 bformat(_("Due to some error in it, the layout file:\n"
1952 "could not be loaded. A default textclass with default\n"
1953 "layouts will be used. LyX will not be able to produce\n"
1955 from_utf8(classname));
1956 frontend::Alert::error(_("Could not load class"), s);
1957 bcl.addEmptyClass(classname);
1960 pimpl_->baseClass_ = classname;
1961 layout_modules_.adaptToBaseClass(baseClass(), removed_modules_);
1966 LayoutFile const * BufferParams::baseClass() const
1968 if (LayoutFileList::get().haveClass(pimpl_->baseClass_))
1969 return &(LayoutFileList::get()[pimpl_->baseClass_]);
1975 LayoutFileIndex const & BufferParams::baseClassID() const
1977 return pimpl_->baseClass_;
1981 void BufferParams::makeDocumentClass()
1986 doc_class_ = &(DocumentClassBundle::get().makeDocumentClass(*baseClass(), layout_modules_));
1988 if (!local_layout.empty()) {
1989 TextClass::ReturnValues success =
1990 doc_class_->read(local_layout, TextClass::MODULE);
1991 if (success != TextClass::OK && success != TextClass::OK_OLDFORMAT) {
1992 docstring const msg = _("Error reading internal layout information");
1993 frontend::Alert::warning(_("Read Error"), msg);
1999 bool BufferParams::moduleCanBeAdded(string const & modName) const
2001 return layout_modules_.moduleCanBeAdded(modName, baseClass());
2005 bool BufferParams::addLayoutModule(string const & modName)
2007 LayoutModuleList::const_iterator it = layout_modules_.begin();
2008 LayoutModuleList::const_iterator end = layout_modules_.end();
2009 for (; it != end; it++)
2012 layout_modules_.push_back(modName);
2017 string BufferParams::bufferFormat() const
2019 string format = documentClass().outputFormat();
2020 if (format == "latex") {
2023 if (encoding().package() == Encoding::japanese)
2030 bool BufferParams::isExportable(string const & format) const
2032 vector<string> backs = backends();
2033 for (vector<string>::const_iterator it = backs.begin();
2034 it != backs.end(); ++it)
2035 if (theConverters().isReachable(*it, format))
2041 vector<Format const *> BufferParams::exportableFormats(bool only_viewable) const
2043 vector<string> const backs = backends();
2044 set<string> excludes;
2045 if (useNonTeXFonts) {
2046 excludes.insert("latex");
2047 excludes.insert("pdflatex");
2049 vector<Format const *> result =
2050 theConverters().getReachable(backs[0], only_viewable, true, excludes);
2051 for (vector<string>::const_iterator it = backs.begin() + 1;
2052 it != backs.end(); ++it) {
2053 vector<Format const *> r =
2054 theConverters().getReachable(*it, only_viewable, false, excludes);
2055 result.insert(result.end(), r.begin(), r.end());
2061 bool BufferParams::isExportableFormat(string const & format) const
2063 typedef vector<Format const *> Formats;
2065 formats = exportableFormats(true);
2066 Formats::const_iterator fit = formats.begin();
2067 Formats::const_iterator end = formats.end();
2068 for (; fit != end ; ++fit) {
2069 if ((*fit)->name() == format)
2076 vector<string> BufferParams::backends() const
2079 v.push_back(bufferFormat());
2080 // FIXME: Don't hardcode format names here, but use a flag
2081 if (v.back() == "latex") {
2082 v.push_back("pdflatex");
2083 v.push_back("luatex");
2084 v.push_back("dviluatex");
2085 v.push_back("xetex");
2086 } else if (v.back() == "xetex") {
2087 v.push_back("luatex");
2088 v.push_back("dviluatex");
2090 v.push_back("xhtml");
2091 v.push_back("text");
2097 OutputParams::FLAVOR BufferParams::getOutputFlavor(string const format) const
2099 string const dformat = (format.empty() || format == "default") ?
2100 getDefaultOutputFormat() : format;
2101 DefaultFlavorCache::const_iterator it =
2102 default_flavors_.find(dformat);
2104 if (it != default_flavors_.end())
2107 OutputParams::FLAVOR result = OutputParams::LATEX;
2109 if (dformat == "xhtml")
2110 result = OutputParams::HTML;
2112 // Try to determine flavor of default output format
2113 vector<string> backs = backends();
2114 if (find(backs.begin(), backs.end(), dformat) == backs.end()) {
2115 // Get shortest path to format
2116 Graph::EdgePath path;
2117 for (vector<string>::const_iterator it = backs.begin();
2118 it != backs.end(); ++it) {
2119 Graph::EdgePath p = theConverters().getPath(*it, dformat);
2120 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2125 result = theConverters().getFlavor(path);
2128 // cache this flavor
2129 default_flavors_[dformat] = result;
2134 string BufferParams::getDefaultOutputFormat() const
2136 if (!default_output_format.empty()
2137 && default_output_format != "default")
2138 return default_output_format;
2141 || encoding().package() == Encoding::japanese) {
2142 vector<Format const *> const formats = exportableFormats(true);
2143 if (formats.empty())
2145 // return the first we find
2146 return formats.front()->name();
2148 return lyxrc.default_view_format;
2151 Font const BufferParams::getFont() const
2153 FontInfo f = documentClass().defaultfont();
2154 if (fonts_default_family == "rmdefault")
2155 f.setFamily(ROMAN_FAMILY);
2156 else if (fonts_default_family == "sfdefault")
2157 f.setFamily(SANS_FAMILY);
2158 else if (fonts_default_family == "ttdefault")
2159 f.setFamily(TYPEWRITER_FAMILY);
2160 return Font(f, language);
2164 bool BufferParams::isLatex() const
2166 return documentClass().outputType() == LATEX;
2170 bool BufferParams::isLiterate() const
2172 return documentClass().outputType() == LITERATE;
2176 bool BufferParams::isDocBook() const
2178 return documentClass().outputType() == DOCBOOK;
2182 void BufferParams::readPreamble(Lexer & lex)
2184 if (lex.getString() != "\\begin_preamble")
2185 lyxerr << "Error (BufferParams::readPreamble):"
2186 "consistency check failed." << endl;
2188 preamble = lex.getLongString("\\end_preamble");
2192 void BufferParams::readLocalLayout(Lexer & lex)
2194 if (lex.getString() != "\\begin_local_layout")
2195 lyxerr << "Error (BufferParams::readLocalLayout):"
2196 "consistency check failed." << endl;
2198 local_layout = lex.getLongString("\\end_local_layout");
2202 bool BufferParams::setLanguage(string const & lang)
2204 Language const *new_language = languages.getLanguage(lang);
2205 if (!new_language) {
2206 // Language lang was not found
2209 language = new_language;
2214 void BufferParams::readLanguage(Lexer & lex)
2216 if (!lex.next()) return;
2218 string const tmptok = lex.getString();
2220 // check if tmptok is part of tex_babel in tex-defs.h
2221 if (!setLanguage(tmptok)) {
2222 // Language tmptok was not found
2223 language = default_language;
2224 lyxerr << "Warning: Setting language `"
2225 << tmptok << "' to `" << language->lang()
2231 void BufferParams::readGraphicsDriver(Lexer & lex)
2236 string const tmptok = lex.getString();
2237 // check if tmptok is part of tex_graphics in tex_defs.h
2240 string const test = tex_graphics[n++];
2242 if (test == tmptok) {
2243 graphics_driver = tmptok;
2248 "Warning: graphics driver `$$Token' not recognized!\n"
2249 " Setting graphics driver to `default'.\n");
2250 graphics_driver = "default";
2257 void BufferParams::readBullets(Lexer & lex)
2262 int const index = lex.getInteger();
2264 int temp_int = lex.getInteger();
2265 user_defined_bullet(index).setFont(temp_int);
2266 temp_bullet(index).setFont(temp_int);
2268 user_defined_bullet(index).setCharacter(temp_int);
2269 temp_bullet(index).setCharacter(temp_int);
2271 user_defined_bullet(index).setSize(temp_int);
2272 temp_bullet(index).setSize(temp_int);
2276 void BufferParams::readBulletsLaTeX(Lexer & lex)
2278 // The bullet class should be able to read this.
2281 int const index = lex.getInteger();
2283 docstring const temp_str = lex.getDocString();
2285 user_defined_bullet(index).setText(temp_str);
2286 temp_bullet(index).setText(temp_str);
2290 void BufferParams::readModules(Lexer & lex)
2292 if (!lex.eatLine()) {
2293 lyxerr << "Error (BufferParams::readModules):"
2294 "Unexpected end of input." << endl;
2298 string mod = lex.getString();
2299 if (mod == "\\end_modules")
2301 addLayoutModule(mod);
2307 void BufferParams::readRemovedModules(Lexer & lex)
2309 if (!lex.eatLine()) {
2310 lyxerr << "Error (BufferParams::readRemovedModules):"
2311 "Unexpected end of input." << endl;
2315 string mod = lex.getString();
2316 if (mod == "\\end_removed_modules")
2318 removed_modules_.push_back(mod);
2321 // now we want to remove any removed modules that were previously
2322 // added. normally, that will be because default modules were added in
2323 // setBaseClass(), which gets called when \textclass is read at the
2324 // start of the read.
2325 list<string>::const_iterator rit = removed_modules_.begin();
2326 list<string>::const_iterator const ren = removed_modules_.end();
2327 for (; rit != ren; rit++) {
2328 LayoutModuleList::iterator const mit = layout_modules_.begin();
2329 LayoutModuleList::iterator const men = layout_modules_.end();
2330 LayoutModuleList::iterator found = find(mit, men, *rit);
2333 layout_modules_.erase(found);
2338 void BufferParams::readIncludeonly(Lexer & lex)
2340 if (!lex.eatLine()) {
2341 lyxerr << "Error (BufferParams::readIncludeonly):"
2342 "Unexpected end of input." << endl;
2346 string child = lex.getString();
2347 if (child == "\\end_includeonly")
2349 included_children_.push_back(child);
2355 string BufferParams::paperSizeName(PapersizePurpose purpose) const
2357 switch (papersize) {
2359 // could be anything, so don't guess
2361 case PAPER_CUSTOM: {
2362 if (purpose == XDVI && !paperwidth.empty() &&
2363 !paperheight.empty()) {
2364 // heightxwidth<unit>
2365 string first = paperwidth;
2366 string second = paperheight;
2367 if (orientation == ORIENTATION_LANDSCAPE)
2370 return first.erase(first.length() - 2)
2376 // dvips and dvipdfm do not know this
2377 if (purpose == DVIPS || purpose == DVIPDFM)
2381 if (purpose == DVIPS || purpose == DVIPDFM)
2385 if (purpose == DVIPS || purpose == DVIPDFM)
2395 if (purpose == DVIPS || purpose == DVIPDFM)
2399 if (purpose == DVIPS || purpose == DVIPDFM)
2403 if (purpose == DVIPS || purpose == DVIPDFM)
2407 if (purpose == DVIPS || purpose == DVIPDFM)
2411 if (purpose == DVIPS || purpose == DVIPDFM)
2415 // dvipdfm does not know this
2416 if (purpose == DVIPDFM)
2420 if (purpose == DVIPDFM)
2424 if (purpose == DVIPS || purpose == DVIPDFM)
2428 if (purpose == DVIPS || purpose == DVIPDFM)
2432 if (purpose == DVIPS || purpose == DVIPDFM)
2436 if (purpose == DVIPS || purpose == DVIPDFM)
2440 if (purpose == DVIPS || purpose == DVIPDFM)
2444 if (purpose == DVIPS || purpose == DVIPDFM)
2448 if (purpose == DVIPS || purpose == DVIPDFM)
2452 if (purpose == DVIPS || purpose == DVIPDFM)
2456 if (purpose == DVIPS || purpose == DVIPDFM)
2460 if (purpose == DVIPS || purpose == DVIPDFM)
2464 if (purpose == DVIPS || purpose == DVIPDFM)
2468 if (purpose == DVIPS || purpose == DVIPDFM)
2472 if (purpose == DVIPS || purpose == DVIPDFM)
2476 if (purpose == DVIPS || purpose == DVIPDFM)
2480 if (purpose == DVIPS || purpose == DVIPDFM)
2483 case PAPER_USEXECUTIVE:
2484 // dvipdfm does not know this
2485 if (purpose == DVIPDFM)
2490 case PAPER_USLETTER:
2492 if (purpose == XDVI)
2499 string const BufferParams::dvips_options() const
2504 && papersize == PAPER_CUSTOM
2505 && !lyxrc.print_paper_dimension_flag.empty()
2506 && !paperwidth.empty()
2507 && !paperheight.empty()) {
2508 // using a custom papersize
2509 result = lyxrc.print_paper_dimension_flag;
2510 result += ' ' + paperwidth;
2511 result += ',' + paperheight;
2513 string const paper_option = paperSizeName(DVIPS);
2514 if (!paper_option.empty() && (paper_option != "letter" ||
2515 orientation != ORIENTATION_LANDSCAPE)) {
2516 // dvips won't accept -t letter -t landscape.
2517 // In all other cases, include the paper size
2519 result = lyxrc.print_paper_flag;
2520 result += ' ' + paper_option;
2523 if (orientation == ORIENTATION_LANDSCAPE &&
2524 papersize != PAPER_CUSTOM)
2525 result += ' ' + lyxrc.print_landscape_flag;
2530 string const BufferParams::font_encoding() const
2532 return (fontenc == "global") ? lyxrc.fontenc : fontenc;
2536 string BufferParams::babelCall(string const & lang_opts, bool const langoptions) const
2538 if (lang_package != "auto" && lang_package != "babel"
2539 && lang_package != "default" && lang_package != "none")
2540 return lang_package;
2541 if (lyxrc.language_package_selection == LyXRC::LP_CUSTOM)
2542 return lyxrc.language_custom_package;
2543 // suppress the babel call if there is no BabelName defined
2544 // for the document language in the lib/languages file and if no
2545 // other languages are used (lang_opts is then empty)
2546 if (lang_opts.empty())
2548 // either a specific language (AsBabelOptions setting in
2549 // lib/languages) or the prefs require the languages to
2550 // be submitted to babel itself (not the class).
2552 return "\\usepackage[" + lang_opts + "]{babel}";
2553 return "\\usepackage{babel}";
2557 docstring BufferParams::getGraphicsDriver(string const & package) const
2561 if (package == "geometry") {
2562 if (graphics_driver == "dvips"
2563 || graphics_driver == "dvipdfm"
2564 || graphics_driver == "pdftex"
2565 || graphics_driver == "vtex")
2566 result = from_ascii(graphics_driver);
2567 else if (graphics_driver == "dvipdfmx")
2568 result = from_ascii("dvipdfm");
2575 void BufferParams::writeEncodingPreamble(otexstream & os,
2576 LaTeXFeatures & features) const
2578 // XeTeX does not need this
2579 if (features.runparams().flavor == OutputParams::XETEX)
2581 // LuaTeX neither, but with tex fonts, we need to load
2582 // the luainputenc package.
2583 if (features.runparams().flavor == OutputParams::LUATEX
2584 || features.runparams().flavor == OutputParams::DVILUATEX) {
2585 if (!useNonTeXFonts && inputenc != "default"
2586 && ((inputenc == "auto" && language->encoding()->package() == Encoding::inputenc)
2587 || (inputenc != "auto" && encoding().package() == Encoding::inputenc))) {
2588 os << "\\usepackage[utf8]{luainputenc}\n";
2592 if (inputenc == "auto") {
2593 string const doc_encoding =
2594 language->encoding()->latexName();
2595 Encoding::Package const package =
2596 language->encoding()->package();
2598 // Create a list with all the input encodings used
2600 set<string> encodings =
2601 features.getEncodingSet(doc_encoding);
2603 // If the "japanese" package (i.e. pLaTeX) is used,
2604 // inputenc must be omitted.
2605 // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
2606 if (package == Encoding::japanese)
2607 features.require("japanese");
2609 if ((!encodings.empty() || package == Encoding::inputenc)
2610 && !features.isRequired("japanese")) {
2611 os << "\\usepackage[";
2612 set<string>::const_iterator it = encodings.begin();
2613 set<string>::const_iterator const end = encodings.end();
2615 os << from_ascii(*it);
2618 for (; it != end; ++it)
2619 os << ',' << from_ascii(*it);
2620 if (package == Encoding::inputenc) {
2621 if (!encodings.empty())
2623 os << from_ascii(doc_encoding);
2625 os << "]{inputenc}\n";
2627 if (package == Encoding::CJK || features.mustProvide("CJK")) {
2628 if (language->encoding()->name() == "utf8-cjk"
2629 && LaTeXFeatures::isAvailable("CJKutf8"))
2630 os << "\\usepackage{CJKutf8}\n";
2632 os << "\\usepackage{CJK}\n";
2634 } else if (inputenc != "default") {
2635 switch (encoding().package()) {
2636 case Encoding::none:
2637 case Encoding::japanese:
2639 case Encoding::inputenc:
2640 // do not load inputenc if japanese is used
2641 if (features.isRequired("japanese"))
2643 os << "\\usepackage[" << from_ascii(inputenc)
2647 if (encoding().name() == "utf8-cjk"
2648 && LaTeXFeatures::isAvailable("CJKutf8"))
2649 os << "\\usepackage{CJKutf8}\n";
2651 os << "\\usepackage{CJK}\n";
2656 // The encoding "armscii8" (for Armenian) is only available when
2657 // the package "armtex" is loaded.
2658 if (language->encoding()->latexName() == "armscii8"
2659 || inputenc == "armscii8")
2660 os << "\\usepackage{armtex}\n";
2664 string const BufferParams::parseFontName(string const & name) const
2666 string mangled = name;
2667 size_t const idx = mangled.find('[');
2668 if (idx == string::npos || idx == 0)
2671 return mangled.substr(0, idx - 1);
2675 string const BufferParams::loadFonts(string const & rm,
2676 string const & sf, string const & tt,
2677 bool const & sc, bool const & osf,
2678 int const & sfscale, int const & ttscale,
2679 bool const & use_systemfonts,
2680 LaTeXFeatures & features) const
2682 /* The LaTeX font world is in a flux. In the PSNFSS font interface,
2683 several packages have been replaced by others, that might not
2684 be installed on every system. We have to take care for that
2685 (see psnfss.pdf). We try to support all psnfss fonts as well
2686 as the fonts that have become de facto standard in the LaTeX
2687 world (e.g. Latin Modern). We do not support obsolete fonts
2688 (like PSLatex). In general, it should be possible to mix any
2689 rm font with any sf or tt font, respectively. (JSpitzm)
2691 -- separate math fonts.
2694 if (rm == "default" && sf == "default" && tt == "default")
2700 /* Fontspec (XeTeX, LuaTeX): we provide GUI support for oldstyle
2701 * numbers (Numbers=OldStyle) and sf/tt scaling. The Ligatures=TeX/
2702 * Mapping=tex-text option assures TeX ligatures (such as "--")
2703 * are resolved. Note that tt does not use these ligatures.
2705 * -- add more GUI options?
2706 * -- add more fonts (fonts for other scripts)
2707 * -- if there's a way to find out if a font really supports
2708 * OldStyle, enable/disable the widget accordingly.
2710 if (use_systemfonts && features.isAvailable("fontspec")) {
2711 // "Mapping=tex-text" and "Ligatures=TeX" are equivalent.
2712 // However, until v.2 (2010/07/11) fontspec only knew
2713 // Mapping=tex-text (for XeTeX only); then "Ligatures=TeX"
2714 // was introduced for both XeTeX and LuaTeX (LuaTeX
2715 // didn't understand "Mapping=tex-text", while XeTeX
2716 // understood both. With most recent versions, both
2717 // variants are understood by both engines. However,
2718 // we want to provide support for at least TeXLive 2009
2719 // (for XeTeX; LuaTeX is only supported as of v.2)
2720 string const texmapping =
2721 (features.runparams().flavor == OutputParams::XETEX) ?
2722 "Mapping=tex-text" : "Ligatures=TeX";
2723 if (rm != "default") {
2724 os << "\\setmainfont[" << texmapping;
2726 os << ",Numbers=OldStyle";
2727 os << "]{" << parseFontName(rm) << "}\n";
2729 if (sf != "default") {
2730 string const sans = parseFontName(sf);
2732 os << "\\setsansfont[Scale="
2733 << float(sfscale) / 100
2734 << "," << texmapping << "]{"
2737 os << "\\setsansfont[" << texmapping << "]{"
2740 if (tt != "default") {
2741 string const mono = parseFontName(tt);
2743 os << "\\setmonofont[Scale="
2744 << float(ttscale) / 100
2748 os << "\\setmonofont{"
2755 // Computer Modern (must be explicitly selectable -- there might be classes
2756 // that define a different default font!
2758 os << "\\renewcommand{\\rmdefault}{cmr}\n";
2759 // osf for Computer Modern needs eco.sty
2761 os << "\\usepackage{eco}\n";
2763 // Latin Modern Roman
2764 else if (rm == "lmodern")
2765 os << "\\usepackage{lmodern}\n";
2767 else if (rm == "ae") {
2768 // not needed when using OT1 font encoding.
2769 if (font_encoding() != "default")
2770 os << "\\usepackage{ae,aecompl}\n";
2773 else if (rm == "times") {
2774 // try to load the best available package
2775 if (LaTeXFeatures::isAvailable("mathptmx"))
2776 os << "\\usepackage{mathptmx}\n";
2777 else if (LaTeXFeatures::isAvailable("mathptm"))
2778 os << "\\usepackage{mathptm}\n";
2780 os << "\\usepackage{times}\n";
2783 else if (rm == "palatino") {
2784 // try to load the best available package
2785 if (LaTeXFeatures::isAvailable("mathpazo")) {
2786 os << "\\usepackage";
2792 // "osf" includes "sc"!
2796 os << "{mathpazo}\n";
2798 else if (LaTeXFeatures::isAvailable("mathpple"))
2799 os << "\\usepackage{mathpple}\n";
2801 os << "\\usepackage{palatino}\n";
2804 else if (rm == "utopia") {
2805 // fourier supersedes utopia.sty, but does
2806 // not work with OT1 encoding.
2807 if (LaTeXFeatures::isAvailable("fourier")
2808 && font_encoding() != "default") {
2809 os << "\\usepackage";
2820 os << "{fourier}\n";
2823 os << "\\usepackage{utopia}\n";
2825 // Bera (complete fontset)
2826 else if (rm == "bera" && sf == "default" && tt == "default")
2827 os << "\\usepackage{bera}\n";
2829 else if (rm != "default")
2830 os << "\\usepackage" << "{" << rm << "}\n";
2833 // Helvetica, Bera Sans
2834 if (sf == "helvet" || sf == "berasans") {
2836 os << "\\usepackage[scaled=" << float(sfscale) / 100
2837 << "]{" << sf << "}\n";
2839 os << "\\usepackage{" << sf << "}\n";
2842 else if (sf == "avant")
2843 os << "\\usepackage{" << sf << "}\n";
2844 // Computer Modern, Latin Modern, CM Bright
2845 else if (sf != "default")
2846 os << "\\renewcommand{\\sfdefault}{" << sf << "}\n";
2848 // monospaced/typewriter
2849 // Courier, LuxiMono
2850 if (tt == "luximono" || tt == "beramono") {
2852 os << "\\usepackage[scaled=" << float(ttscale) / 100
2853 << "]{" << tt << "}\n";
2855 os << "\\usepackage{" << tt << "}\n";
2858 else if (tt == "courier" )
2859 os << "\\usepackage{" << tt << "}\n";
2860 // Computer Modern, Latin Modern, CM Bright
2861 else if (tt != "default")
2862 os << "\\renewcommand{\\ttdefault}{" << tt << "}\n";
2868 Encoding const & BufferParams::encoding() const
2870 // FIXME: actually, we should check for the flavor
2871 // or runparams.isFullyUnicode() here:
2872 // This check will not work with XeTeX/LuaTeX and tex fonts.
2873 // Thus we have to reset the encoding in Buffer::makeLaTeXFile.
2875 return *(encodings.fromLaTeXName("utf8-plain"));
2876 if (inputenc == "auto" || inputenc == "default")
2877 return *language->encoding();
2878 Encoding const * const enc = encodings.fromLaTeXName(inputenc);
2881 LYXERR0("Unknown inputenc value `" << inputenc
2882 << "'. Using `auto' instead.");
2883 return *language->encoding();
2887 CiteEngine BufferParams::citeEngine() const
2889 // FIXME the class should provide the numerical/
2890 // authoryear choice
2891 if (documentClass().provides("natbib")
2892 && cite_engine_ != ENGINE_NATBIB_NUMERICAL)
2893 return ENGINE_NATBIB_AUTHORYEAR;
2894 return cite_engine_;
2898 void BufferParams::setCiteEngine(CiteEngine cite_engine)
2900 cite_engine_ = cite_engine;