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 map<string, string> const & BufferParams::auto_packages()
448 static map<string, string> packages;
449 if (packages.empty()) {
450 // adding a package here implies a file format change!
451 packages["amsmath"] =
452 N_("The LaTeX package amsmath is only used if AMS formula types or symbols from the AMS math toolbars are inserted into formulas");
453 packages["amssymb"] =
454 N_("The LaTeX package amssymb is only used if symbols from the AMS math toolbars are inserted into formulas");
456 N_("The LaTeX package cancel is only used if \\cancel commands are used in formulas");
458 N_("The LaTeX package esint is only used if special integral symbols are inserted into formulas");
459 packages["mathdots"] =
460 N_("The LaTeX package mathdots is only used if the command \\iddots is inserted into formulas");
461 packages["mathtools"] =
462 N_("The LaTeX package mathtools is only used if some mathematical relations are inserted into formulas");
464 N_("The LaTeX package mhchem is only used if either the command \\ce or \\cf is inserted into formulas");
465 packages["stackrel"] =
466 N_("The LaTeX package stackrel is only used if the command \\stackrel with subscript is inserted into formulas");
467 packages["stmaryrd"] =
468 N_("The LaTeX package stmaryrd is only used if symbols from the St Mary's Road symbol font for theoretical computer science are inserted into formulas");
469 packages["undertilde"] =
470 N_("The LaTeX package undertilde is only used if you use the math frame decoration 'utilde'");
476 AuthorList & BufferParams::authors()
478 return pimpl_->authorlist;
482 AuthorList const & BufferParams::authors() const
484 return pimpl_->authorlist;
488 BranchList & BufferParams::branchlist()
490 return pimpl_->branchlist;
494 BranchList const & BufferParams::branchlist() const
496 return pimpl_->branchlist;
500 IndicesList & BufferParams::indiceslist()
502 return pimpl_->indiceslist;
506 IndicesList const & BufferParams::indiceslist() const
508 return pimpl_->indiceslist;
512 Bullet & BufferParams::temp_bullet(lyx::size_type const index)
514 LASSERT(index < 4, /**/);
515 return pimpl_->temp_bullets[index];
519 Bullet const & BufferParams::temp_bullet(lyx::size_type const index) const
521 LASSERT(index < 4, /**/);
522 return pimpl_->temp_bullets[index];
526 Bullet & BufferParams::user_defined_bullet(lyx::size_type const index)
528 LASSERT(index < 4, /**/);
529 return pimpl_->user_defined_bullets[index];
533 Bullet const & BufferParams::user_defined_bullet(lyx::size_type const index) const
535 LASSERT(index < 4, /**/);
536 return pimpl_->user_defined_bullets[index];
540 Spacing & BufferParams::spacing()
542 return pimpl_->spacing;
546 Spacing const & BufferParams::spacing() const
548 return pimpl_->spacing;
552 PDFOptions & BufferParams::pdfoptions()
554 return pimpl_->pdfoptions;
558 PDFOptions const & BufferParams::pdfoptions() const
560 return pimpl_->pdfoptions;
564 HSpace const & BufferParams::getIndentation() const
566 return pimpl_->indentation;
570 void BufferParams::setIndentation(HSpace const & indent)
572 pimpl_->indentation = indent;
576 VSpace const & BufferParams::getDefSkip() const
578 return pimpl_->defskip;
582 void BufferParams::setDefSkip(VSpace const & vs)
584 // DEFSKIP will cause an infinite loop
585 LASSERT(vs.kind() != VSpace::DEFSKIP, return);
586 pimpl_->defskip = vs;
590 string BufferParams::readToken(Lexer & lex, string const & token,
591 FileName const & filepath)
593 if (token == "\\textclass") {
595 string const classname = lex.getString();
596 // if there exists a local layout file, ignore the system one
597 // NOTE: in this case, the textclass (.cls file) is assumed to
600 LayoutFileList & bcl = LayoutFileList::get();
601 if (tcp.empty() && !filepath.empty())
602 tcp = bcl.addLocalLayout(classname, filepath.absFileName());
606 setBaseClass(classname);
607 // We assume that a tex class exists for local or unknown
608 // layouts so this warning, will only be given for system layouts.
609 if (!baseClass()->isTeXClassAvailable()) {
610 docstring const desc =
611 translateIfPossible(from_utf8(baseClass()->description()));
612 docstring const prereqs =
613 from_utf8(baseClass()->prerequisites());
614 docstring const msg =
615 bformat(_("The selected document class\n"
617 "requires external files that are not available.\n"
618 "The document class can still be used, but the\n"
619 "document cannot be compiled until the following\n"
620 "prerequisites are installed:\n"
622 "See section 3.1.2.2 (Class Availability) of the\n"
623 "User's Guide for more information."), desc, prereqs);
624 frontend::Alert::warning(_("Document class not available"),
627 } else if (token == "\\begin_preamble") {
629 } else if (token == "\\begin_local_layout") {
630 readLocalLayout(lex);
631 } else if (token == "\\begin_modules") {
633 } else if (token == "\\begin_removed_modules") {
634 readRemovedModules(lex);
635 } else if (token == "\\begin_includeonly") {
636 readIncludeonly(lex);
637 } else if (token == "\\maintain_unincluded_children") {
638 lex >> maintain_unincluded_children;
639 } else if (token == "\\options") {
641 options = lex.getString();
642 } else if (token == "\\use_default_options") {
643 lex >> use_default_options;
644 } else if (token == "\\master") {
646 master = lex.getString();
647 } else if (token == "\\suppress_date") {
648 lex >> suppress_date;
649 } else if (token == "\\justification") {
650 lex >> justification;
651 } else if (token == "\\language") {
653 } else if (token == "\\language_package") {
655 lang_package = lex.getString();
656 } else if (token == "\\inputencoding") {
658 } else if (token == "\\graphics") {
659 readGraphicsDriver(lex);
660 } else if (token == "\\default_output_format") {
661 lex >> default_output_format;
662 } else if (token == "\\bibtex_command") {
664 bibtex_command = lex.getString();
665 } else if (token == "\\index_command") {
667 index_command = lex.getString();
668 } else if (token == "\\fontencoding") {
670 fontenc = lex.getString();
671 } else if (token == "\\font_roman") {
673 fonts_roman = lex.getString();
674 } else if (token == "\\font_sans") {
676 fonts_sans = lex.getString();
677 } else if (token == "\\font_typewriter") {
679 fonts_typewriter = lex.getString();
680 } else if (token == "\\font_math") {
682 fonts_math = lex.getString();
683 } else if (token == "\\font_default_family") {
684 lex >> fonts_default_family;
685 } else if (token == "\\use_non_tex_fonts") {
686 lex >> useNonTeXFonts;
687 } else if (token == "\\font_sc") {
688 lex >> fonts_expert_sc;
689 } else if (token == "\\font_osf") {
690 lex >> fonts_old_figures;
691 } else if (token == "\\font_sf_scale") {
692 lex >> fonts_sans_scale;
693 } else if (token == "\\font_tt_scale") {
694 lex >> fonts_typewriter_scale;
695 } else if (token == "\\font_cjk") {
697 } else if (token == "\\paragraph_separation") {
700 paragraph_separation = parseptranslator().find(parsep);
701 } else if (token == "\\paragraph_indentation") {
703 string indentation = lex.getString();
704 pimpl_->indentation = HSpace(indentation);
705 } else if (token == "\\defskip") {
707 string const defskip = lex.getString();
708 pimpl_->defskip = VSpace(defskip);
709 if (pimpl_->defskip.kind() == VSpace::DEFSKIP)
711 pimpl_->defskip = VSpace(VSpace::MEDSKIP);
712 } else if (token == "\\quotes_language") {
715 quotes_language = quoteslangtranslator().find(quotes_lang);
716 } else if (token == "\\papersize") {
719 papersize = papersizetranslator().find(ppsize);
720 } else if (token == "\\use_geometry") {
722 } else if (token == "\\use_package") {
727 use_package(package, packagetranslator().find(use));
728 } else if (token == "\\cite_engine") {
730 vector<string> engine = getVectorFromString(lex.getString());
731 setCiteEngine(engine);
732 } else if (token == "\\cite_engine_type") {
735 cite_engine_type_ = citeenginetypetranslator().find(engine_type);
736 } else if (token == "\\biblio_style") {
738 biblio_style = lex.getString();
739 } else if (token == "\\use_bibtopic") {
741 } else if (token == "\\use_indices") {
743 } else if (token == "\\tracking_changes") {
745 } else if (token == "\\output_changes") {
746 lex >> outputChanges;
747 } else if (token == "\\branch") {
749 docstring branch = lex.getDocString();
750 branchlist().add(branch);
753 string const tok = lex.getString();
754 if (tok == "\\end_branch")
756 Branch * branch_ptr = branchlist().find(branch);
757 if (tok == "\\selected") {
760 branch_ptr->setSelected(lex.getInteger());
762 if (tok == "\\filename_suffix") {
765 branch_ptr->setFileNameSuffix(lex.getInteger());
767 if (tok == "\\color") {
769 string color = lex.getString();
771 branch_ptr->setColor(color);
772 // Update also the Color table:
774 color = lcolor.getX11Name(Color_background);
776 lcolor.setColor(to_utf8(branch), color);
779 } else if (token == "\\index") {
781 docstring index = lex.getDocString();
783 indiceslist().add(index);
786 string const tok = lex.getString();
787 if (tok == "\\end_index")
789 Index * index_ptr = indiceslist().find(index);
790 if (tok == "\\shortcut") {
792 shortcut = lex.getDocString();
794 index_ptr->setShortcut(shortcut);
796 if (tok == "\\color") {
798 string color = lex.getString();
800 index_ptr->setColor(color);
801 // Update also the Color table:
803 color = lcolor.getX11Name(Color_background);
805 if (!shortcut.empty())
806 lcolor.setColor(to_utf8(shortcut), color);
809 } else if (token == "\\author") {
811 istringstream ss(lex.getString());
814 author_map[a.bufferId()] = pimpl_->authorlist.record(a);
815 } else if (token == "\\paperorientation") {
818 orientation = paperorientationtranslator().find(orient);
819 } else if (token == "\\backgroundcolor") {
821 backgroundcolor = lyx::rgbFromHexName(lex.getString());
822 isbackgroundcolor = true;
823 } else if (token == "\\fontcolor") {
825 fontcolor = lyx::rgbFromHexName(lex.getString());
827 } else if (token == "\\notefontcolor") {
829 string color = lex.getString();
830 notefontcolor = lyx::rgbFromHexName(color);
831 lcolor.setColor("notefontcolor", color);
832 } else if (token == "\\boxbgcolor") {
834 string color = lex.getString();
835 boxbgcolor = lyx::rgbFromHexName(color);
836 lcolor.setColor("boxbgcolor", color);
837 } else if (token == "\\paperwidth") {
839 } else if (token == "\\paperheight") {
841 } else if (token == "\\leftmargin") {
843 } else if (token == "\\topmargin") {
845 } else if (token == "\\rightmargin") {
847 } else if (token == "\\bottommargin") {
849 } else if (token == "\\headheight") {
851 } else if (token == "\\headsep") {
853 } else if (token == "\\footskip") {
855 } else if (token == "\\columnsep") {
857 } else if (token == "\\paperfontsize") {
859 } else if (token == "\\papercolumns") {
861 } else if (token == "\\listings_params") {
864 listings_params = InsetListingsParams(par).params();
865 } else if (token == "\\papersides") {
868 sides = sidestranslator().find(psides);
869 } else if (token == "\\paperpagestyle") {
871 } else if (token == "\\bullet") {
873 } else if (token == "\\bulletLaTeX") {
874 readBulletsLaTeX(lex);
875 } else if (token == "\\secnumdepth") {
877 } else if (token == "\\tocdepth") {
879 } else if (token == "\\spacing") {
883 if (nspacing == "other") {
886 spacing().set(spacetranslator().find(nspacing), tmp_val);
887 } else if (token == "\\float_placement") {
888 lex >> float_placement;
890 } else if (prefixIs(token, "\\pdf_") || token == "\\use_hyperref") {
891 string toktmp = pdfoptions().readToken(lex, token);
892 if (!toktmp.empty()) {
893 lyxerr << "PDFOptions::readToken(): Unknown token: " <<
897 } else if (token == "\\html_math_output") {
900 html_math_output = static_cast<MathOutput>(temp);
901 } else if (token == "\\html_be_strict") {
902 lex >> html_be_strict;
903 } else if (token == "\\html_css_as_file") {
904 lex >> html_css_as_file;
905 } else if (token == "\\html_math_img_scale") {
906 lex >> html_math_img_scale;
907 } else if (token == "\\html_latex_start") {
909 html_latex_start = lex.getString();
910 } else if (token == "\\html_latex_end") {
912 html_latex_end = lex.getString();
913 } else if (token == "\\output_sync") {
915 } else if (token == "\\output_sync_macro") {
916 lex >> output_sync_macro;
917 } else if (token == "\\use_refstyle") {
920 lyxerr << "BufferParams::readToken(): Unknown token: " <<
929 void BufferParams::writeFile(ostream & os) const
931 // The top of the file is written by the buffer.
932 // Prints out the buffer info into the .lyx file given by file
935 os << "\\textclass " << baseClass()->name() << '\n';
938 if (!preamble.empty()) {
939 // remove '\n' from the end of preamble
940 string const tmppreamble = rtrim(preamble, "\n");
941 os << "\\begin_preamble\n"
943 << "\n\\end_preamble\n";
947 if (!options.empty()) {
948 os << "\\options " << options << '\n';
951 // use the class options defined in the layout?
952 os << "\\use_default_options "
953 << convert<string>(use_default_options) << "\n";
955 // the master document
956 if (!master.empty()) {
957 os << "\\master " << master << '\n';
961 if (!removed_modules_.empty()) {
962 os << "\\begin_removed_modules" << '\n';
963 list<string>::const_iterator it = removed_modules_.begin();
964 list<string>::const_iterator en = removed_modules_.end();
965 for (; it != en; ++it)
967 os << "\\end_removed_modules" << '\n';
971 if (!layout_modules_.empty()) {
972 os << "\\begin_modules" << '\n';
973 LayoutModuleList::const_iterator it = layout_modules_.begin();
974 LayoutModuleList::const_iterator en = layout_modules_.end();
975 for (; it != en; ++it)
977 os << "\\end_modules" << '\n';
981 if (!included_children_.empty()) {
982 os << "\\begin_includeonly" << '\n';
983 list<string>::const_iterator it = included_children_.begin();
984 list<string>::const_iterator en = included_children_.end();
985 for (; it != en; ++it)
987 os << "\\end_includeonly" << '\n';
989 os << "\\maintain_unincluded_children "
990 << convert<string>(maintain_unincluded_children) << '\n';
992 // local layout information
993 if (!local_layout.empty()) {
994 // remove '\n' from the end
995 string const tmplocal = rtrim(local_layout, "\n");
996 os << "\\begin_local_layout\n"
998 << "\n\\end_local_layout\n";
1001 // then the text parameters
1002 if (language != ignore_language)
1003 os << "\\language " << language->lang() << '\n';
1004 os << "\\language_package " << lang_package
1005 << "\n\\inputencoding " << inputenc
1006 << "\n\\fontencoding " << fontenc
1007 << "\n\\font_roman " << fonts_roman
1008 << "\n\\font_sans " << fonts_sans
1009 << "\n\\font_typewriter " << fonts_typewriter
1010 << "\n\\font_math " << fonts_math
1011 << "\n\\font_default_family " << fonts_default_family
1012 << "\n\\use_non_tex_fonts " << convert<string>(useNonTeXFonts)
1013 << "\n\\font_sc " << convert<string>(fonts_expert_sc)
1014 << "\n\\font_osf " << convert<string>(fonts_old_figures)
1015 << "\n\\font_sf_scale " << fonts_sans_scale
1016 << "\n\\font_tt_scale " << fonts_typewriter_scale
1018 if (!fonts_cjk.empty()) {
1019 os << "\\font_cjk " << fonts_cjk << '\n';
1021 os << "\\graphics " << graphics_driver << '\n';
1022 os << "\\default_output_format " << default_output_format << '\n';
1023 os << "\\output_sync " << output_sync << '\n';
1024 if (!output_sync_macro.empty())
1025 os << "\\output_sync_macro \"" << output_sync_macro << "\"\n";
1026 os << "\\bibtex_command " << bibtex_command << '\n';
1027 os << "\\index_command " << index_command << '\n';
1029 if (!float_placement.empty()) {
1030 os << "\\float_placement " << float_placement << '\n';
1032 os << "\\paperfontsize " << fontsize << '\n';
1034 spacing().writeFile(os);
1035 pdfoptions().writeFile(os);
1037 os << "\\papersize " << string_papersize[papersize]
1038 << "\n\\use_geometry " << convert<string>(use_geometry);
1039 map<string, string> const & packages = auto_packages();
1040 for (map<string, string>::const_iterator it = packages.begin();
1041 it != packages.end(); ++it)
1042 os << "\n\\use_package " << it->first << ' '
1043 << use_package(it->first);
1045 os << "\n\\cite_engine ";
1047 if (!cite_engine_.empty()) {
1048 LayoutModuleList::const_iterator be = cite_engine_.begin();
1049 LayoutModuleList::const_iterator en = cite_engine_.end();
1050 for (LayoutModuleList::const_iterator it = be; it != en; ++it) {
1059 os << "\n\\cite_engine_type " << citeenginetypetranslator().find(cite_engine_type_)
1060 << "\n\\biblio_style " << biblio_style
1061 << "\n\\use_bibtopic " << convert<string>(use_bibtopic)
1062 << "\n\\use_indices " << convert<string>(use_indices)
1063 << "\n\\paperorientation " << string_orientation[orientation]
1064 << "\n\\suppress_date " << convert<string>(suppress_date)
1065 << "\n\\justification " << convert<string>(justification)
1066 << "\n\\use_refstyle " << use_refstyle
1068 if (isbackgroundcolor == true)
1069 os << "\\backgroundcolor " << lyx::X11hexname(backgroundcolor) << '\n';
1070 if (isfontcolor == true)
1071 os << "\\fontcolor " << lyx::X11hexname(fontcolor) << '\n';
1072 if (notefontcolor != lyx::rgbFromHexName("#cccccc"))
1073 os << "\\notefontcolor " << lyx::X11hexname(notefontcolor) << '\n';
1074 if (boxbgcolor != lyx::rgbFromHexName("#ff0000"))
1075 os << "\\boxbgcolor " << lyx::X11hexname(boxbgcolor) << '\n';
1077 BranchList::const_iterator it = branchlist().begin();
1078 BranchList::const_iterator end = branchlist().end();
1079 for (; it != end; ++it) {
1080 os << "\\branch " << to_utf8(it->branch())
1081 << "\n\\selected " << it->isSelected()
1082 << "\n\\filename_suffix " << it->hasFileNameSuffix()
1083 << "\n\\color " << lyx::X11hexname(it->color())
1088 IndicesList::const_iterator iit = indiceslist().begin();
1089 IndicesList::const_iterator iend = indiceslist().end();
1090 for (; iit != iend; ++iit) {
1091 os << "\\index " << to_utf8(iit->index())
1092 << "\n\\shortcut " << to_utf8(iit->shortcut())
1093 << "\n\\color " << lyx::X11hexname(iit->color())
1098 if (!paperwidth.empty())
1099 os << "\\paperwidth "
1100 << VSpace(paperwidth).asLyXCommand() << '\n';
1101 if (!paperheight.empty())
1102 os << "\\paperheight "
1103 << VSpace(paperheight).asLyXCommand() << '\n';
1104 if (!leftmargin.empty())
1105 os << "\\leftmargin "
1106 << VSpace(leftmargin).asLyXCommand() << '\n';
1107 if (!topmargin.empty())
1108 os << "\\topmargin "
1109 << VSpace(topmargin).asLyXCommand() << '\n';
1110 if (!rightmargin.empty())
1111 os << "\\rightmargin "
1112 << VSpace(rightmargin).asLyXCommand() << '\n';
1113 if (!bottommargin.empty())
1114 os << "\\bottommargin "
1115 << VSpace(bottommargin).asLyXCommand() << '\n';
1116 if (!headheight.empty())
1117 os << "\\headheight "
1118 << VSpace(headheight).asLyXCommand() << '\n';
1119 if (!headsep.empty())
1121 << VSpace(headsep).asLyXCommand() << '\n';
1122 if (!footskip.empty())
1124 << VSpace(footskip).asLyXCommand() << '\n';
1125 if (!columnsep.empty())
1126 os << "\\columnsep "
1127 << VSpace(columnsep).asLyXCommand() << '\n';
1128 os << "\\secnumdepth " << secnumdepth
1129 << "\n\\tocdepth " << tocdepth
1130 << "\n\\paragraph_separation "
1131 << string_paragraph_separation[paragraph_separation];
1132 if (!paragraph_separation)
1133 os << "\n\\paragraph_indentation " << getIndentation().asLyXCommand();
1135 os << "\n\\defskip " << getDefSkip().asLyXCommand();
1136 os << "\n\\quotes_language "
1137 << string_quotes_language[quotes_language]
1138 << "\n\\papercolumns " << columns
1139 << "\n\\papersides " << sides
1140 << "\n\\paperpagestyle " << pagestyle << '\n';
1141 if (!listings_params.empty())
1142 os << "\\listings_params \"" <<
1143 InsetListingsParams(listings_params).encodedString() << "\"\n";
1144 for (int i = 0; i < 4; ++i) {
1145 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1146 if (user_defined_bullet(i).getFont() != -1) {
1147 os << "\\bullet " << i << " "
1148 << user_defined_bullet(i).getFont() << " "
1149 << user_defined_bullet(i).getCharacter() << " "
1150 << user_defined_bullet(i).getSize() << "\n";
1154 os << "\\bulletLaTeX " << i << " \""
1155 << lyx::to_ascii(user_defined_bullet(i).getText())
1161 os << "\\tracking_changes " << convert<string>(trackChanges) << '\n'
1162 << "\\output_changes " << convert<string>(outputChanges) << '\n'
1163 << "\\html_math_output " << html_math_output << '\n'
1164 << "\\html_css_as_file " << html_css_as_file << '\n'
1165 << "\\html_be_strict " << convert<string>(html_be_strict) << '\n';
1167 if (html_math_img_scale != 1.0)
1168 os << "\\html_math_img_scale " << convert<string>(html_math_img_scale) << '\n';
1169 if (!html_latex_start.empty())
1170 os << "\\html_latex_start " << html_latex_start << '\n';
1171 if (!html_latex_end.empty())
1172 os << "\\html_latex_end " << html_latex_end << '\n';
1174 os << pimpl_->authorlist;
1178 void BufferParams::validate(LaTeXFeatures & features) const
1180 features.require(documentClass().requires());
1182 if (columns > 1 && language->rightToLeft())
1183 features.require("rtloutputdblcol");
1185 if (outputChanges) {
1186 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1187 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1188 LaTeXFeatures::isAvailable("xcolor");
1190 switch (features.runparams().flavor) {
1191 case OutputParams::LATEX:
1192 case OutputParams::DVILUATEX:
1194 features.require("ct-dvipost");
1195 features.require("dvipost");
1196 } else if (xcolorulem) {
1197 features.require("ct-xcolor-ulem");
1198 features.require("ulem");
1199 features.require("xcolor");
1201 features.require("ct-none");
1204 case OutputParams::LUATEX:
1205 case OutputParams::PDFLATEX:
1206 case OutputParams::XETEX:
1208 features.require("ct-xcolor-ulem");
1209 features.require("ulem");
1210 features.require("xcolor");
1211 // improves color handling in PDF output
1212 features.require("pdfcolmk");
1214 features.require("ct-none");
1222 // Floats with 'Here definitely' as default setting.
1223 if (float_placement.find('H') != string::npos)
1224 features.require("float");
1226 for (PackageMap::const_iterator it = use_packages.begin();
1227 it != use_packages.end(); ++it) {
1228 if (it->first == "amsmath") {
1229 // AMS Style is at document level
1230 if (it->second == package_on ||
1231 features.isProvided("amsmath"))
1232 features.require(it->first);
1233 } else if (it->second == package_on)
1234 features.require(it->first);
1237 // Document-level line spacing
1238 if (spacing().getSpace() != Spacing::Single && !spacing().isDefault())
1239 features.require("setspace");
1241 // the bullet shapes are buffer level not paragraph level
1242 // so they are tested here
1243 for (int i = 0; i < 4; ++i) {
1244 if (user_defined_bullet(i) == ITEMIZE_DEFAULTS[i])
1246 int const font = user_defined_bullet(i).getFont();
1248 int const c = user_defined_bullet(i).getCharacter();
1254 features.require("latexsym");
1256 } else if (font == 1) {
1257 features.require("amssymb");
1258 } else if (font >= 2 && font <= 5) {
1259 features.require("pifont");
1263 if (pdfoptions().use_hyperref) {
1264 features.require("hyperref");
1265 // due to interferences with babel and hyperref, the color package has to
1266 // be loaded after hyperref when hyperref is used with the colorlinks
1267 // option, see http://www.lyx.org/trac/ticket/5291
1268 if (pdfoptions().colorlinks)
1269 features.require("color");
1272 // some languages are only available via polyglossia
1273 if (features.runparams().flavor == OutputParams::XETEX
1274 && (features.hasPolyglossiaExclusiveLanguages()
1276 features.require("polyglossia");
1278 if (useNonTeXFonts && fonts_math != "auto")
1279 features.require("unicode-math");
1281 if (!language->requires().empty())
1282 features.require(language->requires());
1286 bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
1287 FileName const & filepath) const
1289 // http://www.tug.org/texmf-dist/doc/latex/base/fixltx2e.pdf
1290 // !! To use the Fix-cm package, load it before \documentclass, and use the command
1291 // \RequirePackage to do so, rather than the normal \usepackage
1292 // Do not try to load any other package before the document class, unless you
1293 // have a thorough understanding of the LATEX internals and know exactly what you
1295 if (features.mustProvide("fix-cm"))
1296 os << "\\RequirePackage{fix-cm}\n";
1298 os << "\\documentclass";
1300 DocumentClass const & tclass = documentClass();
1302 ostringstream clsoptions; // the document class options.
1304 if (tokenPos(tclass.opt_fontsize(),
1305 '|', fontsize) >= 0) {
1306 // only write if existing in list (and not default)
1307 clsoptions << fontsize << "pt,";
1310 // all paper sizes except of A4, A5, B5 and the US sizes need the
1312 bool nonstandard_papersize = papersize != PAPER_DEFAULT
1313 && papersize != PAPER_USLETTER
1314 && papersize != PAPER_USLEGAL
1315 && papersize != PAPER_USEXECUTIVE
1316 && papersize != PAPER_A4
1317 && papersize != PAPER_A5
1318 && papersize != PAPER_B5;
1320 if (!use_geometry) {
1321 switch (papersize) {
1323 clsoptions << "a4paper,";
1325 case PAPER_USLETTER:
1326 clsoptions << "letterpaper,";
1329 clsoptions << "a5paper,";
1332 clsoptions << "b5paper,";
1334 case PAPER_USEXECUTIVE:
1335 clsoptions << "executivepaper,";
1338 clsoptions << "legalpaper,";
1372 if (sides != tclass.sides()) {
1375 clsoptions << "oneside,";
1378 clsoptions << "twoside,";
1384 if (columns != tclass.columns()) {
1386 clsoptions << "twocolumn,";
1388 clsoptions << "onecolumn,";
1392 && orientation == ORIENTATION_LANDSCAPE)
1393 clsoptions << "landscape,";
1395 // language should be a parameter to \documentclass
1396 if (language->babel() == "hebrew"
1397 && default_language->babel() != "hebrew")
1398 // This seems necessary
1399 features.useLanguage(default_language);
1401 ostringstream language_options;
1402 bool const use_babel = features.useBabel() && !features.isProvided("babel");
1403 bool const use_polyglossia = features.usePolyglossia();
1404 bool const global = lyxrc.language_global_options;
1405 if (use_babel || (use_polyglossia && global)) {
1406 language_options << features.getBabelLanguages();
1407 if (!language->babel().empty()) {
1408 if (!language_options.str().empty())
1409 language_options << ',';
1410 language_options << language->babel();
1412 if (global && !features.needBabelLangOptions()
1413 && !language_options.str().empty())
1414 clsoptions << language_options.str() << ',';
1417 // the predefined options from the layout
1418 if (use_default_options && !tclass.options().empty())
1419 clsoptions << tclass.options() << ',';
1421 // the user-defined options
1422 if (!options.empty()) {
1423 clsoptions << options << ',';
1426 string strOptions(clsoptions.str());
1427 if (!strOptions.empty()) {
1428 strOptions = rtrim(strOptions, ",");
1430 os << '[' << from_utf8(strOptions) << ']';
1433 os << '{' << from_ascii(tclass.latexname()) << "}\n";
1434 // end of \documentclass defs
1436 // if we use fontspec, we have to load the AMS packages here
1437 string const ams = features.loadAMSPackages();
1438 if (useNonTeXFonts && !ams.empty())
1439 os << from_ascii(ams);
1441 if (useNonTeXFonts) {
1442 os << "\\usepackage{fontspec}\n";
1443 if (features.mustProvide("unicode-math")
1444 && features.isAvailable("unicode-math"))
1445 os << "\\usepackage{unicode-math}\n";
1448 // font selection must be done before loading fontenc.sty
1449 string const fonts = loadFonts(features);
1451 os << from_utf8(fonts);
1453 if (fonts_default_family != "default")
1454 os << "\\renewcommand{\\familydefault}{\\"
1455 << from_ascii(fonts_default_family) << "}\n";
1457 // set font encoding
1458 // for arabic_arabi and farsi we also need to load the LAE and
1460 // XeTeX and LuaTeX (with OS fonts) work without fontenc
1461 if (font_encoding() != "default" && language->lang() != "japanese"
1462 && !useNonTeXFonts && !features.isProvided("fontenc")) {
1463 docstring extra_encoding;
1464 if (features.mustProvide("textgreek"))
1465 extra_encoding += from_ascii("LGR");
1466 if (features.mustProvide("textcyr")) {
1467 if (!extra_encoding.empty())
1468 extra_encoding.push_back(',');
1469 extra_encoding += from_ascii("T2A");
1471 if (!extra_encoding.empty() && !font_encoding().empty())
1472 extra_encoding.push_back(',');
1473 size_t fars = language_options.str().find("farsi");
1474 size_t arab = language_options.str().find("arabic");
1475 if (language->lang() == "arabic_arabi"
1476 || language->lang() == "farsi" || fars != string::npos
1477 || arab != string::npos) {
1478 os << "\\usepackage[" << extra_encoding
1479 << from_ascii(font_encoding())
1480 << ",LFE,LAE]{fontenc}\n";
1482 os << "\\usepackage[" << extra_encoding
1483 << from_ascii(font_encoding())
1488 // handle inputenc etc.
1489 writeEncodingPreamble(os, features);
1492 if (!features.runparams().includeall && !included_children_.empty()) {
1493 os << "\\includeonly{";
1494 list<string>::const_iterator it = included_children_.begin();
1495 list<string>::const_iterator en = included_children_.end();
1497 for (; it != en; ++it) {
1498 string incfile = *it;
1499 FileName inc = makeAbsPath(incfile, filepath.absFileName());
1500 string mangled = DocFileName(changeExtension(inc.absFileName(), ".tex")).
1502 if (!features.runparams().nice)
1504 // \includeonly doesn't want an extension
1505 incfile = changeExtension(incfile, string());
1506 incfile = support::latex_path(incfile);
1507 if (!incfile.empty()) {
1510 os << from_utf8(incfile);
1517 if (!listings_params.empty() || features.isRequired("listings"))
1518 os << "\\usepackage{listings}\n";
1520 if (!listings_params.empty()) {
1522 // do not test validity because listings_params is
1523 // supposed to be valid
1525 InsetListingsParams(listings_params).separatedParams(true);
1526 // we can't support all packages, but we should load the color package
1527 if (par.find("\\color", 0) != string::npos)
1528 features.require("color");
1529 os << from_utf8(par)
1532 if (!features.isProvided("geometry")
1533 && (use_geometry || nonstandard_papersize)) {
1534 odocstringstream ods;
1535 if (!getGraphicsDriver("geometry").empty())
1536 ods << getGraphicsDriver("geometry");
1537 if (orientation == ORIENTATION_LANDSCAPE)
1538 ods << ",landscape";
1539 switch (papersize) {
1541 if (!paperwidth.empty())
1542 ods << ",paperwidth="
1543 << from_ascii(paperwidth);
1544 if (!paperheight.empty())
1545 ods << ",paperheight="
1546 << from_ascii(paperheight);
1548 case PAPER_USLETTER:
1549 ods << ",letterpaper";
1552 ods << ",legalpaper";
1554 case PAPER_USEXECUTIVE:
1555 ods << ",executivepaper";
1644 docstring const g_options = trim(ods.str(), ",");
1645 os << "\\usepackage";
1646 if (!g_options.empty())
1647 os << '[' << g_options << ']';
1648 os << "{geometry}\n";
1649 // output this only if use_geometry is true
1651 os << "\\geometry{verbose";
1652 if (!topmargin.empty())
1653 os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1654 if (!bottommargin.empty())
1655 os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1656 if (!leftmargin.empty())
1657 os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1658 if (!rightmargin.empty())
1659 os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1660 if (!headheight.empty())
1661 os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1662 if (!headsep.empty())
1663 os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1664 if (!footskip.empty())
1665 os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1666 if (!columnsep.empty())
1667 os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
1670 } else if (orientation == ORIENTATION_LANDSCAPE
1671 || papersize != PAPER_DEFAULT) {
1672 features.require("papersize");
1675 if (tokenPos(tclass.opt_pagestyle(), '|', pagestyle) >= 0) {
1676 if (pagestyle == "fancy")
1677 os << "\\usepackage{fancyhdr}\n";
1678 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1681 // only output when the background color is not default
1682 if (isbackgroundcolor == true) {
1683 // only require color here, the background color will be defined
1684 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1686 features.require("color");
1687 features.require("pagecolor");
1690 // only output when the font color is not default
1691 if (isfontcolor == true) {
1692 // only require color here, the font color will be defined
1693 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1695 features.require("color");
1696 features.require("fontcolor");
1699 // Only if class has a ToC hierarchy
1700 if (tclass.hasTocLevels()) {
1701 if (secnumdepth != tclass.secnumdepth()) {
1702 os << "\\setcounter{secnumdepth}{"
1706 if (tocdepth != tclass.tocdepth()) {
1707 os << "\\setcounter{tocdepth}{"
1713 if (paragraph_separation) {
1714 // when skip separation
1715 switch (getDefSkip().kind()) {
1716 case VSpace::SMALLSKIP:
1717 os << "\\setlength{\\parskip}{\\smallskipamount}\n";
1719 case VSpace::MEDSKIP:
1720 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1722 case VSpace::BIGSKIP:
1723 os << "\\setlength{\\parskip}{\\bigskipamount}\n";
1725 case VSpace::LENGTH:
1726 os << "\\setlength{\\parskip}{"
1727 << from_utf8(getDefSkip().length().asLatexString())
1730 default: // should never happen // Then delete it.
1731 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1734 os << "\\setlength{\\parindent}{0pt}\n";
1736 // when separation by indentation
1737 // only output something when a width is given
1738 if (getIndentation().asLyXCommand() != "default") {
1739 os << "\\setlength{\\parindent}{"
1740 << from_utf8(getIndentation().asLatexCommand())
1745 // Now insert the LyX specific LaTeX commands...
1746 docstring lyxpreamble;
1747 features.resolveAlternatives();
1750 if (!output_sync_macro.empty())
1751 lyxpreamble += from_utf8(output_sync_macro) +"\n";
1752 else if (features.runparams().flavor == OutputParams::LATEX)
1753 lyxpreamble += "\\usepackage[active]{srcltx}\n";
1754 else if (features.runparams().flavor == OutputParams::PDFLATEX)
1755 lyxpreamble += "\\synctex=-1\n";
1758 // due to interferences with babel and hyperref, the color package has to
1759 // be loaded (when it is not already loaded) before babel when hyperref
1760 // is used with the colorlinks option, see
1761 // http://www.lyx.org/trac/ticket/5291
1762 // we decided therefore to load color always before babel, see
1763 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
1764 lyxpreamble += from_ascii(features.getColorOptions());
1766 // If we use hyperref, jurabib, japanese, or vietnamese, we have to call babel before them.
1768 && (features.isRequired("jurabib")
1769 || features.isRequired("hyperref")
1770 || features.isRequired("vietnamese")
1771 || features.isRequired("japanese"))) {
1773 lyxpreamble += from_utf8(features.getBabelPresettings());
1774 lyxpreamble += from_utf8(babelCall(language_options.str(),
1775 features.needBabelLangOptions())) + '\n';
1776 lyxpreamble += from_utf8(features.getBabelPostsettings());
1779 // The optional packages;
1780 lyxpreamble += from_ascii(features.getPackages());
1782 // Additional Indices
1783 if (features.isRequired("splitidx")) {
1784 IndicesList::const_iterator iit = indiceslist().begin();
1785 IndicesList::const_iterator iend = indiceslist().end();
1786 for (; iit != iend; ++iit) {
1787 pair<docstring, docstring> indexname_latex =
1788 features.runparams().encoding->latexString(iit->index(),
1789 features.runparams().dryrun);
1790 if (!indexname_latex.second.empty()) {
1791 // issue a warning about omitted characters
1792 // FIXME: should be passed to the error dialog
1793 frontend::Alert::warning(_("Uncodable characters"),
1794 bformat(_("The following characters that are used in an index name are not\n"
1795 "representable in the current encoding and therefore have been omitted:\n%1$s."),
1796 indexname_latex.second));
1798 lyxpreamble += "\\newindex[";
1799 lyxpreamble += indexname_latex.first;
1800 lyxpreamble += "]{";
1801 lyxpreamble += escape(iit->shortcut());
1802 lyxpreamble += "}\n";
1807 lyxpreamble += from_utf8(spacing().writePreamble(features.isProvided("SetSpace")));
1810 // * Hyperref manual: "Make sure it comes last of your loaded
1811 // packages, to give it a fighting chance of not being over-written,
1812 // since its job is to redefine many LaTeX commands."
1813 // * Email from Heiko Oberdiek: "It is usually better to load babel
1814 // before hyperref. Then hyperref has a chance to detect babel.
1815 // * Has to be loaded before the "LyX specific LaTeX commands" to
1816 // avoid errors with algorithm floats.
1817 // use hyperref explicitly if it is required
1818 if (features.isRequired("hyperref")) {
1819 // pass what we have to stream here, since we need
1820 // to access the stream itself in PDFOptions.
1823 OutputParams tmp_params = features.runparams();
1824 pdfoptions().writeLaTeX(tmp_params, os,
1825 features.isProvided("hyperref"));
1826 // set back for the rest
1827 lyxpreamble.clear();
1828 // correctly break URLs with hyperref and dvi output
1829 if (features.runparams().flavor == OutputParams::LATEX
1830 && features.isAvailable("breakurl"))
1831 lyxpreamble += "\\usepackage{breakurl}\n";
1832 } else if (features.isRequired("nameref"))
1833 // hyperref loads this automatically
1834 lyxpreamble += "\\usepackage{nameref}\n";
1836 // bibtopic needs to be loaded after hyperref.
1837 // the dot provides the aux file naming which LyX can detect.
1838 if (features.mustProvide("bibtopic"))
1839 lyxpreamble += "\\usepackage[dot]{bibtopic}\n";
1841 // Will be surrounded by \makeatletter and \makeatother when not empty
1842 docstring atlyxpreamble;
1844 // Some macros LyX will need
1845 docstring tmppreamble(features.getMacros());
1847 if (!tmppreamble.empty())
1848 atlyxpreamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1849 "LyX specific LaTeX commands.\n"
1850 + tmppreamble + '\n';
1852 // the text class specific preamble
1853 tmppreamble = features.getTClassPreamble();
1854 if (!tmppreamble.empty())
1855 atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1856 "Textclass specific LaTeX commands.\n"
1857 + tmppreamble + '\n';
1859 // suppress date if selected
1860 // use \@ifundefined because we cannot be sure that every document class
1861 // has a \date command
1863 atlyxpreamble += "\\@ifundefined{date}{}{\\date{}}\n";
1865 /* the user-defined preamble */
1866 if (!containsOnly(preamble, " \n\t"))
1868 atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1869 "User specified LaTeX commands.\n"
1870 + from_utf8(preamble) + '\n';
1872 // subfig loads internally the LaTeX package "caption". As
1873 // caption is a very popular package, users will load it in
1874 // the preamble. Therefore we must load subfig behind the
1875 // user-defined preamble and check if the caption package was
1876 // loaded or not. For the case that caption is loaded before
1877 // subfig, there is the subfig option "caption=false". This
1878 // option also works when a koma-script class is used and
1879 // koma's own caption commands are used instead of caption. We
1880 // use \PassOptionsToPackage here because the user could have
1881 // already loaded subfig in the preamble.
1882 if (features.isRequired("subfig")) {
1883 atlyxpreamble += "\\@ifundefined{showcaptionsetup}{}{%\n"
1884 " \\PassOptionsToPackage{caption=false}{subfig}}\n"
1885 "\\usepackage{subfig}\n";
1888 // Itemize bullet settings need to be last in case the user
1889 // defines their own bullets that use a package included
1890 // in the user-defined preamble -- ARRae
1891 // Actually it has to be done much later than that
1892 // since some packages like frenchb make modifications
1893 // at \begin{document} time -- JMarc
1894 docstring bullets_def;
1895 for (int i = 0; i < 4; ++i) {
1896 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1897 if (bullets_def.empty())
1898 bullets_def += "\\AtBeginDocument{\n";
1899 bullets_def += " \\def\\labelitemi";
1901 // `i' is one less than the item to modify
1908 bullets_def += "ii";
1914 bullets_def += '{' +
1915 user_defined_bullet(i).getText()
1920 if (!bullets_def.empty())
1921 atlyxpreamble += bullets_def + "}\n\n";
1923 if (!atlyxpreamble.empty())
1924 lyxpreamble += "\n\\makeatletter\n"
1925 + atlyxpreamble + "\\makeatother\n\n";
1927 // We try to load babel late, in case it interferes with other packages.
1928 // Jurabib and Hyperref have to be called after babel, though.
1929 if (use_babel && !features.isRequired("jurabib")
1930 && !features.isRequired("hyperref")
1931 && !features.isRequired("vietnamese")
1932 && !features.isRequired("japanese")) {
1934 lyxpreamble += from_utf8(features.getBabelPresettings());
1935 lyxpreamble += from_utf8(babelCall(language_options.str(),
1936 features.needBabelLangOptions())) + '\n';
1937 lyxpreamble += from_utf8(features.getBabelPostsettings());
1940 // xunicode needs to be loaded at least after amsmath, amssymb,
1941 // esint and the other packages that provide special glyphs
1942 if (features.runparams().flavor == OutputParams::XETEX)
1943 lyxpreamble += "\\usepackage{xunicode}\n";
1945 // Polyglossia must be loaded last
1946 if (use_polyglossia) {
1948 lyxpreamble += "\\usepackage{polyglossia}\n";
1949 // set the main language
1950 lyxpreamble += "\\setdefaultlanguage";
1951 if (!language->polyglossiaOpts().empty())
1952 lyxpreamble += "[" + from_ascii(language->polyglossiaOpts()) + "]";
1953 lyxpreamble += "{" + from_ascii(language->polyglossia()) + "}\n";
1954 // now setup the other languages
1955 std::map<std::string, std::string> const polylangs =
1956 features.getPolyglossiaLanguages();
1957 for (std::map<std::string, std::string>::const_iterator mit = polylangs.begin();
1958 mit != polylangs.end() ; ++mit) {
1959 lyxpreamble += "\\setotherlanguage";
1960 if (!mit->second.empty())
1961 lyxpreamble += "[" + from_ascii(mit->second) + "]";
1962 lyxpreamble += "{" + from_ascii(mit->first) + "}\n";
1966 // Load custom language package here
1967 if (features.langPackage() == LaTeXFeatures::LANG_PACK_CUSTOM) {
1968 if (lang_package == "default")
1969 lyxpreamble += from_utf8(lyxrc.language_custom_package);
1971 lyxpreamble += from_utf8(lang_package);
1972 lyxpreamble += '\n';
1975 docstring const i18npreamble =
1976 features.getTClassI18nPreamble(use_babel, use_polyglossia);
1977 if (!i18npreamble.empty())
1978 lyxpreamble += i18npreamble + '\n';
1986 void BufferParams::useClassDefaults()
1988 DocumentClass const & tclass = documentClass();
1990 sides = tclass.sides();
1991 columns = tclass.columns();
1992 pagestyle = tclass.pagestyle();
1993 use_default_options = true;
1994 // Only if class has a ToC hierarchy
1995 if (tclass.hasTocLevels()) {
1996 secnumdepth = tclass.secnumdepth();
1997 tocdepth = tclass.tocdepth();
2002 bool BufferParams::hasClassDefaults() const
2004 DocumentClass const & tclass = documentClass();
2006 return sides == tclass.sides()
2007 && columns == tclass.columns()
2008 && pagestyle == tclass.pagestyle()
2009 && use_default_options
2010 && secnumdepth == tclass.secnumdepth()
2011 && tocdepth == tclass.tocdepth();
2015 DocumentClass const & BufferParams::documentClass() const
2017 return *doc_class_.get();
2021 DocumentClassConstPtr BufferParams::documentClassPtr() const
2027 void BufferParams::setDocumentClass(DocumentClassConstPtr tc)
2029 // evil, but this function is evil
2030 doc_class_ = const_pointer_cast<DocumentClass>(tc);
2034 bool BufferParams::setBaseClass(string const & classname)
2036 LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
2037 LayoutFileList & bcl = LayoutFileList::get();
2038 if (!bcl.haveClass(classname)) {
2040 bformat(_("The layout file:\n"
2042 "could not be found. A default textclass with default\n"
2043 "layouts will be used. LyX will not be able to produce\n"
2045 from_utf8(classname));
2046 frontend::Alert::error(_("Document class not found"), s);
2047 bcl.addEmptyClass(classname);
2050 bool const success = bcl[classname].load();
2053 bformat(_("Due to some error in it, the layout file:\n"
2055 "could not be loaded. A default textclass with default\n"
2056 "layouts will be used. LyX will not be able to produce\n"
2058 from_utf8(classname));
2059 frontend::Alert::error(_("Could not load class"), s);
2060 bcl.addEmptyClass(classname);
2063 pimpl_->baseClass_ = classname;
2064 layout_modules_.adaptToBaseClass(baseClass(), removed_modules_);
2069 LayoutFile const * BufferParams::baseClass() const
2071 if (LayoutFileList::get().haveClass(pimpl_->baseClass_))
2072 return &(LayoutFileList::get()[pimpl_->baseClass_]);
2078 LayoutFileIndex const & BufferParams::baseClassID() const
2080 return pimpl_->baseClass_;
2084 void BufferParams::makeDocumentClass()
2089 LayoutModuleList mods;
2090 LayoutModuleList::iterator it = layout_modules_.begin();
2091 LayoutModuleList::iterator en = layout_modules_.end();
2092 for (; it != en; ++it)
2093 mods.push_back(*it);
2095 it = cite_engine_.begin();
2096 en = cite_engine_.end();
2097 for (; it != en; ++it)
2098 mods.push_back(*it);
2100 doc_class_ = getDocumentClass(*baseClass(), mods);
2102 if (!local_layout.empty()) {
2103 TextClass::ReturnValues success =
2104 doc_class_->read(local_layout, TextClass::MODULE);
2105 if (success != TextClass::OK && success != TextClass::OK_OLDFORMAT) {
2106 docstring const msg = _("Error reading internal layout information");
2107 frontend::Alert::warning(_("Read Error"), msg);
2113 bool BufferParams::layoutModuleCanBeAdded(string const & modName) const
2115 return layout_modules_.moduleCanBeAdded(modName, baseClass());
2119 bool BufferParams::citationModuleCanBeAdded(string const & modName) const
2121 return cite_engine_.moduleCanBeAdded(modName, baseClass());
2125 bool BufferParams::addLayoutModule(string const & modName)
2127 LayoutModuleList::const_iterator it = layout_modules_.begin();
2128 LayoutModuleList::const_iterator end = layout_modules_.end();
2129 for (; it != end; ++it)
2132 layout_modules_.push_back(modName);
2137 string BufferParams::bufferFormat() const
2139 string format = documentClass().outputFormat();
2140 if (format == "latex") {
2143 if (encoding().package() == Encoding::japanese)
2150 bool BufferParams::isExportable(string const & format) const
2152 vector<string> backs = backends();
2153 for (vector<string>::const_iterator it = backs.begin();
2154 it != backs.end(); ++it)
2155 if (theConverters().isReachable(*it, format))
2163 bool formatSorter(Format const * lhs, Format const * rhs)
2165 return _(lhs->prettyname()) < _(rhs->prettyname());
2171 vector<Format const *> BufferParams::exportableFormats(bool only_viewable) const
2173 vector<string> const backs = backends();
2174 set<string> excludes;
2175 if (useNonTeXFonts) {
2176 excludes.insert("latex");
2177 excludes.insert("pdflatex");
2179 vector<Format const *> result =
2180 theConverters().getReachable(backs[0], only_viewable, true, excludes);
2181 for (vector<string>::const_iterator it = backs.begin() + 1;
2182 it != backs.end(); ++it) {
2183 vector<Format const *> r =
2184 theConverters().getReachable(*it, only_viewable, false, excludes);
2185 result.insert(result.end(), r.begin(), r.end());
2187 sort(result.begin(), result.end(), formatSorter);
2192 bool BufferParams::isExportableFormat(string const & format) const
2194 typedef vector<Format const *> Formats;
2196 formats = exportableFormats(true);
2197 Formats::const_iterator fit = formats.begin();
2198 Formats::const_iterator end = formats.end();
2199 for (; fit != end ; ++fit) {
2200 if ((*fit)->name() == format)
2207 vector<string> BufferParams::backends() const
2210 string const buffmt = bufferFormat();
2212 // FIXME: Don't hardcode format names here, but use a flag
2213 if (buffmt == "latex") {
2214 if (!useNonTeXFonts) {
2215 v.push_back("pdflatex");
2216 v.push_back("latex");
2218 v.push_back("luatex");
2219 v.push_back("dviluatex");
2220 v.push_back("xetex");
2221 } else if (buffmt == "xetex") {
2222 v.push_back("xetex");
2223 v.push_back("luatex");
2224 v.push_back("dviluatex");
2226 v.push_back(buffmt);
2228 v.push_back("xhtml");
2229 v.push_back("text");
2235 OutputParams::FLAVOR BufferParams::getOutputFlavor(string const format) const
2237 string const dformat = (format.empty() || format == "default") ?
2238 getDefaultOutputFormat() : format;
2239 DefaultFlavorCache::const_iterator it =
2240 default_flavors_.find(dformat);
2242 if (it != default_flavors_.end())
2245 OutputParams::FLAVOR result = OutputParams::LATEX;
2247 // FIXME It'd be better not to hardcode this, but to do
2248 // something with formats.
2249 if (dformat == "xhtml")
2250 result = OutputParams::HTML;
2251 else if (dformat == "text")
2252 result = OutputParams::TEXT;
2253 else if (dformat == "lyx")
2254 result = OutputParams::LYX;
2255 else if (dformat == "pdflatex")
2256 result = OutputParams::PDFLATEX;
2257 else if (dformat == "xetex")
2258 result = OutputParams::XETEX;
2259 else if (dformat == "luatex")
2260 result = OutputParams::LUATEX;
2261 else if (dformat == "dviluatex")
2262 result = OutputParams::DVILUATEX;
2264 // Try to determine flavor of default output format
2265 vector<string> backs = backends();
2266 if (find(backs.begin(), backs.end(), dformat) == backs.end()) {
2267 // Get shortest path to format
2268 Graph::EdgePath path;
2269 for (vector<string>::const_iterator it = backs.begin();
2270 it != backs.end(); ++it) {
2271 Graph::EdgePath p = theConverters().getPath(*it, dformat);
2272 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2277 result = theConverters().getFlavor(path);
2280 // cache this flavor
2281 default_flavors_[dformat] = result;
2286 string BufferParams::getDefaultOutputFormat() const
2288 if (!default_output_format.empty()
2289 && default_output_format != "default")
2290 return default_output_format;
2293 || encoding().package() == Encoding::japanese) {
2294 vector<Format const *> const formats = exportableFormats(true);
2295 if (formats.empty())
2297 // return the first we find
2298 return formats.front()->name();
2300 return lyxrc.default_view_format;
2303 Font const BufferParams::getFont() const
2305 FontInfo f = documentClass().defaultfont();
2306 if (fonts_default_family == "rmdefault")
2307 f.setFamily(ROMAN_FAMILY);
2308 else if (fonts_default_family == "sfdefault")
2309 f.setFamily(SANS_FAMILY);
2310 else if (fonts_default_family == "ttdefault")
2311 f.setFamily(TYPEWRITER_FAMILY);
2312 return Font(f, language);
2316 InsetQuotes::QuoteLanguage BufferParams::getQuoteStyle(string const qs) const
2318 return quoteslangtranslator().find(qs);
2322 bool BufferParams::isLatex() const
2324 return documentClass().outputType() == LATEX;
2328 bool BufferParams::isLiterate() const
2330 return documentClass().outputType() == LITERATE;
2334 bool BufferParams::isDocBook() const
2336 return documentClass().outputType() == DOCBOOK;
2340 void BufferParams::readPreamble(Lexer & lex)
2342 if (lex.getString() != "\\begin_preamble")
2343 lyxerr << "Error (BufferParams::readPreamble):"
2344 "consistency check failed." << endl;
2346 preamble = lex.getLongString("\\end_preamble");
2350 void BufferParams::readLocalLayout(Lexer & lex)
2352 if (lex.getString() != "\\begin_local_layout")
2353 lyxerr << "Error (BufferParams::readLocalLayout):"
2354 "consistency check failed." << endl;
2356 local_layout = lex.getLongString("\\end_local_layout");
2360 bool BufferParams::setLanguage(string const & lang)
2362 Language const *new_language = languages.getLanguage(lang);
2363 if (!new_language) {
2364 // Language lang was not found
2367 language = new_language;
2372 void BufferParams::readLanguage(Lexer & lex)
2374 if (!lex.next()) return;
2376 string const tmptok = lex.getString();
2378 // check if tmptok is part of tex_babel in tex-defs.h
2379 if (!setLanguage(tmptok)) {
2380 // Language tmptok was not found
2381 language = default_language;
2382 lyxerr << "Warning: Setting language `"
2383 << tmptok << "' to `" << language->lang()
2389 void BufferParams::readGraphicsDriver(Lexer & lex)
2394 string const tmptok = lex.getString();
2395 // check if tmptok is part of tex_graphics in tex_defs.h
2398 string const test = tex_graphics[n++];
2400 if (test == tmptok) {
2401 graphics_driver = tmptok;
2406 "Warning: graphics driver `$$Token' not recognized!\n"
2407 " Setting graphics driver to `default'.\n");
2408 graphics_driver = "default";
2415 void BufferParams::readBullets(Lexer & lex)
2420 int const index = lex.getInteger();
2422 int temp_int = lex.getInteger();
2423 user_defined_bullet(index).setFont(temp_int);
2424 temp_bullet(index).setFont(temp_int);
2426 user_defined_bullet(index).setCharacter(temp_int);
2427 temp_bullet(index).setCharacter(temp_int);
2429 user_defined_bullet(index).setSize(temp_int);
2430 temp_bullet(index).setSize(temp_int);
2434 void BufferParams::readBulletsLaTeX(Lexer & lex)
2436 // The bullet class should be able to read this.
2439 int const index = lex.getInteger();
2441 docstring const temp_str = lex.getDocString();
2443 user_defined_bullet(index).setText(temp_str);
2444 temp_bullet(index).setText(temp_str);
2448 void BufferParams::readModules(Lexer & lex)
2450 if (!lex.eatLine()) {
2451 lyxerr << "Error (BufferParams::readModules):"
2452 "Unexpected end of input." << endl;
2456 string mod = lex.getString();
2457 if (mod == "\\end_modules")
2459 addLayoutModule(mod);
2465 void BufferParams::readRemovedModules(Lexer & lex)
2467 if (!lex.eatLine()) {
2468 lyxerr << "Error (BufferParams::readRemovedModules):"
2469 "Unexpected end of input." << endl;
2473 string mod = lex.getString();
2474 if (mod == "\\end_removed_modules")
2476 removed_modules_.push_back(mod);
2479 // now we want to remove any removed modules that were previously
2480 // added. normally, that will be because default modules were added in
2481 // setBaseClass(), which gets called when \textclass is read at the
2482 // start of the read.
2483 list<string>::const_iterator rit = removed_modules_.begin();
2484 list<string>::const_iterator const ren = removed_modules_.end();
2485 for (; rit != ren; ++rit) {
2486 LayoutModuleList::iterator const mit = layout_modules_.begin();
2487 LayoutModuleList::iterator const men = layout_modules_.end();
2488 LayoutModuleList::iterator found = find(mit, men, *rit);
2491 layout_modules_.erase(found);
2496 void BufferParams::readIncludeonly(Lexer & lex)
2498 if (!lex.eatLine()) {
2499 lyxerr << "Error (BufferParams::readIncludeonly):"
2500 "Unexpected end of input." << endl;
2504 string child = lex.getString();
2505 if (child == "\\end_includeonly")
2507 included_children_.push_back(child);
2513 string BufferParams::paperSizeName(PapersizePurpose purpose) const
2515 switch (papersize) {
2517 // could be anything, so don't guess
2519 case PAPER_CUSTOM: {
2520 if (purpose == XDVI && !paperwidth.empty() &&
2521 !paperheight.empty()) {
2522 // heightxwidth<unit>
2523 string first = paperwidth;
2524 string second = paperheight;
2525 if (orientation == ORIENTATION_LANDSCAPE)
2528 return first.erase(first.length() - 2)
2534 // dvips and dvipdfm do not know this
2535 if (purpose == DVIPS || purpose == DVIPDFM)
2539 if (purpose == DVIPS || purpose == DVIPDFM)
2543 if (purpose == DVIPS || purpose == DVIPDFM)
2553 if (purpose == DVIPS || purpose == DVIPDFM)
2557 if (purpose == DVIPS || purpose == DVIPDFM)
2561 if (purpose == DVIPS || purpose == DVIPDFM)
2565 if (purpose == DVIPS || purpose == DVIPDFM)
2569 if (purpose == DVIPS || purpose == DVIPDFM)
2573 // dvipdfm does not know this
2574 if (purpose == DVIPDFM)
2578 if (purpose == DVIPDFM)
2582 if (purpose == DVIPS || purpose == DVIPDFM)
2586 if (purpose == DVIPS || purpose == DVIPDFM)
2590 if (purpose == DVIPS || purpose == DVIPDFM)
2594 if (purpose == DVIPS || purpose == DVIPDFM)
2598 if (purpose == DVIPS || purpose == DVIPDFM)
2602 if (purpose == DVIPS || purpose == DVIPDFM)
2606 if (purpose == DVIPS || purpose == DVIPDFM)
2610 if (purpose == DVIPS || purpose == DVIPDFM)
2614 if (purpose == DVIPS || purpose == DVIPDFM)
2618 if (purpose == DVIPS || purpose == DVIPDFM)
2622 if (purpose == DVIPS || purpose == DVIPDFM)
2626 if (purpose == DVIPS || purpose == DVIPDFM)
2630 if (purpose == DVIPS || purpose == DVIPDFM)
2634 if (purpose == DVIPS || purpose == DVIPDFM)
2638 if (purpose == DVIPS || purpose == DVIPDFM)
2641 case PAPER_USEXECUTIVE:
2642 // dvipdfm does not know this
2643 if (purpose == DVIPDFM)
2648 case PAPER_USLETTER:
2650 if (purpose == XDVI)
2657 string const BufferParams::dvips_options() const
2661 // If the class loads the geometry package, we do not know which
2662 // paper size is used, since we do not set it (bug 7013).
2663 // Therefore we must not specify any argument here.
2664 // dvips gets the correct paper size via DVI specials in this case
2665 // (if the class uses the geometry package correctly).
2666 if (documentClass().provides("geometry"))
2670 && papersize == PAPER_CUSTOM
2671 && !lyxrc.print_paper_dimension_flag.empty()
2672 && !paperwidth.empty()
2673 && !paperheight.empty()) {
2674 // using a custom papersize
2675 result = lyxrc.print_paper_dimension_flag;
2676 result += ' ' + paperwidth;
2677 result += ',' + paperheight;
2679 string const paper_option = paperSizeName(DVIPS);
2680 if (!paper_option.empty() && (paper_option != "letter" ||
2681 orientation != ORIENTATION_LANDSCAPE)) {
2682 // dvips won't accept -t letter -t landscape.
2683 // In all other cases, include the paper size
2685 result = lyxrc.print_paper_flag;
2686 result += ' ' + paper_option;
2689 if (orientation == ORIENTATION_LANDSCAPE &&
2690 papersize != PAPER_CUSTOM)
2691 result += ' ' + lyxrc.print_landscape_flag;
2696 string const BufferParams::font_encoding() const
2698 return (fontenc == "global") ? lyxrc.fontenc : fontenc;
2702 string BufferParams::babelCall(string const & lang_opts, bool const langoptions) const
2704 // suppress the babel call if there is no BabelName defined
2705 // for the document language in the lib/languages file and if no
2706 // other languages are used (lang_opts is then empty)
2707 if (lang_opts.empty())
2709 // either a specific language (AsBabelOptions setting in
2710 // lib/languages) or the prefs require the languages to
2711 // be submitted to babel itself (not the class).
2713 return "\\usepackage[" + lang_opts + "]{babel}";
2714 return "\\usepackage{babel}";
2718 docstring BufferParams::getGraphicsDriver(string const & package) const
2722 if (package == "geometry") {
2723 if (graphics_driver == "dvips"
2724 || graphics_driver == "dvipdfm"
2725 || graphics_driver == "pdftex"
2726 || graphics_driver == "vtex")
2727 result = from_ascii(graphics_driver);
2728 else if (graphics_driver == "dvipdfmx")
2729 result = from_ascii("dvipdfm");
2736 void BufferParams::writeEncodingPreamble(otexstream & os,
2737 LaTeXFeatures & features) const
2739 // XeTeX does not need this
2740 if (features.runparams().flavor == OutputParams::XETEX)
2742 // LuaTeX neither, but with tex fonts, we need to load
2743 // the luainputenc package.
2744 if (features.runparams().flavor == OutputParams::LUATEX
2745 || features.runparams().flavor == OutputParams::DVILUATEX) {
2746 if (!useNonTeXFonts && inputenc != "default"
2747 && ((inputenc == "auto" && language->encoding()->package() == Encoding::inputenc)
2748 || (inputenc != "auto" && encoding().package() == Encoding::inputenc))) {
2749 os << "\\usepackage[utf8]{luainputenc}\n";
2753 if (inputenc == "auto") {
2754 string const doc_encoding =
2755 language->encoding()->latexName();
2756 Encoding::Package const package =
2757 language->encoding()->package();
2759 // Create a list with all the input encodings used
2761 set<string> encodings =
2762 features.getEncodingSet(doc_encoding);
2764 // If the "japanese" package (i.e. pLaTeX) is used,
2765 // inputenc must be omitted.
2766 // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
2767 if ((!encodings.empty() || package == Encoding::inputenc)
2768 && !features.isRequired("japanese")) {
2769 os << "\\usepackage[";
2770 set<string>::const_iterator it = encodings.begin();
2771 set<string>::const_iterator const end = encodings.end();
2773 os << from_ascii(*it);
2776 for (; it != end; ++it)
2777 os << ',' << from_ascii(*it);
2778 if (package == Encoding::inputenc) {
2779 if (!encodings.empty())
2781 os << from_ascii(doc_encoding);
2783 os << "]{inputenc}\n";
2785 if (package == Encoding::CJK || features.mustProvide("CJK")) {
2786 if (language->encoding()->name() == "utf8-cjk"
2787 && LaTeXFeatures::isAvailable("CJKutf8"))
2788 os << "\\usepackage{CJKutf8}\n";
2790 os << "\\usepackage{CJK}\n";
2792 } else if (inputenc != "default") {
2793 switch (encoding().package()) {
2794 case Encoding::none:
2795 case Encoding::japanese:
2797 case Encoding::inputenc:
2798 // do not load inputenc if japanese is used
2799 if (features.isRequired("japanese"))
2801 os << "\\usepackage[" << from_ascii(encoding().latexName())
2805 if (encoding().name() == "utf8-cjk"
2806 && LaTeXFeatures::isAvailable("CJKutf8"))
2807 os << "\\usepackage{CJKutf8}\n";
2809 os << "\\usepackage{CJK}\n";
2816 string const BufferParams::parseFontName(string const & name) const
2818 string mangled = name;
2819 size_t const idx = mangled.find('[');
2820 if (idx == string::npos || idx == 0)
2823 return mangled.substr(0, idx - 1);
2827 string const BufferParams::loadFonts(LaTeXFeatures & features) const
2829 if (fonts_roman == "default" && fonts_sans == "default"
2830 && fonts_typewriter == "default"
2831 && (fonts_math == "default" || fonts_math == "auto"))
2837 /* Fontspec (XeTeX, LuaTeX): we provide GUI support for oldstyle
2838 * numbers (Numbers=OldStyle) and sf/tt scaling. The Ligatures=TeX/
2839 * Mapping=tex-text option assures TeX ligatures (such as "--")
2840 * are resolved. Note that tt does not use these ligatures.
2842 * -- add more GUI options?
2843 * -- add more fonts (fonts for other scripts)
2844 * -- if there's a way to find out if a font really supports
2845 * OldStyle, enable/disable the widget accordingly.
2847 if (useNonTeXFonts && features.isAvailable("fontspec")) {
2848 // "Mapping=tex-text" and "Ligatures=TeX" are equivalent.
2849 // However, until v.2 (2010/07/11) fontspec only knew
2850 // Mapping=tex-text (for XeTeX only); then "Ligatures=TeX"
2851 // was introduced for both XeTeX and LuaTeX (LuaTeX
2852 // didn't understand "Mapping=tex-text", while XeTeX
2853 // understood both. With most recent versions, both
2854 // variants are understood by both engines. However,
2855 // we want to provide support for at least TeXLive 2009
2856 // (for XeTeX; LuaTeX is only supported as of v.2)
2857 string const texmapping =
2858 (features.runparams().flavor == OutputParams::XETEX) ?
2859 "Mapping=tex-text" : "Ligatures=TeX";
2860 if (fonts_roman != "default") {
2861 os << "\\setmainfont[" << texmapping;
2862 if (fonts_old_figures)
2863 os << ",Numbers=OldStyle";
2864 os << "]{" << parseFontName(fonts_roman) << "}\n";
2866 if (fonts_sans != "default") {
2867 string const sans = parseFontName(fonts_sans);
2868 if (fonts_sans_scale != 100)
2869 os << "\\setsansfont[Scale="
2870 << float(fonts_sans_scale) / 100
2871 << "," << texmapping << "]{"
2874 os << "\\setsansfont[" << texmapping << "]{"
2877 if (fonts_typewriter != "default") {
2878 string const mono = parseFontName(fonts_typewriter);
2879 if (fonts_typewriter_scale != 100)
2880 os << "\\setmonofont[Scale="
2881 << float(fonts_typewriter_scale) / 100
2885 os << "\\setmonofont{"
2892 bool const ot1 = (font_encoding() == "default" || font_encoding() == "OT1");
2893 bool const dryrun = features.runparams().dryrun;
2894 bool const complete = (fonts_sans == "default" && fonts_typewriter == "default");
2895 bool const nomath = (fonts_math == "default");
2898 os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_roman)).getLaTeXCode(
2899 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
2903 os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_sans)).getLaTeXCode(
2904 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
2905 nomath, fonts_sans_scale);
2907 // MONOSPACED/TYPEWRITER
2908 os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_typewriter)).getLaTeXCode(
2909 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
2910 nomath, fonts_typewriter_scale);
2913 os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_math)).getLaTeXCode(
2914 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
2921 Encoding const & BufferParams::encoding() const
2923 // FIXME: actually, we should check for the flavor
2924 // or runparams.isFullyUnicode() here:
2925 // This check will not work with XeTeX/LuaTeX and tex fonts.
2926 // Thus we have to reset the encoding in Buffer::makeLaTeXFile.
2928 return *(encodings.fromLyXName("utf8-plain"));
2929 if (inputenc == "auto" || inputenc == "default")
2930 return *language->encoding();
2931 Encoding const * const enc = encodings.fromLyXName(inputenc);
2934 LYXERR0("Unknown inputenc value `" << inputenc
2935 << "'. Using `auto' instead.");
2936 return *language->encoding();
2940 bool BufferParams::addCiteEngine(string const & engine)
2942 LayoutModuleList::const_iterator it = cite_engine_.begin();
2943 LayoutModuleList::const_iterator en = cite_engine_.end();
2944 for (; it != en; ++it)
2947 cite_engine_.push_back(engine);
2952 bool BufferParams::addCiteEngine(vector<string> const & engine)
2954 vector<string>::const_iterator it = engine.begin();
2955 vector<string>::const_iterator en = engine.end();
2957 for (; it != en; ++it)
2958 if (!addCiteEngine(*it))
2964 string const & BufferParams::defaultBiblioStyle() const
2966 return documentClass().defaultBiblioStyle();
2970 bool const & BufferParams::fullAuthorList() const
2972 return documentClass().fullAuthorList();
2976 void BufferParams::setCiteEngine(string const & engine)
2979 addCiteEngine(engine);
2983 void BufferParams::setCiteEngine(vector<string> const & engine)
2986 addCiteEngine(engine);
2990 vector<string> BufferParams::citeCommands() const
2992 static CitationStyle const default_style;
2993 vector<string> commands =
2994 documentClass().citeCommands(citeEngineType());
2995 if (commands.empty())
2996 commands.push_back(default_style.cmd);
3001 vector<CitationStyle> BufferParams::citeStyles() const
3003 static CitationStyle const default_style;
3004 vector<CitationStyle> styles =
3005 documentClass().citeStyles(citeEngineType());
3007 styles.push_back(default_style);