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 "LaTeXFonts.h"
34 #include "ModuleList.h"
38 #include "OutputParams.h"
42 #include "PDFOptions.h"
44 #include "frontends/alert.h"
46 #include "insets/InsetListingsParams.h"
48 #include "support/convert.h"
49 #include "support/debug.h"
50 #include "support/docstream.h"
51 #include "support/FileName.h"
52 #include "support/filetools.h"
53 #include "support/gettext.h"
54 #include "support/Messages.h"
55 #include "support/Translator.h"
56 #include "support/lstrings.h"
62 using namespace lyx::support;
65 static char const * const string_paragraph_separation[] = {
70 static char const * const string_quotes_language[] = {
71 "english", "swedish", "german", "polish", "french", "danish", ""
75 static char const * const string_papersize[] = {
76 "default", "custom", "letterpaper", "legalpaper", "executivepaper",
77 "a0paper", "a1paper", "a2paper", "a3paper", "a4paper", "a5paper",
78 "a6paper", "b0paper", "b1paper", "b2paper","b3paper", "b4paper",
79 "b5paper", "b6paper", "c0paper", "c1paper", "c2paper", "c3paper",
80 "c4paper", "c5paper", "c6paper", "b0j", "b1j", "b2j", "b3j", "b4j", "b5j",
85 static char const * const string_orientation[] = {
86 "portrait", "landscape", ""
90 static char const * const string_footnotekinds[] = {
91 "footnote", "margin", "fig", "tab", "alg", "wide-fig", "wide-tab", ""
95 static char const * const tex_graphics[] = {
96 "default", "dvialw", "dvilaser", "dvipdf", "dvipdfm", "dvipdfmx",
97 "dvips", "dvipsone", "dvitops", "dviwin", "dviwindo", "dvi2ps", "emtex",
98 "ln", "oztex", "pctexhp", "pctexps", "pctexwin", "pctex32", "pdftex",
99 "psprint", "pubps", "tcidvi", "textures", "truetex", "vtex", "xdvi",
110 // Paragraph separation
111 typedef Translator<string, BufferParams::ParagraphSeparation> ParSepTranslator;
114 ParSepTranslator const init_parseptranslator()
116 ParSepTranslator translator
117 (string_paragraph_separation[0], BufferParams::ParagraphIndentSeparation);
118 translator.addPair(string_paragraph_separation[1], BufferParams::ParagraphSkipSeparation);
123 ParSepTranslator const & parseptranslator()
125 static ParSepTranslator translator = init_parseptranslator();
131 typedef Translator<string, InsetQuotes::QuoteLanguage> QuotesLangTranslator;
134 QuotesLangTranslator const init_quoteslangtranslator()
136 QuotesLangTranslator translator
137 (string_quotes_language[0], InsetQuotes::EnglishQuotes);
138 translator.addPair(string_quotes_language[1], InsetQuotes::SwedishQuotes);
139 translator.addPair(string_quotes_language[2], InsetQuotes::GermanQuotes);
140 translator.addPair(string_quotes_language[3], InsetQuotes::PolishQuotes);
141 translator.addPair(string_quotes_language[4], InsetQuotes::FrenchQuotes);
142 translator.addPair(string_quotes_language[5], InsetQuotes::DanishQuotes);
147 QuotesLangTranslator const & quoteslangtranslator()
149 static QuotesLangTranslator translator = init_quoteslangtranslator();
155 typedef Translator<string, PAPER_SIZE> PaperSizeTranslator;
158 static PaperSizeTranslator initPaperSizeTranslator()
160 PaperSizeTranslator translator(string_papersize[0], PAPER_DEFAULT);
161 translator.addPair(string_papersize[1], PAPER_CUSTOM);
162 translator.addPair(string_papersize[2], PAPER_USLETTER);
163 translator.addPair(string_papersize[3], PAPER_USLEGAL);
164 translator.addPair(string_papersize[4], PAPER_USEXECUTIVE);
165 translator.addPair(string_papersize[5], PAPER_A0);
166 translator.addPair(string_papersize[6], PAPER_A1);
167 translator.addPair(string_papersize[7], PAPER_A2);
168 translator.addPair(string_papersize[8], PAPER_A3);
169 translator.addPair(string_papersize[9], PAPER_A4);
170 translator.addPair(string_papersize[10], PAPER_A5);
171 translator.addPair(string_papersize[11], PAPER_A6);
172 translator.addPair(string_papersize[12], PAPER_B0);
173 translator.addPair(string_papersize[13], PAPER_B1);
174 translator.addPair(string_papersize[14], PAPER_B2);
175 translator.addPair(string_papersize[15], PAPER_B3);
176 translator.addPair(string_papersize[16], PAPER_B4);
177 translator.addPair(string_papersize[17], PAPER_B5);
178 translator.addPair(string_papersize[18], PAPER_B6);
179 translator.addPair(string_papersize[19], PAPER_C0);
180 translator.addPair(string_papersize[20], PAPER_C1);
181 translator.addPair(string_papersize[21], PAPER_C2);
182 translator.addPair(string_papersize[22], PAPER_C3);
183 translator.addPair(string_papersize[23], PAPER_C4);
184 translator.addPair(string_papersize[24], PAPER_C5);
185 translator.addPair(string_papersize[25], PAPER_C6);
186 translator.addPair(string_papersize[26], PAPER_JISB0);
187 translator.addPair(string_papersize[27], PAPER_JISB1);
188 translator.addPair(string_papersize[28], PAPER_JISB2);
189 translator.addPair(string_papersize[29], PAPER_JISB3);
190 translator.addPair(string_papersize[30], PAPER_JISB4);
191 translator.addPair(string_papersize[31], PAPER_JISB5);
192 translator.addPair(string_papersize[32], PAPER_JISB6);
197 PaperSizeTranslator const & papersizetranslator()
199 static PaperSizeTranslator translator = initPaperSizeTranslator();
205 typedef Translator<string, PAPER_ORIENTATION> PaperOrientationTranslator;
208 PaperOrientationTranslator const init_paperorientationtranslator()
210 PaperOrientationTranslator translator(string_orientation[0], ORIENTATION_PORTRAIT);
211 translator.addPair(string_orientation[1], ORIENTATION_LANDSCAPE);
216 PaperOrientationTranslator const & paperorientationtranslator()
218 static PaperOrientationTranslator translator = init_paperorientationtranslator();
224 typedef Translator<int, PageSides> SidesTranslator;
227 SidesTranslator const init_sidestranslator()
229 SidesTranslator translator(1, OneSide);
230 translator.addPair(2, TwoSides);
235 SidesTranslator const & sidestranslator()
237 static SidesTranslator translator = init_sidestranslator();
243 typedef Translator<int, BufferParams::Package> PackageTranslator;
246 PackageTranslator const init_packagetranslator()
248 PackageTranslator translator(0, BufferParams::package_off);
249 translator.addPair(1, BufferParams::package_auto);
250 translator.addPair(2, BufferParams::package_on);
255 PackageTranslator const & packagetranslator()
257 static PackageTranslator translator = init_packagetranslator();
263 typedef Translator<string, CiteEngineType> CiteEngineTypeTranslator;
266 CiteEngineTypeTranslator const init_citeenginetypetranslator()
268 CiteEngineTypeTranslator translator("authoryear", ENGINE_TYPE_AUTHORYEAR);
269 translator.addPair("numerical", ENGINE_TYPE_NUMERICAL);
274 CiteEngineTypeTranslator const & citeenginetypetranslator()
276 static CiteEngineTypeTranslator translator = init_citeenginetypetranslator();
282 typedef Translator<string, Spacing::Space> SpaceTranslator;
285 SpaceTranslator const init_spacetranslator()
287 SpaceTranslator translator("default", Spacing::Default);
288 translator.addPair("single", Spacing::Single);
289 translator.addPair("onehalf", Spacing::Onehalf);
290 translator.addPair("double", Spacing::Double);
291 translator.addPair("other", Spacing::Other);
296 SpaceTranslator const & spacetranslator()
298 static SpaceTranslator translator = init_spacetranslator();
305 class BufferParams::Impl
310 AuthorList authorlist;
311 BranchList branchlist;
312 Bullet temp_bullets[4];
313 Bullet user_defined_bullets[4];
314 IndicesList indiceslist;
316 /** This is the amount of space used for paragraph_separation "skip",
317 * and for detached paragraphs in "indented" documents.
321 PDFOptions pdfoptions;
322 LayoutFileIndex baseClass_;
326 BufferParams::Impl::Impl()
327 : defskip(VSpace::MEDSKIP), baseClass_(string(""))
329 // set initial author
331 authorlist.record(Author(from_utf8(lyxrc.user_name), from_utf8(lyxrc.user_email)));
336 BufferParams::MemoryTraits::clone(BufferParams::Impl const * ptr)
340 return new BufferParams::Impl(*ptr);
344 void BufferParams::MemoryTraits::destroy(BufferParams::Impl * ptr)
350 BufferParams::BufferParams()
353 setBaseClass(defaultBaseclass());
355 paragraph_separation = ParagraphIndentSeparation;
356 quotes_language = InsetQuotes::EnglishQuotes;
357 fontsize = "default";
360 papersize = PAPER_DEFAULT;
361 orientation = ORIENTATION_PORTRAIT;
362 use_geometry = false;
363 cite_engine_.push_back("basic");
364 cite_engine_type_ = ENGINE_TYPE_NUMERICAL;
365 biblio_style = "plain";
366 use_bibtopic = false;
368 trackChanges = false;
369 outputChanges = false;
370 use_default_options = true;
371 maintain_unincluded_children = false;
374 language = default_language;
376 fonts_roman = "default";
377 fonts_sans = "default";
378 fonts_typewriter = "default";
380 fonts_default_family = "default";
381 useNonTeXFonts = false;
382 fonts_expert_sc = false;
383 fonts_old_figures = false;
384 fonts_sans_scale = 100;
385 fonts_typewriter_scale = 100;
387 lang_package = "default";
388 graphics_driver = "default";
389 default_output_format = "default";
390 bibtex_command = "default";
391 index_command = "default";
394 listings_params = string();
395 pagestyle = "default";
396 suppress_date = false;
397 justification = true;
398 // no color is the default (white)
399 backgroundcolor = lyx::rgbFromHexName("#ffffff");
400 isbackgroundcolor = false;
401 // no color is the default (black)
402 fontcolor = lyx::rgbFromHexName("#000000");
404 // light gray is the default font color for greyed-out notes
405 notefontcolor = lyx::rgbFromHexName("#cccccc");
406 boxbgcolor = lyx::rgbFromHexName("#ff0000");
407 compressed = lyxrc.save_compressed;
408 for (int iter = 0; iter < 4; ++iter) {
409 user_defined_bullet(iter) = ITEMIZE_DEFAULTS[iter];
410 temp_bullet(iter) = ITEMIZE_DEFAULTS[iter];
413 indiceslist().addDefault(B_("Index"));
414 html_be_strict = false;
415 html_math_output = MathML;
416 html_math_img_scale = 1.0;
417 html_css_as_file = false;
424 docstring BufferParams::B_(string const & l10n) const
426 LASSERT(language, /**/);
427 return getMessages(language->code()).get(l10n);
431 BufferParams::Package BufferParams::use_package(std::string const & p) const
433 PackageMap::const_iterator it = use_packages.find(p);
434 if (it == use_packages.end())
440 void BufferParams::use_package(std::string const & p, BufferParams::Package u)
446 vector<string> const & BufferParams::auto_packages()
448 static vector<string> packages;
449 if (packages.empty()) {
450 // adding a package here implies a file format change!
451 packages.push_back("amsmath");
452 packages.push_back("amssymb");
453 packages.push_back("esint");
454 packages.push_back("mathdots");
455 packages.push_back("mathtools");
456 packages.push_back("mhchem");
457 packages.push_back("undertilde");
463 AuthorList & BufferParams::authors()
465 return pimpl_->authorlist;
469 AuthorList const & BufferParams::authors() const
471 return pimpl_->authorlist;
475 BranchList & BufferParams::branchlist()
477 return pimpl_->branchlist;
481 BranchList const & BufferParams::branchlist() const
483 return pimpl_->branchlist;
487 IndicesList & BufferParams::indiceslist()
489 return pimpl_->indiceslist;
493 IndicesList const & BufferParams::indiceslist() const
495 return pimpl_->indiceslist;
499 Bullet & BufferParams::temp_bullet(lyx::size_type const index)
501 LASSERT(index < 4, /**/);
502 return pimpl_->temp_bullets[index];
506 Bullet const & BufferParams::temp_bullet(lyx::size_type const index) const
508 LASSERT(index < 4, /**/);
509 return pimpl_->temp_bullets[index];
513 Bullet & BufferParams::user_defined_bullet(lyx::size_type const index)
515 LASSERT(index < 4, /**/);
516 return pimpl_->user_defined_bullets[index];
520 Bullet const & BufferParams::user_defined_bullet(lyx::size_type const index) const
522 LASSERT(index < 4, /**/);
523 return pimpl_->user_defined_bullets[index];
527 Spacing & BufferParams::spacing()
529 return pimpl_->spacing;
533 Spacing const & BufferParams::spacing() const
535 return pimpl_->spacing;
539 PDFOptions & BufferParams::pdfoptions()
541 return pimpl_->pdfoptions;
545 PDFOptions const & BufferParams::pdfoptions() const
547 return pimpl_->pdfoptions;
551 HSpace const & BufferParams::getIndentation() const
553 return pimpl_->indentation;
557 void BufferParams::setIndentation(HSpace const & indent)
559 pimpl_->indentation = indent;
563 VSpace const & BufferParams::getDefSkip() const
565 return pimpl_->defskip;
569 void BufferParams::setDefSkip(VSpace const & vs)
571 // DEFSKIP will cause an infinite loop
572 LASSERT(vs.kind() != VSpace::DEFSKIP, return);
573 pimpl_->defskip = vs;
577 string BufferParams::readToken(Lexer & lex, string const & token,
578 FileName const & filepath)
580 if (token == "\\textclass") {
582 string const classname = lex.getString();
583 // if there exists a local layout file, ignore the system one
584 // NOTE: in this case, the textclass (.cls file) is assumed to
587 LayoutFileList & bcl = LayoutFileList::get();
588 if (tcp.empty() && !filepath.empty())
589 tcp = bcl.addLocalLayout(classname, filepath.absFileName());
593 setBaseClass(classname);
594 // We assume that a tex class exists for local or unknown
595 // layouts so this warning, will only be given for system layouts.
596 if (!baseClass()->isTeXClassAvailable()) {
597 docstring const desc =
598 translateIfPossible(from_utf8(baseClass()->description()));
599 docstring const prereqs =
600 from_utf8(baseClass()->prerequisites());
601 docstring const msg =
602 bformat(_("The selected document class\n"
604 "requires external files that are not available.\n"
605 "The document class can still be used, but the\n"
606 "document cannot be compiled until the following\n"
607 "prerequisites are installed:\n"
609 "See section 3.1.2.2 (Class Availability) of the\n"
610 "User's Guide for more information."), desc, prereqs);
611 frontend::Alert::warning(_("Document class not available"),
614 } else if (token == "\\begin_preamble") {
616 } else if (token == "\\begin_local_layout") {
617 readLocalLayout(lex);
618 } else if (token == "\\begin_modules") {
620 } else if (token == "\\begin_removed_modules") {
621 readRemovedModules(lex);
622 } else if (token == "\\begin_includeonly") {
623 readIncludeonly(lex);
624 } else if (token == "\\maintain_unincluded_children") {
625 lex >> maintain_unincluded_children;
626 } else if (token == "\\options") {
628 options = lex.getString();
629 } else if (token == "\\use_default_options") {
630 lex >> use_default_options;
631 } else if (token == "\\master") {
633 master = lex.getString();
634 } else if (token == "\\suppress_date") {
635 lex >> suppress_date;
636 } else if (token == "\\justification") {
637 lex >> justification;
638 } else if (token == "\\language") {
640 } else if (token == "\\language_package") {
642 lang_package = lex.getString();
643 } else if (token == "\\inputencoding") {
645 } else if (token == "\\graphics") {
646 readGraphicsDriver(lex);
647 } else if (token == "\\default_output_format") {
648 lex >> default_output_format;
649 } else if (token == "\\bibtex_command") {
651 bibtex_command = lex.getString();
652 } else if (token == "\\index_command") {
654 index_command = lex.getString();
655 } else if (token == "\\fontencoding") {
657 fontenc = lex.getString();
658 } else if (token == "\\font_roman") {
660 fonts_roman = lex.getString();
661 } else if (token == "\\font_sans") {
663 fonts_sans = lex.getString();
664 } else if (token == "\\font_typewriter") {
666 fonts_typewriter = lex.getString();
667 } else if (token == "\\font_math") {
669 fonts_math = lex.getString();
670 } else if (token == "\\font_default_family") {
671 lex >> fonts_default_family;
672 } else if (token == "\\use_non_tex_fonts") {
673 lex >> useNonTeXFonts;
674 } else if (token == "\\font_sc") {
675 lex >> fonts_expert_sc;
676 } else if (token == "\\font_osf") {
677 lex >> fonts_old_figures;
678 } else if (token == "\\font_sf_scale") {
679 lex >> fonts_sans_scale;
680 } else if (token == "\\font_tt_scale") {
681 lex >> fonts_typewriter_scale;
682 } else if (token == "\\font_cjk") {
684 } else if (token == "\\paragraph_separation") {
687 paragraph_separation = parseptranslator().find(parsep);
688 } else if (token == "\\paragraph_indentation") {
690 string indentation = lex.getString();
691 pimpl_->indentation = HSpace(indentation);
692 } else if (token == "\\defskip") {
694 string const defskip = lex.getString();
695 pimpl_->defskip = VSpace(defskip);
696 if (pimpl_->defskip.kind() == VSpace::DEFSKIP)
698 pimpl_->defskip = VSpace(VSpace::MEDSKIP);
699 } else if (token == "\\quotes_language") {
702 quotes_language = quoteslangtranslator().find(quotes_lang);
703 } else if (token == "\\papersize") {
706 papersize = papersizetranslator().find(ppsize);
707 } else if (token == "\\use_geometry") {
709 } else if (token == "\\use_package") {
714 use_package(package, packagetranslator().find(use));
715 } else if (token == "\\cite_engine") {
717 vector<string> engine = getVectorFromString(lex.getString());
718 setCiteEngine(engine);
719 } else if (token == "\\cite_engine_type") {
722 cite_engine_type_ = citeenginetypetranslator().find(engine_type);
723 } else if (token == "\\biblio_style") {
725 biblio_style = lex.getString();
726 } else if (token == "\\use_bibtopic") {
728 } else if (token == "\\use_indices") {
730 } else if (token == "\\tracking_changes") {
732 } else if (token == "\\output_changes") {
733 lex >> outputChanges;
734 } else if (token == "\\branch") {
736 docstring branch = lex.getDocString();
737 branchlist().add(branch);
740 string const tok = lex.getString();
741 if (tok == "\\end_branch")
743 Branch * branch_ptr = branchlist().find(branch);
744 if (tok == "\\selected") {
747 branch_ptr->setSelected(lex.getInteger());
749 if (tok == "\\filename_suffix") {
752 branch_ptr->setFileNameSuffix(lex.getInteger());
754 if (tok == "\\color") {
756 string color = lex.getString();
758 branch_ptr->setColor(color);
759 // Update also the Color table:
761 color = lcolor.getX11Name(Color_background);
763 lcolor.setColor(to_utf8(branch), color);
766 } else if (token == "\\index") {
768 docstring index = lex.getDocString();
770 indiceslist().add(index);
773 string const tok = lex.getString();
774 if (tok == "\\end_index")
776 Index * index_ptr = indiceslist().find(index);
777 if (tok == "\\shortcut") {
779 shortcut = lex.getDocString();
781 index_ptr->setShortcut(shortcut);
783 if (tok == "\\color") {
785 string color = lex.getString();
787 index_ptr->setColor(color);
788 // Update also the Color table:
790 color = lcolor.getX11Name(Color_background);
792 if (!shortcut.empty())
793 lcolor.setColor(to_utf8(shortcut), color);
796 } else if (token == "\\author") {
798 istringstream ss(lex.getString());
801 author_map[a.bufferId()] = pimpl_->authorlist.record(a);
802 } else if (token == "\\paperorientation") {
805 orientation = paperorientationtranslator().find(orient);
806 } else if (token == "\\backgroundcolor") {
808 backgroundcolor = lyx::rgbFromHexName(lex.getString());
809 isbackgroundcolor = true;
810 } else if (token == "\\fontcolor") {
812 fontcolor = lyx::rgbFromHexName(lex.getString());
814 } else if (token == "\\notefontcolor") {
816 string color = lex.getString();
817 notefontcolor = lyx::rgbFromHexName(color);
818 } else if (token == "\\boxbgcolor") {
820 string color = lex.getString();
821 boxbgcolor = lyx::rgbFromHexName(color);
822 lcolor.setColor("boxbgcolor", color);
823 } else if (token == "\\paperwidth") {
825 } else if (token == "\\paperheight") {
827 } else if (token == "\\leftmargin") {
829 } else if (token == "\\topmargin") {
831 } else if (token == "\\rightmargin") {
833 } else if (token == "\\bottommargin") {
835 } else if (token == "\\headheight") {
837 } else if (token == "\\headsep") {
839 } else if (token == "\\footskip") {
841 } else if (token == "\\columnsep") {
843 } else if (token == "\\paperfontsize") {
845 } else if (token == "\\papercolumns") {
847 } else if (token == "\\listings_params") {
850 listings_params = InsetListingsParams(par).params();
851 } else if (token == "\\papersides") {
854 sides = sidestranslator().find(psides);
855 } else if (token == "\\paperpagestyle") {
857 } else if (token == "\\bullet") {
859 } else if (token == "\\bulletLaTeX") {
860 readBulletsLaTeX(lex);
861 } else if (token == "\\secnumdepth") {
863 } else if (token == "\\tocdepth") {
865 } else if (token == "\\spacing") {
869 if (nspacing == "other") {
872 spacing().set(spacetranslator().find(nspacing), tmp_val);
873 } else if (token == "\\float_placement") {
874 lex >> float_placement;
876 } else if (prefixIs(token, "\\pdf_") || token == "\\use_hyperref") {
877 string toktmp = pdfoptions().readToken(lex, token);
878 if (!toktmp.empty()) {
879 lyxerr << "PDFOptions::readToken(): Unknown token: " <<
883 } else if (token == "\\html_math_output") {
886 html_math_output = static_cast<MathOutput>(temp);
887 } else if (token == "\\html_be_strict") {
888 lex >> html_be_strict;
889 } else if (token == "\\html_css_as_file") {
890 lex >> html_css_as_file;
891 } else if (token == "\\html_math_img_scale") {
892 lex >> html_math_img_scale;
893 } else if (token == "\\html_latex_start") {
895 html_latex_start = lex.getString();
896 } else if (token == "\\html_latex_end") {
898 html_latex_end = lex.getString();
899 } else if (token == "\\output_sync") {
901 } else if (token == "\\output_sync_macro") {
902 lex >> output_sync_macro;
903 } else if (token == "\\use_refstyle") {
906 lyxerr << "BufferParams::readToken(): Unknown token: " <<
915 void BufferParams::writeFile(ostream & os) const
917 // The top of the file is written by the buffer.
918 // Prints out the buffer info into the .lyx file given by file
921 os << "\\textclass " << baseClass()->name() << '\n';
924 if (!preamble.empty()) {
925 // remove '\n' from the end of preamble
926 string const tmppreamble = rtrim(preamble, "\n");
927 os << "\\begin_preamble\n"
929 << "\n\\end_preamble\n";
933 if (!options.empty()) {
934 os << "\\options " << options << '\n';
937 // use the class options defined in the layout?
938 os << "\\use_default_options "
939 << convert<string>(use_default_options) << "\n";
941 // the master document
942 if (!master.empty()) {
943 os << "\\master " << master << '\n';
947 if (!removed_modules_.empty()) {
948 os << "\\begin_removed_modules" << '\n';
949 list<string>::const_iterator it = removed_modules_.begin();
950 list<string>::const_iterator en = removed_modules_.end();
951 for (; it != en; ++it)
953 os << "\\end_removed_modules" << '\n';
957 if (!layout_modules_.empty()) {
958 os << "\\begin_modules" << '\n';
959 LayoutModuleList::const_iterator it = layout_modules_.begin();
960 LayoutModuleList::const_iterator en = layout_modules_.end();
961 for (; it != en; ++it)
963 os << "\\end_modules" << '\n';
967 if (!included_children_.empty()) {
968 os << "\\begin_includeonly" << '\n';
969 list<string>::const_iterator it = included_children_.begin();
970 list<string>::const_iterator en = included_children_.end();
971 for (; it != en; ++it)
973 os << "\\end_includeonly" << '\n';
975 os << "\\maintain_unincluded_children "
976 << convert<string>(maintain_unincluded_children) << '\n';
978 // local layout information
979 if (!local_layout.empty()) {
980 // remove '\n' from the end
981 string const tmplocal = rtrim(local_layout, "\n");
982 os << "\\begin_local_layout\n"
984 << "\n\\end_local_layout\n";
987 // then the text parameters
988 if (language != ignore_language)
989 os << "\\language " << language->lang() << '\n';
990 os << "\\language_package " << lang_package
991 << "\n\\inputencoding " << inputenc
992 << "\n\\fontencoding " << fontenc
993 << "\n\\font_roman " << fonts_roman
994 << "\n\\font_sans " << fonts_sans
995 << "\n\\font_typewriter " << fonts_typewriter
996 << "\n\\font_math " << fonts_math
997 << "\n\\font_default_family " << fonts_default_family
998 << "\n\\use_non_tex_fonts " << convert<string>(useNonTeXFonts)
999 << "\n\\font_sc " << convert<string>(fonts_expert_sc)
1000 << "\n\\font_osf " << convert<string>(fonts_old_figures)
1001 << "\n\\font_sf_scale " << fonts_sans_scale
1002 << "\n\\font_tt_scale " << fonts_typewriter_scale
1004 if (!fonts_cjk.empty()) {
1005 os << "\\font_cjk " << fonts_cjk << '\n';
1007 os << "\\graphics " << graphics_driver << '\n';
1008 os << "\\default_output_format " << default_output_format << '\n';
1009 os << "\\output_sync " << output_sync << '\n';
1010 if (!output_sync_macro.empty())
1011 os << "\\output_sync_macro \"" << output_sync_macro << "\"\n";
1012 os << "\\bibtex_command " << bibtex_command << '\n';
1013 os << "\\index_command " << index_command << '\n';
1015 if (!float_placement.empty()) {
1016 os << "\\float_placement " << float_placement << '\n';
1018 os << "\\paperfontsize " << fontsize << '\n';
1020 spacing().writeFile(os);
1021 pdfoptions().writeFile(os);
1023 os << "\\papersize " << string_papersize[papersize]
1024 << "\n\\use_geometry " << convert<string>(use_geometry);
1025 vector<string> const & packages = auto_packages();
1026 for (size_t i = 0; i < packages.size(); ++i)
1027 os << "\n\\use_package " << packages[i] << ' '
1028 << use_package(packages[i]);
1030 os << "\n\\cite_engine ";
1032 if (!cite_engine_.empty()) {
1033 LayoutModuleList::const_iterator be = cite_engine_.begin();
1034 LayoutModuleList::const_iterator en = cite_engine_.end();
1035 for (LayoutModuleList::const_iterator it = be; it != en; ++it) {
1044 os << "\n\\cite_engine_type " << citeenginetypetranslator().find(cite_engine_type_)
1045 << "\n\\biblio_style " << biblio_style
1046 << "\n\\use_bibtopic " << convert<string>(use_bibtopic)
1047 << "\n\\use_indices " << convert<string>(use_indices)
1048 << "\n\\paperorientation " << string_orientation[orientation]
1049 << "\n\\suppress_date " << convert<string>(suppress_date)
1050 << "\n\\justification " << convert<string>(justification)
1051 << "\n\\use_refstyle " << use_refstyle
1053 if (isbackgroundcolor == true)
1054 os << "\\backgroundcolor " << lyx::X11hexname(backgroundcolor) << '\n';
1055 if (isfontcolor == true)
1056 os << "\\fontcolor " << lyx::X11hexname(fontcolor) << '\n';
1057 if (notefontcolor != lyx::rgbFromHexName("#cccccc"))
1058 os << "\\notefontcolor " << lyx::X11hexname(notefontcolor) << '\n';
1059 if (boxbgcolor != lyx::rgbFromHexName("#ff0000"))
1060 os << "\\boxbgcolor " << lyx::X11hexname(boxbgcolor) << '\n';
1062 BranchList::const_iterator it = branchlist().begin();
1063 BranchList::const_iterator end = branchlist().end();
1064 for (; it != end; ++it) {
1065 os << "\\branch " << to_utf8(it->branch())
1066 << "\n\\selected " << it->isSelected()
1067 << "\n\\filename_suffix " << it->hasFileNameSuffix()
1068 << "\n\\color " << lyx::X11hexname(it->color())
1073 IndicesList::const_iterator iit = indiceslist().begin();
1074 IndicesList::const_iterator iend = indiceslist().end();
1075 for (; iit != iend; ++iit) {
1076 os << "\\index " << to_utf8(iit->index())
1077 << "\n\\shortcut " << to_utf8(iit->shortcut())
1078 << "\n\\color " << lyx::X11hexname(iit->color())
1083 if (!paperwidth.empty())
1084 os << "\\paperwidth "
1085 << VSpace(paperwidth).asLyXCommand() << '\n';
1086 if (!paperheight.empty())
1087 os << "\\paperheight "
1088 << VSpace(paperheight).asLyXCommand() << '\n';
1089 if (!leftmargin.empty())
1090 os << "\\leftmargin "
1091 << VSpace(leftmargin).asLyXCommand() << '\n';
1092 if (!topmargin.empty())
1093 os << "\\topmargin "
1094 << VSpace(topmargin).asLyXCommand() << '\n';
1095 if (!rightmargin.empty())
1096 os << "\\rightmargin "
1097 << VSpace(rightmargin).asLyXCommand() << '\n';
1098 if (!bottommargin.empty())
1099 os << "\\bottommargin "
1100 << VSpace(bottommargin).asLyXCommand() << '\n';
1101 if (!headheight.empty())
1102 os << "\\headheight "
1103 << VSpace(headheight).asLyXCommand() << '\n';
1104 if (!headsep.empty())
1106 << VSpace(headsep).asLyXCommand() << '\n';
1107 if (!footskip.empty())
1109 << VSpace(footskip).asLyXCommand() << '\n';
1110 if (!columnsep.empty())
1111 os << "\\columnsep "
1112 << VSpace(columnsep).asLyXCommand() << '\n';
1113 os << "\\secnumdepth " << secnumdepth
1114 << "\n\\tocdepth " << tocdepth
1115 << "\n\\paragraph_separation "
1116 << string_paragraph_separation[paragraph_separation];
1117 if (!paragraph_separation)
1118 os << "\n\\paragraph_indentation " << getIndentation().asLyXCommand();
1120 os << "\n\\defskip " << getDefSkip().asLyXCommand();
1121 os << "\n\\quotes_language "
1122 << string_quotes_language[quotes_language]
1123 << "\n\\papercolumns " << columns
1124 << "\n\\papersides " << sides
1125 << "\n\\paperpagestyle " << pagestyle << '\n';
1126 if (!listings_params.empty())
1127 os << "\\listings_params \"" <<
1128 InsetListingsParams(listings_params).encodedString() << "\"\n";
1129 for (int i = 0; i < 4; ++i) {
1130 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1131 if (user_defined_bullet(i).getFont() != -1) {
1132 os << "\\bullet " << i << " "
1133 << user_defined_bullet(i).getFont() << " "
1134 << user_defined_bullet(i).getCharacter() << " "
1135 << user_defined_bullet(i).getSize() << "\n";
1139 os << "\\bulletLaTeX " << i << " \""
1140 << lyx::to_ascii(user_defined_bullet(i).getText())
1146 os << "\\tracking_changes " << convert<string>(trackChanges) << '\n'
1147 << "\\output_changes " << convert<string>(outputChanges) << '\n'
1148 << "\\html_math_output " << html_math_output << '\n'
1149 << "\\html_css_as_file " << html_css_as_file << '\n'
1150 << "\\html_be_strict " << convert<string>(html_be_strict) << '\n';
1152 if (html_math_img_scale != 1.0)
1153 os << "\\html_math_img_scale " << convert<string>(html_math_img_scale) << '\n';
1154 if (!html_latex_start.empty())
1155 os << "\\html_latex_start " << html_latex_start << '\n';
1156 if (!html_latex_end.empty())
1157 os << "\\html_latex_end " << html_latex_end << '\n';
1159 os << pimpl_->authorlist;
1163 void BufferParams::validate(LaTeXFeatures & features) const
1165 features.require(documentClass().requires());
1167 if (columns > 1 && language->rightToLeft())
1168 features.require("rtloutputdblcol");
1170 if (outputChanges) {
1171 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1172 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1173 LaTeXFeatures::isAvailable("xcolor");
1175 switch (features.runparams().flavor) {
1176 case OutputParams::LATEX:
1177 case OutputParams::DVILUATEX:
1179 features.require("ct-dvipost");
1180 features.require("dvipost");
1181 } else if (xcolorulem) {
1182 features.require("ct-xcolor-ulem");
1183 features.require("ulem");
1184 features.require("xcolor");
1186 features.require("ct-none");
1189 case OutputParams::LUATEX:
1190 case OutputParams::PDFLATEX:
1191 case OutputParams::XETEX:
1193 features.require("ct-xcolor-ulem");
1194 features.require("ulem");
1195 features.require("xcolor");
1196 // improves color handling in PDF output
1197 features.require("pdfcolmk");
1199 features.require("ct-none");
1207 // Floats with 'Here definitely' as default setting.
1208 if (float_placement.find('H') != string::npos)
1209 features.require("float");
1211 for (PackageMap::const_iterator it = use_packages.begin();
1212 it != use_packages.end(); ++it) {
1213 if (it->first == "amsmath") {
1214 // AMS Style is at document level
1215 if (it->second == package_on ||
1216 features.isProvided("amsmath"))
1217 features.require(it->first);
1218 } else if (it->second == package_on)
1219 features.require(it->first);
1222 // Document-level line spacing
1223 if (spacing().getSpace() != Spacing::Single && !spacing().isDefault())
1224 features.require("setspace");
1226 // the bullet shapes are buffer level not paragraph level
1227 // so they are tested here
1228 for (int i = 0; i < 4; ++i) {
1229 if (user_defined_bullet(i) == ITEMIZE_DEFAULTS[i])
1231 int const font = user_defined_bullet(i).getFont();
1233 int const c = user_defined_bullet(i).getCharacter();
1239 features.require("latexsym");
1241 } else if (font == 1) {
1242 features.require("amssymb");
1243 } else if (font >= 2 && font <= 5) {
1244 features.require("pifont");
1248 if (pdfoptions().use_hyperref) {
1249 features.require("hyperref");
1250 // due to interferences with babel and hyperref, the color package has to
1251 // be loaded after hyperref when hyperref is used with the colorlinks
1252 // option, see http://www.lyx.org/trac/ticket/5291
1253 if (pdfoptions().colorlinks)
1254 features.require("color");
1257 // some languages are only available via polyglossia
1258 if (features.runparams().flavor == OutputParams::XETEX
1259 && (features.hasPolyglossiaExclusiveLanguages()
1261 features.require("polyglossia");
1263 if (useNonTeXFonts && fonts_math != "auto")
1264 features.require("unicode-math");
1266 if (!language->requires().empty())
1267 features.require(language->requires());
1271 bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
1272 FileName const & filepath) const
1274 // http://www.tug.org/texmf-dist/doc/latex/base/fixltx2e.pdf
1275 // !! To use the Fix-cm package, load it before \documentclass, and use the command
1276 // \RequirePackage to do so, rather than the normal \usepackage
1277 // Do not try to load any other package before the document class, unless you
1278 // have a thorough understanding of the LATEX internals and know exactly what you
1280 if (features.mustProvide("fix-cm"))
1281 os << "\\RequirePackage{fix-cm}\n";
1283 os << "\\documentclass";
1285 DocumentClass const & tclass = documentClass();
1287 ostringstream clsoptions; // the document class options.
1289 if (tokenPos(tclass.opt_fontsize(),
1290 '|', fontsize) >= 0) {
1291 // only write if existing in list (and not default)
1292 clsoptions << fontsize << "pt,";
1295 // all paper sizes except of A4, A5, B5 and the US sizes need the
1297 bool nonstandard_papersize = papersize != PAPER_DEFAULT
1298 && papersize != PAPER_USLETTER
1299 && papersize != PAPER_USLEGAL
1300 && papersize != PAPER_USEXECUTIVE
1301 && papersize != PAPER_A4
1302 && papersize != PAPER_A5
1303 && papersize != PAPER_B5;
1305 if (!use_geometry) {
1306 switch (papersize) {
1308 clsoptions << "a4paper,";
1310 case PAPER_USLETTER:
1311 clsoptions << "letterpaper,";
1314 clsoptions << "a5paper,";
1317 clsoptions << "b5paper,";
1319 case PAPER_USEXECUTIVE:
1320 clsoptions << "executivepaper,";
1323 clsoptions << "legalpaper,";
1357 if (sides != tclass.sides()) {
1360 clsoptions << "oneside,";
1363 clsoptions << "twoside,";
1369 if (columns != tclass.columns()) {
1371 clsoptions << "twocolumn,";
1373 clsoptions << "onecolumn,";
1377 && orientation == ORIENTATION_LANDSCAPE)
1378 clsoptions << "landscape,";
1380 // language should be a parameter to \documentclass
1381 if (language->babel() == "hebrew"
1382 && default_language->babel() != "hebrew")
1383 // This seems necessary
1384 features.useLanguage(default_language);
1386 ostringstream language_options;
1387 bool const use_babel = features.useBabel() && !features.isProvided("babel");
1388 bool const use_polyglossia = features.usePolyglossia();
1389 bool const global = lyxrc.language_global_options;
1390 if (use_babel || (use_polyglossia && global)) {
1391 language_options << features.getBabelLanguages();
1392 if (!language->babel().empty()) {
1393 if (!language_options.str().empty())
1394 language_options << ',';
1395 language_options << language->babel();
1397 if (global && !features.needBabelLangOptions()
1398 && !language_options.str().empty())
1399 clsoptions << language_options.str() << ',';
1402 // the predefined options from the layout
1403 if (use_default_options && !tclass.options().empty())
1404 clsoptions << tclass.options() << ',';
1406 // the user-defined options
1407 if (!options.empty()) {
1408 clsoptions << options << ',';
1411 string strOptions(clsoptions.str());
1412 if (!strOptions.empty()) {
1413 strOptions = rtrim(strOptions, ",");
1415 os << '[' << from_utf8(strOptions) << ']';
1418 os << '{' << from_ascii(tclass.latexname()) << "}\n";
1419 // end of \documentclass defs
1421 // if we use fontspec, we have to load the AMS packages here
1422 string const ams = features.loadAMSPackages();
1423 if (useNonTeXFonts && !ams.empty())
1424 os << from_ascii(ams);
1426 if (useNonTeXFonts) {
1427 os << "\\usepackage{fontspec}\n";
1428 if (features.mustProvide("unicode-math")
1429 && features.isAvailable("unicode-math"))
1430 os << "\\usepackage{unicode-math}\n";
1433 // font selection must be done before loading fontenc.sty
1434 string const fonts = loadFonts(features);
1436 os << from_utf8(fonts);
1438 if (fonts_default_family != "default")
1439 os << "\\renewcommand{\\familydefault}{\\"
1440 << from_ascii(fonts_default_family) << "}\n";
1442 // set font encoding
1443 // for arabic_arabi and farsi we also need to load the LAE and
1445 // XeTeX and LuaTeX (with OS fonts) work without fontenc
1446 if (font_encoding() != "default" && language->lang() != "japanese"
1447 && !useNonTeXFonts && !features.isProvided("fontenc")) {
1448 size_t fars = language_options.str().find("farsi");
1449 size_t arab = language_options.str().find("arabic");
1450 if (language->lang() == "arabic_arabi"
1451 || language->lang() == "farsi" || fars != string::npos
1452 || arab != string::npos) {
1453 os << "\\usepackage[" << from_ascii(font_encoding())
1454 << ",LFE,LAE]{fontenc}\n";
1456 os << "\\usepackage[" << from_ascii(font_encoding())
1461 // handle inputenc etc.
1462 writeEncodingPreamble(os, features);
1465 if (!features.runparams().includeall && !included_children_.empty()) {
1466 os << "\\includeonly{";
1467 list<string>::const_iterator it = included_children_.begin();
1468 list<string>::const_iterator en = included_children_.end();
1470 for (; it != en; ++it) {
1471 string incfile = *it;
1472 FileName inc = makeAbsPath(incfile, filepath.absFileName());
1473 string mangled = DocFileName(changeExtension(inc.absFileName(), ".tex")).
1475 if (!features.runparams().nice)
1477 // \includeonly doesn't want an extension
1478 incfile = changeExtension(incfile, string());
1479 incfile = support::latex_path(incfile);
1480 if (!incfile.empty()) {
1483 os << from_utf8(incfile);
1490 if (!listings_params.empty() || features.isRequired("listings"))
1491 os << "\\usepackage{listings}\n";
1493 if (!listings_params.empty()) {
1495 // do not test validity because listings_params is
1496 // supposed to be valid
1498 InsetListingsParams(listings_params).separatedParams(true);
1499 // we can't support all packages, but we should load the color package
1500 if (par.find("\\color", 0) != string::npos)
1501 features.require("color");
1502 os << from_utf8(par)
1505 if (!features.isProvided("geometry")
1506 && (use_geometry || nonstandard_papersize)) {
1507 odocstringstream ods;
1508 if (!getGraphicsDriver("geometry").empty())
1509 ods << getGraphicsDriver("geometry");
1510 if (orientation == ORIENTATION_LANDSCAPE)
1511 ods << ",landscape";
1512 switch (papersize) {
1514 if (!paperwidth.empty())
1515 ods << ",paperwidth="
1516 << from_ascii(paperwidth);
1517 if (!paperheight.empty())
1518 ods << ",paperheight="
1519 << from_ascii(paperheight);
1521 case PAPER_USLETTER:
1522 ods << ",letterpaper";
1525 ods << ",legalpaper";
1527 case PAPER_USEXECUTIVE:
1528 ods << ",executivepaper";
1617 docstring const g_options = trim(ods.str(), ",");
1618 os << "\\usepackage";
1619 if (!g_options.empty())
1620 os << '[' << g_options << ']';
1621 os << "{geometry}\n";
1622 // output this only if use_geometry is true
1624 os << "\\geometry{verbose";
1625 if (!topmargin.empty())
1626 os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1627 if (!bottommargin.empty())
1628 os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1629 if (!leftmargin.empty())
1630 os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1631 if (!rightmargin.empty())
1632 os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1633 if (!headheight.empty())
1634 os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1635 if (!headsep.empty())
1636 os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1637 if (!footskip.empty())
1638 os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1639 if (!columnsep.empty())
1640 os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
1643 } else if (orientation == ORIENTATION_LANDSCAPE
1644 || papersize != PAPER_DEFAULT) {
1645 features.require("papersize");
1648 if (tokenPos(tclass.opt_pagestyle(), '|', pagestyle) >= 0) {
1649 if (pagestyle == "fancy")
1650 os << "\\usepackage{fancyhdr}\n";
1651 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1654 // only output when the background color is not default
1655 if (isbackgroundcolor == true) {
1656 // only require color here, the background color will be defined
1657 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1659 features.require("color");
1660 features.require("pagecolor");
1663 // only output when the font color is not default
1664 if (isfontcolor == true) {
1665 // only require color here, the font color will be defined
1666 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1668 features.require("color");
1669 features.require("fontcolor");
1672 // Only if class has a ToC hierarchy
1673 if (tclass.hasTocLevels()) {
1674 if (secnumdepth != tclass.secnumdepth()) {
1675 os << "\\setcounter{secnumdepth}{"
1679 if (tocdepth != tclass.tocdepth()) {
1680 os << "\\setcounter{tocdepth}{"
1686 if (paragraph_separation) {
1687 // when skip separation
1688 switch (getDefSkip().kind()) {
1689 case VSpace::SMALLSKIP:
1690 os << "\\setlength{\\parskip}{\\smallskipamount}\n";
1692 case VSpace::MEDSKIP:
1693 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1695 case VSpace::BIGSKIP:
1696 os << "\\setlength{\\parskip}{\\bigskipamount}\n";
1698 case VSpace::LENGTH:
1699 os << "\\setlength{\\parskip}{"
1700 << from_utf8(getDefSkip().length().asLatexString())
1703 default: // should never happen // Then delete it.
1704 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1707 os << "\\setlength{\\parindent}{0pt}\n";
1709 // when separation by indentation
1710 // only output something when a width is given
1711 if (getIndentation().asLyXCommand() != "default") {
1712 os << "\\setlength{\\parindent}{"
1713 << from_utf8(getIndentation().asLatexCommand())
1718 // Now insert the LyX specific LaTeX commands...
1719 docstring lyxpreamble;
1720 features.resolveAlternatives();
1723 if (!output_sync_macro.empty())
1724 lyxpreamble += from_utf8(output_sync_macro) +"\n";
1725 else if (features.runparams().flavor == OutputParams::LATEX)
1726 lyxpreamble += "\\usepackage[active]{srcltx}\n";
1727 else if (features.runparams().flavor == OutputParams::PDFLATEX)
1728 lyxpreamble += "\\synctex=-1\n";
1731 // due to interferences with babel and hyperref, the color package has to
1732 // be loaded (when it is not already loaded) before babel when hyperref
1733 // is used with the colorlinks option, see
1734 // http://www.lyx.org/trac/ticket/5291
1735 // we decided therefore to load color always before babel, see
1736 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
1737 lyxpreamble += from_ascii(features.getColorOptions());
1739 // If we use hyperref, jurabib, japanese, or vietnamese, we have to call babel before them.
1741 && (features.isRequired("jurabib")
1742 || features.isRequired("hyperref")
1743 || features.isRequired("vietnamese")
1744 || features.isRequired("japanese"))) {
1746 lyxpreamble += from_utf8(features.getBabelPresettings());
1747 lyxpreamble += from_utf8(babelCall(language_options.str(),
1748 features.needBabelLangOptions())) + '\n';
1749 lyxpreamble += from_utf8(features.getBabelPostsettings());
1752 // The optional packages;
1753 lyxpreamble += from_ascii(features.getPackages());
1755 // Additional Indices
1756 if (features.isRequired("splitidx")) {
1757 IndicesList::const_iterator iit = indiceslist().begin();
1758 IndicesList::const_iterator iend = indiceslist().end();
1759 for (; iit != iend; ++iit) {
1760 pair<docstring, docstring> indexname_latex =
1761 features.runparams().encoding->latexString(iit->index(),
1762 features.runparams().dryrun);
1763 if (!indexname_latex.second.empty()) {
1764 // issue a warning about omitted characters
1765 // FIXME: should be passed to the error dialog
1766 frontend::Alert::warning(_("Uncodable characters"),
1767 bformat(_("The following characters that are used in an index name are not\n"
1768 "representable in the current encoding and therefore have been omitted:\n%1$s."),
1769 indexname_latex.second));
1771 lyxpreamble += "\\newindex[";
1772 lyxpreamble += indexname_latex.first;
1773 lyxpreamble += "]{";
1774 lyxpreamble += escape(iit->shortcut());
1775 lyxpreamble += "}\n";
1780 lyxpreamble += from_utf8(spacing().writePreamble(features.isProvided("SetSpace")));
1783 // * Hyperref manual: "Make sure it comes last of your loaded
1784 // packages, to give it a fighting chance of not being over-written,
1785 // since its job is to redefine many LaTeX commands."
1786 // * Email from Heiko Oberdiek: "It is usually better to load babel
1787 // before hyperref. Then hyperref has a chance to detect babel.
1788 // * Has to be loaded before the "LyX specific LaTeX commands" to
1789 // avoid errors with algorithm floats.
1790 // use hyperref explicitly if it is required
1791 if (features.isRequired("hyperref")) {
1792 // pass what we have to stream here, since we need
1793 // to access the stream itself in PDFOptions.
1796 OutputParams tmp_params = features.runparams();
1797 pdfoptions().writeLaTeX(tmp_params, os,
1798 features.isProvided("hyperref"));
1799 // set back for the rest
1800 lyxpreamble.clear();
1801 // correctly break URLs with hyperref and dvi output
1802 if (features.runparams().flavor == OutputParams::LATEX
1803 && features.isAvailable("breakurl"))
1804 lyxpreamble += "\\usepackage{breakurl}\n";
1805 } else if (features.isRequired("nameref"))
1806 // hyperref loads this automatically
1807 lyxpreamble += "\\usepackage{nameref}\n";
1809 // bibtopic needs to be loaded after hyperref.
1810 // the dot provides the aux file naming which LyX can detect.
1811 if (features.mustProvide("bibtopic"))
1812 lyxpreamble += "\\usepackage[dot]{bibtopic}\n";
1814 // Will be surrounded by \makeatletter and \makeatother when not empty
1815 docstring atlyxpreamble;
1817 // Some macros LyX will need
1818 docstring tmppreamble(features.getMacros());
1820 if (!tmppreamble.empty())
1821 atlyxpreamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1822 "LyX specific LaTeX commands.\n"
1823 + tmppreamble + '\n';
1825 // the text class specific preamble
1826 tmppreamble = features.getTClassPreamble();
1827 if (!tmppreamble.empty())
1828 atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1829 "Textclass specific LaTeX commands.\n"
1830 + tmppreamble + '\n';
1832 // suppress date if selected
1833 // use \@ifundefined because we cannot be sure that every document class
1834 // has a \date command
1836 atlyxpreamble += "\\@ifundefined{date}{}{\\date{}}\n";
1838 /* the user-defined preamble */
1839 if (!containsOnly(preamble, " \n\t"))
1841 atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1842 "User specified LaTeX commands.\n"
1843 + from_utf8(preamble) + '\n';
1845 // subfig loads internally the LaTeX package "caption". As
1846 // caption is a very popular package, users will load it in
1847 // the preamble. Therefore we must load subfig behind the
1848 // user-defined preamble and check if the caption package was
1849 // loaded or not. For the case that caption is loaded before
1850 // subfig, there is the subfig option "caption=false". This
1851 // option also works when a koma-script class is used and
1852 // koma's own caption commands are used instead of caption. We
1853 // use \PassOptionsToPackage here because the user could have
1854 // already loaded subfig in the preamble.
1855 if (features.isRequired("subfig")) {
1856 atlyxpreamble += "\\@ifundefined{showcaptionsetup}{}{%\n"
1857 " \\PassOptionsToPackage{caption=false}{subfig}}\n"
1858 "\\usepackage{subfig}\n";
1861 // Itemize bullet settings need to be last in case the user
1862 // defines their own bullets that use a package included
1863 // in the user-defined preamble -- ARRae
1864 // Actually it has to be done much later than that
1865 // since some packages like frenchb make modifications
1866 // at \begin{document} time -- JMarc
1867 docstring bullets_def;
1868 for (int i = 0; i < 4; ++i) {
1869 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1870 if (bullets_def.empty())
1871 bullets_def += "\\AtBeginDocument{\n";
1872 bullets_def += " \\def\\labelitemi";
1874 // `i' is one less than the item to modify
1881 bullets_def += "ii";
1887 bullets_def += '{' +
1888 user_defined_bullet(i).getText()
1893 if (!bullets_def.empty())
1894 atlyxpreamble += bullets_def + "}\n\n";
1896 if (!atlyxpreamble.empty())
1897 lyxpreamble += "\n\\makeatletter\n"
1898 + atlyxpreamble + "\\makeatother\n\n";
1900 // We try to load babel late, in case it interferes with other packages.
1901 // Jurabib and Hyperref have to be called after babel, though.
1902 if (use_babel && !features.isRequired("jurabib")
1903 && !features.isRequired("hyperref")
1904 && !features.isRequired("vietnamese")
1905 && !features.isRequired("japanese")) {
1907 lyxpreamble += from_utf8(features.getBabelPresettings());
1908 lyxpreamble += from_utf8(babelCall(language_options.str(),
1909 features.needBabelLangOptions())) + '\n';
1910 lyxpreamble += from_utf8(features.getBabelPostsettings());
1913 // xunicode needs to be loaded at least after amsmath, amssymb,
1914 // esint and the other packages that provide special glyphs
1915 if (features.runparams().flavor == OutputParams::XETEX)
1916 lyxpreamble += "\\usepackage{xunicode}\n";
1918 // Polyglossia must be loaded last
1919 if (use_polyglossia) {
1921 lyxpreamble += "\\usepackage{polyglossia}\n";
1922 // set the main language
1923 lyxpreamble += "\\setdefaultlanguage";
1924 if (!language->polyglossiaOpts().empty())
1925 lyxpreamble += "[" + from_ascii(language->polyglossiaOpts()) + "]";
1926 lyxpreamble += "{" + from_ascii(language->polyglossia()) + "}\n";
1927 // now setup the other languages
1928 std::map<std::string, std::string> const polylangs =
1929 features.getPolyglossiaLanguages();
1930 for (std::map<std::string, std::string>::const_iterator mit = polylangs.begin();
1931 mit != polylangs.end() ; ++mit) {
1932 lyxpreamble += "\\setotherlanguage";
1933 if (!mit->second.empty())
1934 lyxpreamble += "[" + from_ascii(mit->second) + "]";
1935 lyxpreamble += "{" + from_ascii(mit->first) + "}\n";
1939 // Load custom language package here
1940 if (features.langPackage() == LaTeXFeatures::LANG_PACK_CUSTOM) {
1941 if (lang_package == "default")
1942 lyxpreamble += from_utf8(lyxrc.language_custom_package);
1944 lyxpreamble += from_utf8(lang_package);
1945 lyxpreamble += '\n';
1948 docstring const i18npreamble =
1949 features.getTClassI18nPreamble(use_babel, use_polyglossia);
1950 if (!i18npreamble.empty())
1951 lyxpreamble += i18npreamble + '\n';
1959 void BufferParams::useClassDefaults()
1961 DocumentClass const & tclass = documentClass();
1963 sides = tclass.sides();
1964 columns = tclass.columns();
1965 pagestyle = tclass.pagestyle();
1966 use_default_options = true;
1967 // Only if class has a ToC hierarchy
1968 if (tclass.hasTocLevels()) {
1969 secnumdepth = tclass.secnumdepth();
1970 tocdepth = tclass.tocdepth();
1975 bool BufferParams::hasClassDefaults() const
1977 DocumentClass const & tclass = documentClass();
1979 return sides == tclass.sides()
1980 && columns == tclass.columns()
1981 && pagestyle == tclass.pagestyle()
1982 && use_default_options
1983 && secnumdepth == tclass.secnumdepth()
1984 && tocdepth == tclass.tocdepth();
1988 DocumentClass const & BufferParams::documentClass() const
1990 return *doc_class_.get();
1994 DocumentClassConstPtr BufferParams::documentClassPtr() const
2000 void BufferParams::setDocumentClass(DocumentClassConstPtr tc)
2002 // evil, but this function is evil
2003 doc_class_ = const_pointer_cast<DocumentClass>(tc);
2007 bool BufferParams::setBaseClass(string const & classname)
2009 LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
2010 LayoutFileList & bcl = LayoutFileList::get();
2011 if (!bcl.haveClass(classname)) {
2013 bformat(_("The layout file:\n"
2015 "could not be found. A default textclass with default\n"
2016 "layouts will be used. LyX will not be able to produce\n"
2018 from_utf8(classname));
2019 frontend::Alert::error(_("Document class not found"), s);
2020 bcl.addEmptyClass(classname);
2023 bool const success = bcl[classname].load();
2026 bformat(_("Due to some error in it, the layout file:\n"
2028 "could not be loaded. A default textclass with default\n"
2029 "layouts will be used. LyX will not be able to produce\n"
2031 from_utf8(classname));
2032 frontend::Alert::error(_("Could not load class"), s);
2033 bcl.addEmptyClass(classname);
2036 pimpl_->baseClass_ = classname;
2037 layout_modules_.adaptToBaseClass(baseClass(), removed_modules_);
2042 LayoutFile const * BufferParams::baseClass() const
2044 if (LayoutFileList::get().haveClass(pimpl_->baseClass_))
2045 return &(LayoutFileList::get()[pimpl_->baseClass_]);
2051 LayoutFileIndex const & BufferParams::baseClassID() const
2053 return pimpl_->baseClass_;
2057 void BufferParams::makeDocumentClass()
2062 LayoutModuleList mods;
2063 LayoutModuleList::iterator it;
2064 LayoutModuleList::iterator en;
2066 it = layout_modules_.begin();
2067 en = layout_modules_.end();
2068 for (; it != en; ++it)
2069 mods.push_back(*it);
2070 it = cite_engine_.begin();
2071 en = cite_engine_.end();
2072 for (; it != en; ++it)
2073 mods.push_back(*it);
2074 doc_class_ = getDocumentClass(*baseClass(), mods);
2076 if (!local_layout.empty()) {
2077 TextClass::ReturnValues success =
2078 doc_class_->read(local_layout, TextClass::MODULE);
2079 if (success != TextClass::OK && success != TextClass::OK_OLDFORMAT) {
2080 docstring const msg = _("Error reading internal layout information");
2081 frontend::Alert::warning(_("Read Error"), msg);
2087 bool BufferParams::moduleCanBeAdded(string const & modName) const
2089 return cite_engine_.moduleCanBeAdded(modName, baseClass()) &&
2090 layout_modules_.moduleCanBeAdded(modName, baseClass());
2094 bool BufferParams::addLayoutModule(string const & modName)
2096 LayoutModuleList::const_iterator it = layout_modules_.begin();
2097 LayoutModuleList::const_iterator end = layout_modules_.end();
2098 for (; it != end; ++it)
2101 layout_modules_.push_back(modName);
2106 string BufferParams::bufferFormat() const
2108 string format = documentClass().outputFormat();
2109 if (format == "latex") {
2112 if (encoding().package() == Encoding::japanese)
2119 bool BufferParams::isExportable(string const & format) const
2121 vector<string> backs = backends();
2122 for (vector<string>::const_iterator it = backs.begin();
2123 it != backs.end(); ++it)
2124 if (theConverters().isReachable(*it, format))
2132 bool formatSorter(Format const * lhs, Format const * rhs)
2134 return _(lhs->prettyname()) < _(rhs->prettyname());
2140 vector<Format const *> BufferParams::exportableFormats(bool only_viewable) const
2142 vector<string> const backs = backends();
2143 set<string> excludes;
2144 if (useNonTeXFonts) {
2145 excludes.insert("latex");
2146 excludes.insert("pdflatex");
2148 vector<Format const *> result =
2149 theConverters().getReachable(backs[0], only_viewable, true, excludes);
2150 for (vector<string>::const_iterator it = backs.begin() + 1;
2151 it != backs.end(); ++it) {
2152 vector<Format const *> r =
2153 theConverters().getReachable(*it, only_viewable, false, excludes);
2154 result.insert(result.end(), r.begin(), r.end());
2156 sort(result.begin(), result.end(), formatSorter);
2161 bool BufferParams::isExportableFormat(string const & format) const
2163 typedef vector<Format const *> Formats;
2165 formats = exportableFormats(true);
2166 Formats::const_iterator fit = formats.begin();
2167 Formats::const_iterator end = formats.end();
2168 for (; fit != end ; ++fit) {
2169 if ((*fit)->name() == format)
2176 vector<string> BufferParams::backends() const
2179 string const buffmt = bufferFormat();
2181 // FIXME: Don't hardcode format names here, but use a flag
2182 if (buffmt == "latex") {
2183 if (!useNonTeXFonts) {
2184 v.push_back("pdflatex");
2185 v.push_back("latex");
2187 v.push_back("luatex");
2188 v.push_back("dviluatex");
2189 v.push_back("xetex");
2190 } else if (buffmt == "xetex") {
2191 v.push_back("xetex");
2192 v.push_back("luatex");
2193 v.push_back("dviluatex");
2195 v.push_back(buffmt);
2197 v.push_back("xhtml");
2198 v.push_back("text");
2204 OutputParams::FLAVOR BufferParams::getOutputFlavor(string const format) const
2206 string const dformat = (format.empty() || format == "default") ?
2207 getDefaultOutputFormat() : format;
2208 DefaultFlavorCache::const_iterator it =
2209 default_flavors_.find(dformat);
2211 if (it != default_flavors_.end())
2214 OutputParams::FLAVOR result = OutputParams::LATEX;
2216 // FIXME It'd be better not to hardcode this, but to do
2217 // something with formats.
2218 if (dformat == "xhtml")
2219 result = OutputParams::HTML;
2220 else if (dformat == "text")
2221 result = OutputParams::TEXT;
2222 else if (dformat == "lyx")
2223 result = OutputParams::LYX;
2224 else if (dformat == "pdflatex")
2225 result = OutputParams::PDFLATEX;
2226 else if (dformat == "xetex")
2227 result = OutputParams::XETEX;
2228 else if (dformat == "luatex")
2229 result = OutputParams::LUATEX;
2230 else if (dformat == "dviluatex")
2231 result = OutputParams::DVILUATEX;
2233 // Try to determine flavor of default output format
2234 vector<string> backs = backends();
2235 if (find(backs.begin(), backs.end(), dformat) == backs.end()) {
2236 // Get shortest path to format
2237 Graph::EdgePath path;
2238 for (vector<string>::const_iterator it = backs.begin();
2239 it != backs.end(); ++it) {
2240 Graph::EdgePath p = theConverters().getPath(*it, dformat);
2241 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2246 result = theConverters().getFlavor(path);
2249 // cache this flavor
2250 default_flavors_[dformat] = result;
2255 string BufferParams::getDefaultOutputFormat() const
2257 if (!default_output_format.empty()
2258 && default_output_format != "default")
2259 return default_output_format;
2262 || encoding().package() == Encoding::japanese) {
2263 vector<Format const *> const formats = exportableFormats(true);
2264 if (formats.empty())
2266 // return the first we find
2267 return formats.front()->name();
2269 return lyxrc.default_view_format;
2272 Font const BufferParams::getFont() const
2274 FontInfo f = documentClass().defaultfont();
2275 if (fonts_default_family == "rmdefault")
2276 f.setFamily(ROMAN_FAMILY);
2277 else if (fonts_default_family == "sfdefault")
2278 f.setFamily(SANS_FAMILY);
2279 else if (fonts_default_family == "ttdefault")
2280 f.setFamily(TYPEWRITER_FAMILY);
2281 return Font(f, language);
2285 InsetQuotes::QuoteLanguage BufferParams::getQuoteStyle(string const qs) const
2287 return quoteslangtranslator().find(qs);
2291 bool BufferParams::isLatex() const
2293 return documentClass().outputType() == LATEX;
2297 bool BufferParams::isLiterate() const
2299 return documentClass().outputType() == LITERATE;
2303 bool BufferParams::isDocBook() const
2305 return documentClass().outputType() == DOCBOOK;
2309 void BufferParams::readPreamble(Lexer & lex)
2311 if (lex.getString() != "\\begin_preamble")
2312 lyxerr << "Error (BufferParams::readPreamble):"
2313 "consistency check failed." << endl;
2315 preamble = lex.getLongString("\\end_preamble");
2319 void BufferParams::readLocalLayout(Lexer & lex)
2321 if (lex.getString() != "\\begin_local_layout")
2322 lyxerr << "Error (BufferParams::readLocalLayout):"
2323 "consistency check failed." << endl;
2325 local_layout = lex.getLongString("\\end_local_layout");
2329 bool BufferParams::setLanguage(string const & lang)
2331 Language const *new_language = languages.getLanguage(lang);
2332 if (!new_language) {
2333 // Language lang was not found
2336 language = new_language;
2341 void BufferParams::readLanguage(Lexer & lex)
2343 if (!lex.next()) return;
2345 string const tmptok = lex.getString();
2347 // check if tmptok is part of tex_babel in tex-defs.h
2348 if (!setLanguage(tmptok)) {
2349 // Language tmptok was not found
2350 language = default_language;
2351 lyxerr << "Warning: Setting language `"
2352 << tmptok << "' to `" << language->lang()
2358 void BufferParams::readGraphicsDriver(Lexer & lex)
2363 string const tmptok = lex.getString();
2364 // check if tmptok is part of tex_graphics in tex_defs.h
2367 string const test = tex_graphics[n++];
2369 if (test == tmptok) {
2370 graphics_driver = tmptok;
2375 "Warning: graphics driver `$$Token' not recognized!\n"
2376 " Setting graphics driver to `default'.\n");
2377 graphics_driver = "default";
2384 void BufferParams::readBullets(Lexer & lex)
2389 int const index = lex.getInteger();
2391 int temp_int = lex.getInteger();
2392 user_defined_bullet(index).setFont(temp_int);
2393 temp_bullet(index).setFont(temp_int);
2395 user_defined_bullet(index).setCharacter(temp_int);
2396 temp_bullet(index).setCharacter(temp_int);
2398 user_defined_bullet(index).setSize(temp_int);
2399 temp_bullet(index).setSize(temp_int);
2403 void BufferParams::readBulletsLaTeX(Lexer & lex)
2405 // The bullet class should be able to read this.
2408 int const index = lex.getInteger();
2410 docstring const temp_str = lex.getDocString();
2412 user_defined_bullet(index).setText(temp_str);
2413 temp_bullet(index).setText(temp_str);
2417 void BufferParams::readModules(Lexer & lex)
2419 if (!lex.eatLine()) {
2420 lyxerr << "Error (BufferParams::readModules):"
2421 "Unexpected end of input." << endl;
2425 string mod = lex.getString();
2426 if (mod == "\\end_modules")
2428 addLayoutModule(mod);
2434 void BufferParams::readRemovedModules(Lexer & lex)
2436 if (!lex.eatLine()) {
2437 lyxerr << "Error (BufferParams::readRemovedModules):"
2438 "Unexpected end of input." << endl;
2442 string mod = lex.getString();
2443 if (mod == "\\end_removed_modules")
2445 removed_modules_.push_back(mod);
2448 // now we want to remove any removed modules that were previously
2449 // added. normally, that will be because default modules were added in
2450 // setBaseClass(), which gets called when \textclass is read at the
2451 // start of the read.
2452 list<string>::const_iterator rit = removed_modules_.begin();
2453 list<string>::const_iterator const ren = removed_modules_.end();
2454 for (; rit != ren; ++rit) {
2455 LayoutModuleList::iterator const mit = layout_modules_.begin();
2456 LayoutModuleList::iterator const men = layout_modules_.end();
2457 LayoutModuleList::iterator found = find(mit, men, *rit);
2460 layout_modules_.erase(found);
2465 void BufferParams::readIncludeonly(Lexer & lex)
2467 if (!lex.eatLine()) {
2468 lyxerr << "Error (BufferParams::readIncludeonly):"
2469 "Unexpected end of input." << endl;
2473 string child = lex.getString();
2474 if (child == "\\end_includeonly")
2476 included_children_.push_back(child);
2482 string BufferParams::paperSizeName(PapersizePurpose purpose) const
2484 switch (papersize) {
2486 // could be anything, so don't guess
2488 case PAPER_CUSTOM: {
2489 if (purpose == XDVI && !paperwidth.empty() &&
2490 !paperheight.empty()) {
2491 // heightxwidth<unit>
2492 string first = paperwidth;
2493 string second = paperheight;
2494 if (orientation == ORIENTATION_LANDSCAPE)
2497 return first.erase(first.length() - 2)
2503 // dvips and dvipdfm do not know this
2504 if (purpose == DVIPS || purpose == DVIPDFM)
2508 if (purpose == DVIPS || purpose == DVIPDFM)
2512 if (purpose == DVIPS || purpose == DVIPDFM)
2522 if (purpose == DVIPS || purpose == DVIPDFM)
2526 if (purpose == DVIPS || purpose == DVIPDFM)
2530 if (purpose == DVIPS || purpose == DVIPDFM)
2534 if (purpose == DVIPS || purpose == DVIPDFM)
2538 if (purpose == DVIPS || purpose == DVIPDFM)
2542 // dvipdfm does not know this
2543 if (purpose == DVIPDFM)
2547 if (purpose == DVIPDFM)
2551 if (purpose == DVIPS || purpose == DVIPDFM)
2555 if (purpose == DVIPS || purpose == DVIPDFM)
2559 if (purpose == DVIPS || purpose == DVIPDFM)
2563 if (purpose == DVIPS || purpose == DVIPDFM)
2567 if (purpose == DVIPS || purpose == DVIPDFM)
2571 if (purpose == DVIPS || purpose == DVIPDFM)
2575 if (purpose == DVIPS || purpose == DVIPDFM)
2579 if (purpose == DVIPS || purpose == DVIPDFM)
2583 if (purpose == DVIPS || purpose == DVIPDFM)
2587 if (purpose == DVIPS || purpose == DVIPDFM)
2591 if (purpose == DVIPS || purpose == DVIPDFM)
2595 if (purpose == DVIPS || purpose == DVIPDFM)
2599 if (purpose == DVIPS || purpose == DVIPDFM)
2603 if (purpose == DVIPS || purpose == DVIPDFM)
2607 if (purpose == DVIPS || purpose == DVIPDFM)
2610 case PAPER_USEXECUTIVE:
2611 // dvipdfm does not know this
2612 if (purpose == DVIPDFM)
2617 case PAPER_USLETTER:
2619 if (purpose == XDVI)
2626 string const BufferParams::dvips_options() const
2630 // If the class loads the geometry package, we do not know which
2631 // paper size is used, since we do not set it (bug 7013).
2632 // Therefore we must not specify any argument here.
2633 // dvips gets the correct paper size via DVI specials in this case
2634 // (if the class uses the geometry package correctly).
2635 if (documentClass().provides("geometry"))
2639 && papersize == PAPER_CUSTOM
2640 && !lyxrc.print_paper_dimension_flag.empty()
2641 && !paperwidth.empty()
2642 && !paperheight.empty()) {
2643 // using a custom papersize
2644 result = lyxrc.print_paper_dimension_flag;
2645 result += ' ' + paperwidth;
2646 result += ',' + paperheight;
2648 string const paper_option = paperSizeName(DVIPS);
2649 if (!paper_option.empty() && (paper_option != "letter" ||
2650 orientation != ORIENTATION_LANDSCAPE)) {
2651 // dvips won't accept -t letter -t landscape.
2652 // In all other cases, include the paper size
2654 result = lyxrc.print_paper_flag;
2655 result += ' ' + paper_option;
2658 if (orientation == ORIENTATION_LANDSCAPE &&
2659 papersize != PAPER_CUSTOM)
2660 result += ' ' + lyxrc.print_landscape_flag;
2665 string const BufferParams::font_encoding() const
2667 return (fontenc == "global") ? lyxrc.fontenc : fontenc;
2671 string BufferParams::babelCall(string const & lang_opts, bool const langoptions) const
2673 // suppress the babel call if there is no BabelName defined
2674 // for the document language in the lib/languages file and if no
2675 // other languages are used (lang_opts is then empty)
2676 if (lang_opts.empty())
2678 // either a specific language (AsBabelOptions setting in
2679 // lib/languages) or the prefs require the languages to
2680 // be submitted to babel itself (not the class).
2682 return "\\usepackage[" + lang_opts + "]{babel}";
2683 return "\\usepackage{babel}";
2687 docstring BufferParams::getGraphicsDriver(string const & package) const
2691 if (package == "geometry") {
2692 if (graphics_driver == "dvips"
2693 || graphics_driver == "dvipdfm"
2694 || graphics_driver == "pdftex"
2695 || graphics_driver == "vtex")
2696 result = from_ascii(graphics_driver);
2697 else if (graphics_driver == "dvipdfmx")
2698 result = from_ascii("dvipdfm");
2705 void BufferParams::writeEncodingPreamble(otexstream & os,
2706 LaTeXFeatures & features) const
2708 // XeTeX does not need this
2709 if (features.runparams().flavor == OutputParams::XETEX)
2711 // LuaTeX neither, but with tex fonts, we need to load
2712 // the luainputenc package.
2713 if (features.runparams().flavor == OutputParams::LUATEX
2714 || features.runparams().flavor == OutputParams::DVILUATEX) {
2715 if (!useNonTeXFonts && inputenc != "default"
2716 && ((inputenc == "auto" && language->encoding()->package() == Encoding::inputenc)
2717 || (inputenc != "auto" && encoding().package() == Encoding::inputenc))) {
2718 os << "\\usepackage[utf8]{luainputenc}\n";
2722 if (inputenc == "auto") {
2723 string const doc_encoding =
2724 language->encoding()->latexName();
2725 Encoding::Package const package =
2726 language->encoding()->package();
2728 // Create a list with all the input encodings used
2730 set<string> encodings =
2731 features.getEncodingSet(doc_encoding);
2733 // If the "japanese" package (i.e. pLaTeX) is used,
2734 // inputenc must be omitted.
2735 // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
2736 if ((!encodings.empty() || package == Encoding::inputenc)
2737 && !features.isRequired("japanese")) {
2738 os << "\\usepackage[";
2739 set<string>::const_iterator it = encodings.begin();
2740 set<string>::const_iterator const end = encodings.end();
2742 os << from_ascii(*it);
2745 for (; it != end; ++it)
2746 os << ',' << from_ascii(*it);
2747 if (package == Encoding::inputenc) {
2748 if (!encodings.empty())
2750 os << from_ascii(doc_encoding);
2752 os << "]{inputenc}\n";
2754 if (package == Encoding::CJK || features.mustProvide("CJK")) {
2755 if (language->encoding()->name() == "utf8-cjk"
2756 && LaTeXFeatures::isAvailable("CJKutf8"))
2757 os << "\\usepackage{CJKutf8}\n";
2759 os << "\\usepackage{CJK}\n";
2761 } else if (inputenc != "default") {
2762 switch (encoding().package()) {
2763 case Encoding::none:
2764 case Encoding::japanese:
2766 case Encoding::inputenc:
2767 // do not load inputenc if japanese is used
2768 if (features.isRequired("japanese"))
2770 os << "\\usepackage[" << from_ascii(inputenc)
2774 if (encoding().name() == "utf8-cjk"
2775 && LaTeXFeatures::isAvailable("CJKutf8"))
2776 os << "\\usepackage{CJKutf8}\n";
2778 os << "\\usepackage{CJK}\n";
2785 string const BufferParams::parseFontName(string const & name) const
2787 string mangled = name;
2788 size_t const idx = mangled.find('[');
2789 if (idx == string::npos || idx == 0)
2792 return mangled.substr(0, idx - 1);
2796 string const BufferParams::loadFonts(LaTeXFeatures & features) const
2798 if (fonts_roman == "default" && fonts_sans == "default"
2799 && fonts_typewriter == "default"
2800 && (fonts_math == "default" || fonts_math == "auto"))
2806 /* Fontspec (XeTeX, LuaTeX): we provide GUI support for oldstyle
2807 * numbers (Numbers=OldStyle) and sf/tt scaling. The Ligatures=TeX/
2808 * Mapping=tex-text option assures TeX ligatures (such as "--")
2809 * are resolved. Note that tt does not use these ligatures.
2811 * -- add more GUI options?
2812 * -- add more fonts (fonts for other scripts)
2813 * -- if there's a way to find out if a font really supports
2814 * OldStyle, enable/disable the widget accordingly.
2816 if (useNonTeXFonts && features.isAvailable("fontspec")) {
2817 // "Mapping=tex-text" and "Ligatures=TeX" are equivalent.
2818 // However, until v.2 (2010/07/11) fontspec only knew
2819 // Mapping=tex-text (for XeTeX only); then "Ligatures=TeX"
2820 // was introduced for both XeTeX and LuaTeX (LuaTeX
2821 // didn't understand "Mapping=tex-text", while XeTeX
2822 // understood both. With most recent versions, both
2823 // variants are understood by both engines. However,
2824 // we want to provide support for at least TeXLive 2009
2825 // (for XeTeX; LuaTeX is only supported as of v.2)
2826 string const texmapping =
2827 (features.runparams().flavor == OutputParams::XETEX) ?
2828 "Mapping=tex-text" : "Ligatures=TeX";
2829 if (fonts_roman != "default") {
2830 os << "\\setmainfont[" << texmapping;
2831 if (fonts_old_figures)
2832 os << ",Numbers=OldStyle";
2833 os << "]{" << parseFontName(fonts_roman) << "}\n";
2835 if (fonts_sans != "default") {
2836 string const sans = parseFontName(fonts_sans);
2837 if (fonts_sans_scale != 100)
2838 os << "\\setsansfont[Scale="
2839 << float(fonts_sans_scale) / 100
2840 << "," << texmapping << "]{"
2843 os << "\\setsansfont[" << texmapping << "]{"
2846 if (fonts_typewriter != "default") {
2847 string const mono = parseFontName(fonts_typewriter);
2848 if (fonts_typewriter_scale != 100)
2849 os << "\\setmonofont[Scale="
2850 << float(fonts_typewriter_scale) / 100
2854 os << "\\setmonofont{"
2861 bool const ot1 = (font_encoding() == "default" || font_encoding() == "OT1");
2862 bool const dryrun = features.runparams().dryrun;
2863 bool const complete = (fonts_sans == "default" && fonts_typewriter == "default");
2864 bool const nomath = (fonts_math == "default");
2867 os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_roman)).getLaTeXCode(
2868 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
2872 os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_sans)).getLaTeXCode(
2873 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
2874 nomath, fonts_sans_scale);
2876 // MONOSPACED/TYPEWRITER
2877 os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_typewriter)).getLaTeXCode(
2878 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
2879 nomath, fonts_typewriter_scale);
2882 os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_math)).getLaTeXCode(
2883 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
2890 Encoding const & BufferParams::encoding() const
2892 // FIXME: actually, we should check for the flavor
2893 // or runparams.isFullyUnicode() here:
2894 // This check will not work with XeTeX/LuaTeX and tex fonts.
2895 // Thus we have to reset the encoding in Buffer::makeLaTeXFile.
2897 return *(encodings.fromLaTeXName("utf8-plain"));
2898 if (inputenc == "auto" || inputenc == "default")
2899 return *language->encoding();
2900 Encoding const * const enc = encodings.fromLaTeXName(inputenc);
2903 LYXERR0("Unknown inputenc value `" << inputenc
2904 << "'. Using `auto' instead.");
2905 return *language->encoding();
2909 bool BufferParams::addCiteEngine(string const & engine)
2911 LayoutModuleList::const_iterator it = cite_engine_.begin();
2912 LayoutModuleList::const_iterator en = cite_engine_.end();
2913 for (; it != en; ++it)
2916 cite_engine_.push_back(engine);
2921 bool BufferParams::addCiteEngine(vector<string> const & engine)
2923 vector<string>::const_iterator it = engine.begin();
2924 vector<string>::const_iterator en = engine.end();
2926 for (; it != en; ++it)
2927 if (!addCiteEngine(*it))
2933 string const & BufferParams::defaultBiblioStyle() const
2935 return documentClass().defaultBiblioStyle();
2939 bool const & BufferParams::fullAuthorList() const
2941 return documentClass().fullAuthorList();
2945 void BufferParams::setCiteEngine(string const & engine)
2948 addCiteEngine(engine);
2952 void BufferParams::setCiteEngine(vector<string> const & engine)
2955 addCiteEngine(engine);
2959 vector<string> BufferParams::citeCommands() const
2961 static CitationStyle const default_style;
2962 vector<string> commands =
2963 documentClass().citeCommands(citeEngineType());
2964 if (commands.empty())
2965 commands.push_back(default_style.cmd);
2970 vector<CitationStyle> BufferParams::citeStyles() const
2972 static CitationStyle const default_style;
2973 vector<CitationStyle> styles =
2974 documentClass().citeStyles(citeEngineType());
2976 styles.push_back(default_style);