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"
24 #include "buffer_funcs.h"
26 #include "CiteEnginesList.h"
29 #include "Converter.h"
31 #include "IndicesList.h"
33 #include "LaTeXFeatures.h"
34 #include "LaTeXFonts.h"
36 #include "ModuleList.h"
40 #include "OutputParams.h"
42 #include "texstream.h"
45 #include "PDFOptions.h"
47 #include "frontends/alert.h"
49 #include "insets/InsetListingsParams.h"
51 #include "support/convert.h"
52 #include "support/debug.h"
53 #include "support/docstream.h"
54 #include "support/FileName.h"
55 #include "support/filetools.h"
56 #include "support/gettext.h"
57 #include "support/Messages.h"
58 #include "support/mutex.h"
59 #include "support/Package.h"
60 #include "support/Translator.h"
61 #include "support/lstrings.h"
67 using namespace lyx::support;
70 static char const * const string_paragraph_separation[] = {
75 static char const * const string_quotes_style[] = {
76 "english", "swedish", "german", "polish", "swiss", "danish", "plain",
77 "british", "swedishg", "french", "frenchin", "russian", "cjk", "cjkangle", ""
81 static char const * const string_papersize[] = {
82 "default", "custom", "letter", "legal", "executive",
83 "a0", "a1", "a2", "a3", "a4", "a5", "a6",
84 "b0", "b1", "b2", "b3", "b4", "b5", "b6",
85 "c0", "c1", "c2", "c3", "c4", "c5", "c6",
86 "b0j", "b1j", "b2j", "b3j", "b4j", "b5j", "b6j", ""
90 static char const * const string_papersize_geometry[] = {
91 "default", "custom", "letterpaper", "legalpaper", "executivepaper",
92 "a0paper", "a1paper", "a2paper", "a3paper", "a4paper", "a5paper", "a6paper",
93 "b0paper", "b1paper", "b2paper", "b3paper", "b4paper", "b5paper", "b6paper",
94 "c0paper", "c1paper", "c2paper", "c3paper", "c4paper", "c5paper", "c6paper",
95 "b0j", "b1j", "b2j", "b3j", "b4j", "b5j", "b6j", ""
99 static char const * const string_orientation[] = {
100 "portrait", "landscape", ""
104 static char const * const tex_graphics[] = {
105 "default", "dvialw", "dvilaser", "dvipdf", "dvipdfm", "dvipdfmx",
106 "dvips", "dvipsone", "dvitops", "dviwin", "dviwindo", "dvi2ps", "emtex",
107 "ln", "oztex", "pctexhp", "pctexps", "pctexwin", "pctex32", "pdftex",
108 "psprint", "pubps", "tcidvi", "textures", "truetex", "vtex", "xdvi",
118 // Paragraph separation
119 typedef Translator<string, BufferParams::ParagraphSeparation> ParSepTranslator;
122 ParSepTranslator const init_parseptranslator()
124 ParSepTranslator translator
125 (string_paragraph_separation[0], BufferParams::ParagraphIndentSeparation);
126 translator.addPair(string_paragraph_separation[1], BufferParams::ParagraphSkipSeparation);
131 ParSepTranslator const & parseptranslator()
133 static ParSepTranslator const translator =
134 init_parseptranslator();
140 typedef Translator<string, InsetQuotesParams::QuoteStyle> QuotesStyleTranslator;
143 QuotesStyleTranslator const init_quotesstyletranslator()
145 QuotesStyleTranslator translator
146 (string_quotes_style[0], InsetQuotesParams::EnglishQuotes);
147 translator.addPair(string_quotes_style[1], InsetQuotesParams::SwedishQuotes);
148 translator.addPair(string_quotes_style[2], InsetQuotesParams::GermanQuotes);
149 translator.addPair(string_quotes_style[3], InsetQuotesParams::PolishQuotes);
150 translator.addPair(string_quotes_style[4], InsetQuotesParams::SwissQuotes);
151 translator.addPair(string_quotes_style[5], InsetQuotesParams::DanishQuotes);
152 translator.addPair(string_quotes_style[6], InsetQuotesParams::PlainQuotes);
153 translator.addPair(string_quotes_style[7], InsetQuotesParams::BritishQuotes);
154 translator.addPair(string_quotes_style[8], InsetQuotesParams::SwedishGQuotes);
155 translator.addPair(string_quotes_style[9], InsetQuotesParams::FrenchQuotes);
156 translator.addPair(string_quotes_style[10], InsetQuotesParams::FrenchINQuotes);
157 translator.addPair(string_quotes_style[11], InsetQuotesParams::RussianQuotes);
158 translator.addPair(string_quotes_style[12], InsetQuotesParams::CJKQuotes);
159 translator.addPair(string_quotes_style[13], InsetQuotesParams::CJKAngleQuotes);
164 QuotesStyleTranslator const & quotesstyletranslator()
166 static QuotesStyleTranslator const translator =
167 init_quotesstyletranslator();
173 typedef Translator<string, PAPER_SIZE> PaperSizeTranslator;
176 static PaperSizeTranslator initPaperSizeTranslator()
178 PaperSizeTranslator translator(string_papersize[0], PAPER_DEFAULT);
179 translator.addPair(string_papersize[1], PAPER_CUSTOM);
180 translator.addPair(string_papersize[2], PAPER_USLETTER);
181 translator.addPair(string_papersize[3], PAPER_USLEGAL);
182 translator.addPair(string_papersize[4], PAPER_USEXECUTIVE);
183 translator.addPair(string_papersize[5], PAPER_A0);
184 translator.addPair(string_papersize[6], PAPER_A1);
185 translator.addPair(string_papersize[7], PAPER_A2);
186 translator.addPair(string_papersize[8], PAPER_A3);
187 translator.addPair(string_papersize[9], PAPER_A4);
188 translator.addPair(string_papersize[10], PAPER_A5);
189 translator.addPair(string_papersize[11], PAPER_A6);
190 translator.addPair(string_papersize[12], PAPER_B0);
191 translator.addPair(string_papersize[13], PAPER_B1);
192 translator.addPair(string_papersize[14], PAPER_B2);
193 translator.addPair(string_papersize[15], PAPER_B3);
194 translator.addPair(string_papersize[16], PAPER_B4);
195 translator.addPair(string_papersize[17], PAPER_B5);
196 translator.addPair(string_papersize[18], PAPER_B6);
197 translator.addPair(string_papersize[19], PAPER_C0);
198 translator.addPair(string_papersize[20], PAPER_C1);
199 translator.addPair(string_papersize[21], PAPER_C2);
200 translator.addPair(string_papersize[22], PAPER_C3);
201 translator.addPair(string_papersize[23], PAPER_C4);
202 translator.addPair(string_papersize[24], PAPER_C5);
203 translator.addPair(string_papersize[25], PAPER_C6);
204 translator.addPair(string_papersize[26], PAPER_JISB0);
205 translator.addPair(string_papersize[27], PAPER_JISB1);
206 translator.addPair(string_papersize[28], PAPER_JISB2);
207 translator.addPair(string_papersize[29], PAPER_JISB3);
208 translator.addPair(string_papersize[30], PAPER_JISB4);
209 translator.addPair(string_papersize[31], PAPER_JISB5);
210 translator.addPair(string_papersize[32], PAPER_JISB6);
215 PaperSizeTranslator const & papersizetranslator()
217 static PaperSizeTranslator const translator =
218 initPaperSizeTranslator();
224 typedef Translator<string, PAPER_ORIENTATION> PaperOrientationTranslator;
227 PaperOrientationTranslator const init_paperorientationtranslator()
229 PaperOrientationTranslator translator(string_orientation[0], ORIENTATION_PORTRAIT);
230 translator.addPair(string_orientation[1], ORIENTATION_LANDSCAPE);
235 PaperOrientationTranslator const & paperorientationtranslator()
237 static PaperOrientationTranslator const translator =
238 init_paperorientationtranslator();
244 typedef Translator<int, PageSides> SidesTranslator;
247 SidesTranslator const init_sidestranslator()
249 SidesTranslator translator(1, OneSide);
250 translator.addPair(2, TwoSides);
255 SidesTranslator const & sidestranslator()
257 static SidesTranslator const translator = init_sidestranslator();
263 typedef Translator<int, BufferParams::Package> PackageTranslator;
266 PackageTranslator const init_packagetranslator()
268 PackageTranslator translator(0, BufferParams::package_off);
269 translator.addPair(1, BufferParams::package_auto);
270 translator.addPair(2, BufferParams::package_on);
275 PackageTranslator const & packagetranslator()
277 static PackageTranslator const translator =
278 init_packagetranslator();
284 typedef Translator<string, Spacing::Space> SpaceTranslator;
287 SpaceTranslator const init_spacetranslator()
289 SpaceTranslator translator("default", Spacing::Default);
290 translator.addPair("single", Spacing::Single);
291 translator.addPair("onehalf", Spacing::Onehalf);
292 translator.addPair("double", Spacing::Double);
293 translator.addPair("other", Spacing::Other);
298 SpaceTranslator const & spacetranslator()
300 static SpaceTranslator const translator = init_spacetranslator();
305 bool inSystemDir(FileName const & document_dir, string & system_dir)
307 // A document is assumed to be in a system LyX directory (not
308 // necessarily the system directory of the running instance)
309 // if both "configure.py" and "chkconfig.ltx" are found in
310 // either document_dir/../ or document_dir/../../.
311 // If true, the system directory path is returned in system_dir
312 // with a trailing path separator.
314 string const msg = "Checking whether document is in a system dir...";
316 string dir = document_dir.absFileName();
318 for (int i = 0; i < 3; ++i) {
319 dir = addPath(dir, "..");
320 if (!fileSearch(dir, "configure.py").empty() &&
321 !fileSearch(dir, "chkconfig.ltx").empty()) {
322 LYXERR(Debug::FILES, msg << " yes");
323 system_dir = addPath(FileName(dir).realPath(), "");
328 LYXERR(Debug::FILES, msg << " no");
329 system_dir = string();
336 class BufferParams::Impl
341 AuthorList authorlist;
342 BranchList branchlist;
343 Bullet temp_bullets[4];
344 Bullet user_defined_bullets[4];
345 IndicesList indiceslist;
349 /** This is the amount of space used for paragraph_separation "skip",
350 * and for detached paragraphs in "indented" documents.
353 PDFOptions pdfoptions;
354 LayoutFileIndex baseClass_;
355 FormatList exportableFormatList;
356 FormatList viewableFormatList;
357 bool isViewCacheValid;
358 bool isExportCacheValid;
362 BufferParams::Impl::Impl()
363 : defskip(VSpace::MEDSKIP), baseClass_(string("")),
364 isViewCacheValid(false), isExportCacheValid(false)
366 // set initial author
368 authorlist.record(Author(from_utf8(lyxrc.user_name),
369 from_utf8(lyxrc.user_email),
370 from_utf8(lyxrc.user_initials)));
375 BufferParams::MemoryTraits::clone(BufferParams::Impl const * ptr)
378 return new BufferParams::Impl(*ptr);
382 void BufferParams::MemoryTraits::destroy(BufferParams::Impl * ptr)
388 BufferParams::BufferParams()
391 setBaseClass(defaultBaseclass());
392 cite_engine_ = "basic";
393 cite_engine_type_ = ENGINE_TYPE_DEFAULT;
395 paragraph_separation = ParagraphIndentSeparation;
396 is_math_indent = false;
397 math_numbering_side = DEFAULT;
398 quotes_style = InsetQuotesParams::EnglishQuotes;
399 dynamic_quotes = false;
400 fontsize = "default";
403 papersize = PAPER_DEFAULT;
404 orientation = ORIENTATION_PORTRAIT;
405 use_geometry = false;
406 biblio_style = string();
407 use_bibtopic = false;
410 save_transient_properties = true;
411 track_changes = false;
412 output_changes = false;
414 postpone_fragile_content = true;
415 use_default_options = true;
416 maintain_unincluded_children = false;
419 language = default_language;
421 fonts_roman[0] = "default";
422 fonts_roman[1] = "default";
423 fonts_sans[0] = "default";
424 fonts_sans[1] = "default";
425 fonts_typewriter[0] = "default";
426 fonts_typewriter[1] = "default";
427 fonts_math[0] = "auto";
428 fonts_math[1] = "auto";
429 fonts_default_family = "default";
430 useNonTeXFonts = false;
431 use_microtype = false;
432 use_dash_ligatures = true;
433 fonts_expert_sc = false;
434 fonts_roman_osf = false;
435 fonts_sans_osf = false;
436 fonts_typewriter_osf = false;
437 fonts_sans_scale[0] = 100;
438 fonts_sans_scale[1] = 100;
439 fonts_typewriter_scale[0] = 100;
440 fonts_typewriter_scale[1] = 100;
442 lang_package = "default";
443 graphics_driver = "default";
444 default_output_format = "default";
445 bibtex_command = "default";
446 index_command = "default";
449 listings_params = string();
450 pagestyle = "default";
451 tablestyle = "default";
452 suppress_date = false;
453 justification = true;
454 // no color is the default (white)
455 backgroundcolor = lyx::rgbFromHexName("#ffffff");
456 isbackgroundcolor = false;
457 // no color is the default (black)
458 fontcolor = lyx::rgbFromHexName("#000000");
460 // light gray is the default font color for greyed-out notes
461 notefontcolor = lyx::rgbFromHexName("#cccccc");
462 boxbgcolor = lyx::rgbFromHexName("#ff0000");
463 compressed = lyxrc.save_compressed;
464 for (int iter = 0; iter < 4; ++iter) {
465 user_defined_bullet(iter) = ITEMIZE_DEFAULTS[iter];
466 temp_bullet(iter) = ITEMIZE_DEFAULTS[iter];
469 indiceslist().addDefault(B_("Index"));
470 html_be_strict = false;
471 html_math_output = MathML;
472 html_math_img_scale = 1.0;
473 html_css_as_file = false;
474 display_pixel_ratio = 1.0;
476 shell_escape = false;
482 // map current author
483 author_map_[pimpl_->authorlist.get(0).bufferId()] = 0;
487 docstring BufferParams::B_(string const & l10n) const
489 LASSERT(language, return from_utf8(l10n));
490 return getMessages(language->code()).get(l10n);
494 BufferParams::Package BufferParams::use_package(std::string const & p) const
496 PackageMap::const_iterator it = use_packages.find(p);
497 if (it == use_packages.end())
503 void BufferParams::use_package(std::string const & p, BufferParams::Package u)
509 map<string, string> const & BufferParams::auto_packages()
511 static map<string, string> packages;
512 if (packages.empty()) {
513 // We could have a race condition here that two threads
514 // discover an empty map at the same time and want to fill
515 // it, but that is no problem, since the same contents is
516 // filled in twice then. Having the locker inside the
517 // packages.empty() condition has the advantage that we
518 // don't need the mutex overhead for simple reading.
520 Mutex::Locker locker(&mutex);
521 // adding a package here implies a file format change!
522 packages["amsmath"] =
523 N_("The LaTeX package amsmath is only used if AMS formula types or symbols from the AMS math toolbars are inserted into formulas");
524 packages["amssymb"] =
525 N_("The LaTeX package amssymb is only used if symbols from the AMS math toolbars are inserted into formulas");
527 N_("The LaTeX package cancel is only used if \\cancel commands are used in formulas");
529 N_("The LaTeX package esint is only used if special integral symbols are inserted into formulas");
530 packages["mathdots"] =
531 N_("The LaTeX package mathdots is only used if the command \\iddots is inserted into formulas");
532 packages["mathtools"] =
533 N_("The LaTeX package mathtools is only used if some mathematical relations are inserted into formulas");
535 N_("The LaTeX package mhchem is only used if either the command \\ce or \\cf is inserted into formulas");
536 packages["stackrel"] =
537 N_("The LaTeX package stackrel is only used if the command \\stackrel with subscript is inserted into formulas");
538 packages["stmaryrd"] =
539 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");
540 packages["undertilde"] =
541 N_("The LaTeX package undertilde is only used if you use the math frame decoration 'utilde'");
547 bool BufferParams::useBibtopic() const
551 return (use_bibtopic || (!multibib.empty() && multibib != "child"));
555 AuthorList & BufferParams::authors()
557 return pimpl_->authorlist;
561 AuthorList const & BufferParams::authors() const
563 return pimpl_->authorlist;
567 void BufferParams::addAuthor(Author a)
569 author_map_[a.bufferId()] = pimpl_->authorlist.record(a);
573 BranchList & BufferParams::branchlist()
575 return pimpl_->branchlist;
579 BranchList const & BufferParams::branchlist() const
581 return pimpl_->branchlist;
585 IndicesList & BufferParams::indiceslist()
587 return pimpl_->indiceslist;
591 IndicesList const & BufferParams::indiceslist() const
593 return pimpl_->indiceslist;
597 Bullet & BufferParams::temp_bullet(lyx::size_type const index)
599 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
600 return pimpl_->temp_bullets[index];
604 Bullet const & BufferParams::temp_bullet(lyx::size_type const index) const
606 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
607 return pimpl_->temp_bullets[index];
611 Bullet & BufferParams::user_defined_bullet(lyx::size_type const index)
613 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
614 return pimpl_->user_defined_bullets[index];
618 Bullet const & BufferParams::user_defined_bullet(lyx::size_type const index) const
620 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
621 return pimpl_->user_defined_bullets[index];
625 Spacing & BufferParams::spacing()
627 return pimpl_->spacing;
631 Spacing const & BufferParams::spacing() const
633 return pimpl_->spacing;
637 PDFOptions & BufferParams::pdfoptions()
639 return pimpl_->pdfoptions;
643 PDFOptions const & BufferParams::pdfoptions() const
645 return pimpl_->pdfoptions;
649 Length const & BufferParams::getMathIndent() const
651 return pimpl_->mathindent;
655 void BufferParams::setMathIndent(Length const & indent)
657 pimpl_->mathindent = indent;
661 Length const & BufferParams::getParIndent() const
663 return pimpl_->parindent;
667 void BufferParams::setParIndent(Length const & indent)
669 pimpl_->parindent = indent;
673 VSpace const & BufferParams::getDefSkip() const
675 return pimpl_->defskip;
679 void BufferParams::setDefSkip(VSpace const & vs)
681 // DEFSKIP will cause an infinite loop
682 LASSERT(vs.kind() != VSpace::DEFSKIP, return);
683 pimpl_->defskip = vs;
687 BufferParams::MathNumber BufferParams::getMathNumber() const
689 if (math_numbering_side != DEFAULT)
690 return math_numbering_side;
691 // FIXME: do not hardcode language here
692 else if (language->lang() == "arabic_arabi"
693 || documentClass().provides("leqno"))
700 string BufferParams::readToken(Lexer & lex, string const & token,
701 FileName const & filepath)
705 if (token == "\\textclass") {
707 string const classname = lex.getString();
708 // if there exists a local layout file, ignore the system one
709 // NOTE: in this case, the textclass (.cls file) is assumed to
712 LayoutFileList & bcl = LayoutFileList::get();
713 if (!filepath.empty()) {
714 // If classname is an absolute path, the document is
715 // using a local layout file which could not be accessed
716 // by a relative path. In this case the path is correct
717 // even if the document was moved to a different
718 // location. However, we will have a problem if the
719 // document was generated on a different platform.
720 bool isabsolute = FileName::isAbsolute(classname);
721 string const classpath = onlyPath(classname);
722 string const path = isabsolute ? classpath
723 : FileName(addPath(filepath.absFileName(),
724 classpath)).realPath();
725 string const oldpath = isabsolute ? string()
726 : FileName(addPath(origin, classpath)).realPath();
727 tcp = bcl.addLocalLayout(onlyFileName(classname), path, oldpath);
729 // that returns non-empty if a "local" layout file is found.
731 result = to_utf8(makeRelPath(from_utf8(onlyPath(tcp)),
732 from_utf8(filepath.absFileName())));
735 setBaseClass(onlyFileName(tcp));
737 setBaseClass(onlyFileName(classname));
738 // We assume that a tex class exists for local or unknown
739 // layouts so this warning, will only be given for system layouts.
740 if (!baseClass()->isTeXClassAvailable()) {
741 docstring const desc =
742 translateIfPossible(from_utf8(baseClass()->description()));
743 docstring const prereqs =
744 from_utf8(baseClass()->prerequisites());
745 docstring const msg =
746 bformat(_("The selected document class\n"
748 "requires external files that are not available.\n"
749 "The document class can still be used, but the\n"
750 "document cannot be compiled until the following\n"
751 "prerequisites are installed:\n"
753 "See section 3.1.2.2 (Class Availability) of the\n"
754 "User's Guide for more information."), desc, prereqs);
755 frontend::Alert::warning(_("Document class not available"),
758 } else if (token == "\\save_transient_properties") {
759 lex >> save_transient_properties;
760 } else if (token == "\\origin") {
762 origin = lex.getString();
763 string const sysdirprefix = "/systemlyxdir/";
764 if (prefixIs(origin, sysdirprefix)) {
766 if (inSystemDir(filepath, docsys))
767 origin.replace(0, sysdirprefix.length() - 1, docsys);
769 origin.replace(0, sysdirprefix.length() - 1,
770 package().system_support().absFileName());
772 } else if (token == "\\begin_preamble") {
774 } else if (token == "\\begin_local_layout") {
775 readLocalLayout(lex, false);
776 } else if (token == "\\begin_forced_local_layout") {
777 readLocalLayout(lex, true);
778 } else if (token == "\\begin_modules") {
780 } else if (token == "\\begin_removed_modules") {
781 readRemovedModules(lex);
782 } else if (token == "\\begin_includeonly") {
783 readIncludeonly(lex);
784 } else if (token == "\\maintain_unincluded_children") {
785 lex >> maintain_unincluded_children;
786 } else if (token == "\\options") {
788 options = lex.getString();
789 } else if (token == "\\use_default_options") {
790 lex >> use_default_options;
791 } else if (token == "\\master") {
793 master = lex.getString();
794 if (!filepath.empty() && FileName::isAbsolute(origin)) {
795 bool const isabs = FileName::isAbsolute(master);
796 FileName const abspath(isabs ? master : origin + master);
797 bool const moved = filepath != FileName(origin);
798 if (moved && abspath.exists()) {
799 docstring const path = isabs
801 : from_utf8(abspath.realPath());
802 docstring const refpath =
803 from_utf8(filepath.absFileName());
804 master = to_utf8(makeRelPath(path, refpath));
807 } else if (token == "\\suppress_date") {
808 lex >> suppress_date;
809 } else if (token == "\\justification") {
810 lex >> justification;
811 } else if (token == "\\language") {
813 } else if (token == "\\language_package") {
815 lang_package = lex.getString();
816 } else if (token == "\\inputencoding") {
818 } else if (token == "\\graphics") {
819 readGraphicsDriver(lex);
820 } else if (token == "\\default_output_format") {
821 lex >> default_output_format;
822 } else if (token == "\\bibtex_command") {
824 bibtex_command = lex.getString();
825 } else if (token == "\\index_command") {
827 index_command = lex.getString();
828 } else if (token == "\\fontencoding") {
830 fontenc = lex.getString();
831 } else if (token == "\\font_roman") {
832 lex >> fonts_roman[0];
833 lex >> fonts_roman[1];
834 } else if (token == "\\font_sans") {
835 lex >> fonts_sans[0];
836 lex >> fonts_sans[1];
837 } else if (token == "\\font_typewriter") {
838 lex >> fonts_typewriter[0];
839 lex >> fonts_typewriter[1];
840 } else if (token == "\\font_math") {
841 lex >> fonts_math[0];
842 lex >> fonts_math[1];
843 } else if (token == "\\font_default_family") {
844 lex >> fonts_default_family;
845 } else if (token == "\\use_non_tex_fonts") {
846 lex >> useNonTeXFonts;
847 } else if (token == "\\font_sc") {
848 lex >> fonts_expert_sc;
849 } else if (token == "\\font_roman_osf") {
850 lex >> fonts_roman_osf;
851 } else if (token == "\\font_sans_osf") {
852 lex >> fonts_sans_osf;
853 } else if (token == "\\font_typewriter_osf") {
854 lex >> fonts_typewriter_osf;
855 } else if (token == "\\font_roman_opts") {
856 lex >> font_roman_opts;
857 } else if (token == "\\font_sf_scale") {
858 lex >> fonts_sans_scale[0];
859 lex >> fonts_sans_scale[1];
860 } else if (token == "\\font_sans_opts") {
861 lex >> font_sans_opts;
862 } else if (token == "\\font_tt_scale") {
863 lex >> fonts_typewriter_scale[0];
864 lex >> fonts_typewriter_scale[1];
865 } else if (token == "\\font_typewriter_opts") {
866 lex >> font_typewriter_opts;
867 } else if (token == "\\font_cjk") {
869 } else if (token == "\\use_microtype") {
870 lex >> use_microtype;
871 } else if (token == "\\use_dash_ligatures") {
872 lex >> use_dash_ligatures;
873 } else if (token == "\\paragraph_separation") {
876 paragraph_separation = parseptranslator().find(parsep);
877 } else if (token == "\\paragraph_indentation") {
879 string parindent = lex.getString();
880 if (parindent == "default")
881 pimpl_->parindent = Length();
883 pimpl_->parindent = Length(parindent);
884 } else if (token == "\\defskip") {
886 string const defskip = lex.getString();
887 pimpl_->defskip = VSpace(defskip);
888 if (pimpl_->defskip.kind() == VSpace::DEFSKIP)
890 pimpl_->defskip = VSpace(VSpace::MEDSKIP);
891 } else if (token == "\\is_math_indent") {
892 lex >> is_math_indent;
893 } else if (token == "\\math_indentation") {
895 string mathindent = lex.getString();
896 if (mathindent == "default")
897 pimpl_->mathindent = Length();
899 pimpl_->mathindent = Length(mathindent);
900 } else if (token == "\\math_numbering_side") {
904 math_numbering_side = LEFT;
905 else if (tmp == "right")
906 math_numbering_side = RIGHT;
908 math_numbering_side = DEFAULT;
909 } else if (token == "\\quotes_style") {
912 quotes_style = quotesstyletranslator().find(qstyle);
913 } else if (token == "\\dynamic_quotes") {
914 lex >> dynamic_quotes;
915 } else if (token == "\\papersize") {
918 papersize = papersizetranslator().find(ppsize);
919 } else if (token == "\\use_geometry") {
921 } else if (token == "\\use_package") {
926 use_package(package, packagetranslator().find(use));
927 } else if (token == "\\cite_engine") {
929 cite_engine_ = lex.getString();
930 } else if (token == "\\cite_engine_type") {
933 cite_engine_type_ = theCiteEnginesList.getType(engine_type);
934 } else if (token == "\\biblio_style") {
936 biblio_style = lex.getString();
937 } else if (token == "\\biblio_options") {
939 biblio_opts = trim(lex.getString());
940 } else if (token == "\\biblatex_bibstyle") {
942 biblatex_bibstyle = trim(lex.getString());
943 } else if (token == "\\biblatex_citestyle") {
945 biblatex_citestyle = trim(lex.getString());
946 } else if (token == "\\use_bibtopic") {
948 } else if (token == "\\multibib") {
950 } else if (token == "\\use_indices") {
952 } else if (token == "\\tracking_changes") {
953 lex >> track_changes;
954 } else if (token == "\\output_changes") {
955 lex >> output_changes;
956 } else if (token == "\\change_bars") {
958 } else if (token == "\\postpone_fragile_content") {
959 lex >> postpone_fragile_content;
960 } else if (token == "\\branch") {
962 docstring branch = lex.getDocString();
963 branchlist().add(branch);
966 string const tok = lex.getString();
967 if (tok == "\\end_branch")
969 Branch * branch_ptr = branchlist().find(branch);
970 if (tok == "\\selected") {
973 branch_ptr->setSelected(lex.getInteger());
975 if (tok == "\\filename_suffix") {
978 branch_ptr->setFileNameSuffix(lex.getInteger());
980 if (tok == "\\color") {
982 string color = lex.getString();
984 branch_ptr->setColor(color);
985 // Update also the Color table:
987 color = lcolor.getX11Name(Color_background);
989 lcolor.setColor(to_utf8(branch), color);
992 } else if (token == "\\index") {
994 docstring index = lex.getDocString();
996 indiceslist().add(index);
999 string const tok = lex.getString();
1000 if (tok == "\\end_index")
1002 Index * index_ptr = indiceslist().find(index);
1003 if (tok == "\\shortcut") {
1005 shortcut = lex.getDocString();
1007 index_ptr->setShortcut(shortcut);
1009 if (tok == "\\color") {
1011 string color = lex.getString();
1013 index_ptr->setColor(color);
1014 // Update also the Color table:
1015 if (color == "none")
1016 color = lcolor.getX11Name(Color_background);
1018 if (!shortcut.empty())
1019 lcolor.setColor(to_utf8(shortcut), color);
1022 } else if (token == "\\author") {
1024 istringstream ss(lex.getString());
1028 } else if (token == "\\paperorientation") {
1031 orientation = paperorientationtranslator().find(orient);
1032 } else if (token == "\\backgroundcolor") {
1034 backgroundcolor = lyx::rgbFromHexName(lex.getString());
1035 isbackgroundcolor = true;
1036 } else if (token == "\\fontcolor") {
1038 fontcolor = lyx::rgbFromHexName(lex.getString());
1040 } else if (token == "\\notefontcolor") {
1042 string color = lex.getString();
1043 notefontcolor = lyx::rgbFromHexName(color);
1044 lcolor.setColor("notefontcolor", color);
1045 } else if (token == "\\boxbgcolor") {
1047 string color = lex.getString();
1048 boxbgcolor = lyx::rgbFromHexName(color);
1049 lcolor.setColor("boxbgcolor", color);
1050 } else if (token == "\\paperwidth") {
1052 } else if (token == "\\paperheight") {
1054 } else if (token == "\\leftmargin") {
1056 } else if (token == "\\topmargin") {
1058 } else if (token == "\\rightmargin") {
1060 } else if (token == "\\bottommargin") {
1061 lex >> bottommargin;
1062 } else if (token == "\\headheight") {
1064 } else if (token == "\\headsep") {
1066 } else if (token == "\\footskip") {
1068 } else if (token == "\\columnsep") {
1070 } else if (token == "\\paperfontsize") {
1072 } else if (token == "\\papercolumns") {
1074 } else if (token == "\\listings_params") {
1077 listings_params = InsetListingsParams(par).params();
1078 } else if (token == "\\papersides") {
1081 sides = sidestranslator().find(psides);
1082 } else if (token == "\\paperpagestyle") {
1084 } else if (token == "\\tablestyle") {
1086 } else if (token == "\\bullet") {
1088 } else if (token == "\\bulletLaTeX") {
1089 readBulletsLaTeX(lex);
1090 } else if (token == "\\secnumdepth") {
1092 } else if (token == "\\tocdepth") {
1094 } else if (token == "\\spacing") {
1098 if (nspacing == "other") {
1101 spacing().set(spacetranslator().find(nspacing), tmp_val);
1102 } else if (token == "\\float_placement") {
1103 lex >> float_placement;
1104 } else if (token == "\\float_alignment") {
1105 lex >> float_alignment;
1107 } else if (prefixIs(token, "\\pdf_") || token == "\\use_hyperref") {
1108 string toktmp = pdfoptions().readToken(lex, token);
1109 if (!toktmp.empty()) {
1110 lyxerr << "PDFOptions::readToken(): Unknown token: " <<
1114 } else if (token == "\\html_math_output") {
1117 html_math_output = static_cast<MathOutput>(temp);
1118 } else if (token == "\\html_be_strict") {
1119 lex >> html_be_strict;
1120 } else if (token == "\\html_css_as_file") {
1121 lex >> html_css_as_file;
1122 } else if (token == "\\html_math_img_scale") {
1123 lex >> html_math_img_scale;
1124 } else if (token == "\\html_latex_start") {
1126 html_latex_start = lex.getString();
1127 } else if (token == "\\html_latex_end") {
1129 html_latex_end = lex.getString();
1130 } else if (token == "\\output_sync") {
1132 } else if (token == "\\output_sync_macro") {
1133 lex >> output_sync_macro;
1134 } else if (token == "\\use_refstyle") {
1135 lex >> use_refstyle;
1136 } else if (token == "\\use_minted") {
1138 } else if (token == "\\use_lineno") {
1140 } else if (token == "\\lineno_options") {
1142 lineno_opts = trim(lex.getString());
1144 lyxerr << "BufferParams::readToken(): Unknown token: " <<
1154 // Quote argument if it contains spaces
1155 string quoteIfNeeded(string const & str) {
1156 if (contains(str, ' '))
1157 return "\"" + str + "\"";
1163 void BufferParams::writeFile(ostream & os, Buffer const * buf) const
1165 // The top of the file is written by the buffer.
1166 // Prints out the buffer info into the .lyx file given by file
1168 os << "\\save_transient_properties "
1169 << convert<string>(save_transient_properties) << '\n';
1171 // the document directory (must end with a path separator)
1172 // realPath() is used to resolve symlinks, while addPath(..., "")
1173 // ensures a trailing path separator.
1175 string filepath = addPath(buf->fileName().onlyPath().realPath(), "");
1176 string const sysdir = inSystemDir(FileName(filepath), docsys) ? docsys
1177 : addPath(package().system_support().realPath(), "");
1178 string const relpath =
1179 to_utf8(makeRelPath(from_utf8(filepath), from_utf8(sysdir)));
1180 if (!prefixIs(relpath, "../") && !FileName::isAbsolute(relpath))
1181 filepath = addPath("/systemlyxdir", relpath);
1182 else if (!save_transient_properties || !lyxrc.save_origin)
1183 filepath = "unavailable";
1184 os << "\\origin " << quoteIfNeeded(filepath) << '\n';
1187 os << "\\textclass "
1188 << quoteIfNeeded(buf->includedFilePath(addName(buf->layoutPos(),
1189 baseClass()->name()), "layout"))
1192 // then the preamble
1193 if (!preamble.empty()) {
1194 // remove '\n' from the end of preamble
1195 docstring const tmppreamble = rtrim(preamble, "\n");
1196 os << "\\begin_preamble\n"
1197 << to_utf8(tmppreamble)
1198 << "\n\\end_preamble\n";
1202 if (!options.empty()) {
1203 os << "\\options " << options << '\n';
1206 // use the class options defined in the layout?
1207 os << "\\use_default_options "
1208 << convert<string>(use_default_options) << "\n";
1210 // the master document
1211 if (!master.empty()) {
1212 os << "\\master " << master << '\n';
1216 if (!removed_modules_.empty()) {
1217 os << "\\begin_removed_modules" << '\n';
1218 list<string>::const_iterator it = removed_modules_.begin();
1219 list<string>::const_iterator en = removed_modules_.end();
1220 for (; it != en; ++it)
1222 os << "\\end_removed_modules" << '\n';
1226 if (!layout_modules_.empty()) {
1227 os << "\\begin_modules" << '\n';
1228 LayoutModuleList::const_iterator it = layout_modules_.begin();
1229 LayoutModuleList::const_iterator en = layout_modules_.end();
1230 for (; it != en; ++it)
1232 os << "\\end_modules" << '\n';
1236 if (!included_children_.empty()) {
1237 os << "\\begin_includeonly" << '\n';
1238 list<string>::const_iterator it = included_children_.begin();
1239 list<string>::const_iterator en = included_children_.end();
1240 for (; it != en; ++it)
1242 os << "\\end_includeonly" << '\n';
1244 os << "\\maintain_unincluded_children "
1245 << convert<string>(maintain_unincluded_children) << '\n';
1247 // local layout information
1248 docstring const local_layout = getLocalLayout(false);
1249 if (!local_layout.empty()) {
1250 // remove '\n' from the end
1251 docstring const tmplocal = rtrim(local_layout, "\n");
1252 os << "\\begin_local_layout\n"
1253 << to_utf8(tmplocal)
1254 << "\n\\end_local_layout\n";
1256 docstring const forced_local_layout = getLocalLayout(true);
1257 if (!forced_local_layout.empty()) {
1258 // remove '\n' from the end
1259 docstring const tmplocal = rtrim(forced_local_layout, "\n");
1260 os << "\\begin_forced_local_layout\n"
1261 << to_utf8(tmplocal)
1262 << "\n\\end_forced_local_layout\n";
1265 // then the text parameters
1266 if (language != ignore_language)
1267 os << "\\language " << language->lang() << '\n';
1268 os << "\\language_package " << lang_package
1269 << "\n\\inputencoding " << inputenc
1270 << "\n\\fontencoding " << fontenc
1271 << "\n\\font_roman \"" << fonts_roman[0]
1272 << "\" \"" << fonts_roman[1] << '"'
1273 << "\n\\font_sans \"" << fonts_sans[0]
1274 << "\" \"" << fonts_sans[1] << '"'
1275 << "\n\\font_typewriter \"" << fonts_typewriter[0]
1276 << "\" \"" << fonts_typewriter[1] << '"'
1277 << "\n\\font_math \"" << fonts_math[0]
1278 << "\" \"" << fonts_math[1] << '"'
1279 << "\n\\font_default_family " << fonts_default_family
1280 << "\n\\use_non_tex_fonts " << convert<string>(useNonTeXFonts)
1281 << "\n\\font_sc " << convert<string>(fonts_expert_sc)
1282 << "\n\\font_roman_osf " << convert<string>(fonts_roman_osf)
1283 << "\n\\font_sans_osf " << convert<string>(fonts_sans_osf)
1284 << "\n\\font_typewriter_osf " << convert<string>(fonts_typewriter_osf);
1285 if (!font_roman_opts.empty())
1286 os << "\n\\font_roman_opts \"" << font_roman_opts << "\"";
1287 os << "\n\\font_sf_scale " << fonts_sans_scale[0]
1288 << ' ' << fonts_sans_scale[1];
1289 if (!font_sans_opts.empty())
1290 os << "\n\\font_sans_opts \"" << font_sans_opts << "\"";
1291 os << "\n\\font_tt_scale " << fonts_typewriter_scale[0]
1292 << ' ' << fonts_typewriter_scale[1];
1293 if (!font_typewriter_opts.empty())
1294 os << "\n\\font_typewriter_opts \"" << font_typewriter_opts << "\"";
1296 if (!fonts_cjk.empty())
1297 os << "\\font_cjk " << fonts_cjk << '\n';
1298 os << "\\use_microtype " << convert<string>(use_microtype) << '\n';
1299 os << "\\use_dash_ligatures " << convert<string>(use_dash_ligatures) << '\n';
1300 os << "\\graphics " << graphics_driver << '\n';
1301 os << "\\default_output_format " << default_output_format << '\n';
1302 os << "\\output_sync " << output_sync << '\n';
1303 if (!output_sync_macro.empty())
1304 os << "\\output_sync_macro \"" << output_sync_macro << "\"\n";
1305 os << "\\bibtex_command " << bibtex_command << '\n';
1306 os << "\\index_command " << index_command << '\n';
1308 if (!float_placement.empty())
1309 os << "\\float_placement " << float_placement << '\n';
1310 if (!float_alignment.empty())
1311 os << "\\float_alignment " << float_alignment << '\n';
1312 os << "\\paperfontsize " << fontsize << '\n';
1314 spacing().writeFile(os);
1315 pdfoptions().writeFile(os);
1317 os << "\\papersize " << string_papersize[papersize]
1318 << "\n\\use_geometry " << convert<string>(use_geometry);
1319 map<string, string> const & packages = auto_packages();
1320 for (map<string, string>::const_iterator it = packages.begin();
1321 it != packages.end(); ++it)
1322 os << "\n\\use_package " << it->first << ' '
1323 << use_package(it->first);
1325 os << "\n\\cite_engine ";
1327 if (!cite_engine_.empty())
1332 os << "\n\\cite_engine_type " << theCiteEnginesList.getTypeAsString(cite_engine_type_);
1334 if (!biblio_style.empty())
1335 os << "\n\\biblio_style " << biblio_style;
1336 if (!biblio_opts.empty())
1337 os << "\n\\biblio_options " << biblio_opts;
1338 if (!biblatex_bibstyle.empty())
1339 os << "\n\\biblatex_bibstyle " << biblatex_bibstyle;
1340 if (!biblatex_citestyle.empty())
1341 os << "\n\\biblatex_citestyle " << biblatex_citestyle;
1342 if (!multibib.empty())
1343 os << "\n\\multibib " << multibib;
1345 os << "\n\\use_bibtopic " << convert<string>(use_bibtopic)
1346 << "\n\\use_indices " << convert<string>(use_indices)
1347 << "\n\\paperorientation " << string_orientation[orientation]
1348 << "\n\\suppress_date " << convert<string>(suppress_date)
1349 << "\n\\justification " << convert<string>(justification)
1350 << "\n\\use_refstyle " << use_refstyle
1351 << "\n\\use_minted " << use_minted
1352 << "\n\\use_lineno " << use_lineno
1355 if (!lineno_opts.empty())
1356 os << "\\lineno_options " << lineno_opts << '\n';
1358 if (isbackgroundcolor == true)
1359 os << "\\backgroundcolor " << lyx::X11hexname(backgroundcolor) << '\n';
1360 if (isfontcolor == true)
1361 os << "\\fontcolor " << lyx::X11hexname(fontcolor) << '\n';
1362 if (notefontcolor != lyx::rgbFromHexName("#cccccc"))
1363 os << "\\notefontcolor " << lyx::X11hexname(notefontcolor) << '\n';
1364 if (boxbgcolor != lyx::rgbFromHexName("#ff0000"))
1365 os << "\\boxbgcolor " << lyx::X11hexname(boxbgcolor) << '\n';
1367 BranchList::const_iterator it = branchlist().begin();
1368 BranchList::const_iterator end = branchlist().end();
1369 for (; it != end; ++it) {
1370 os << "\\branch " << to_utf8(it->branch())
1371 << "\n\\selected " << it->isSelected()
1372 << "\n\\filename_suffix " << it->hasFileNameSuffix()
1373 << "\n\\color " << lyx::X11hexname(it->color())
1378 IndicesList::const_iterator iit = indiceslist().begin();
1379 IndicesList::const_iterator iend = indiceslist().end();
1380 for (; iit != iend; ++iit) {
1381 os << "\\index " << to_utf8(iit->index())
1382 << "\n\\shortcut " << to_utf8(iit->shortcut())
1383 << "\n\\color " << lyx::X11hexname(iit->color())
1388 if (!paperwidth.empty())
1389 os << "\\paperwidth "
1390 << VSpace(paperwidth).asLyXCommand() << '\n';
1391 if (!paperheight.empty())
1392 os << "\\paperheight "
1393 << VSpace(paperheight).asLyXCommand() << '\n';
1394 if (!leftmargin.empty())
1395 os << "\\leftmargin "
1396 << VSpace(leftmargin).asLyXCommand() << '\n';
1397 if (!topmargin.empty())
1398 os << "\\topmargin "
1399 << VSpace(topmargin).asLyXCommand() << '\n';
1400 if (!rightmargin.empty())
1401 os << "\\rightmargin "
1402 << VSpace(rightmargin).asLyXCommand() << '\n';
1403 if (!bottommargin.empty())
1404 os << "\\bottommargin "
1405 << VSpace(bottommargin).asLyXCommand() << '\n';
1406 if (!headheight.empty())
1407 os << "\\headheight "
1408 << VSpace(headheight).asLyXCommand() << '\n';
1409 if (!headsep.empty())
1411 << VSpace(headsep).asLyXCommand() << '\n';
1412 if (!footskip.empty())
1414 << VSpace(footskip).asLyXCommand() << '\n';
1415 if (!columnsep.empty())
1416 os << "\\columnsep "
1417 << VSpace(columnsep).asLyXCommand() << '\n';
1418 os << "\\secnumdepth " << secnumdepth
1419 << "\n\\tocdepth " << tocdepth
1420 << "\n\\paragraph_separation "
1421 << string_paragraph_separation[paragraph_separation];
1422 if (!paragraph_separation)
1423 os << "\n\\paragraph_indentation "
1424 << (getParIndent().empty() ? "default" : getParIndent().asString());
1426 os << "\n\\defskip " << getDefSkip().asLyXCommand();
1427 os << "\n\\is_math_indent " << is_math_indent;
1429 os << "\n\\math_indentation "
1430 << (getMathIndent().empty() ? "default" : getMathIndent().asString());
1431 os << "\n\\math_numbering_side ";
1432 switch(math_numbering_side) {
1442 os << "\n\\quotes_style "
1443 << string_quotes_style[quotes_style]
1444 << "\n\\dynamic_quotes " << dynamic_quotes
1445 << "\n\\papercolumns " << columns
1446 << "\n\\papersides " << sides
1447 << "\n\\paperpagestyle " << pagestyle
1448 << "\n\\tablestyle " << tablestyle << '\n';
1449 if (!listings_params.empty())
1450 os << "\\listings_params \"" <<
1451 InsetListingsParams(listings_params).encodedString() << "\"\n";
1452 for (int i = 0; i < 4; ++i) {
1453 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1454 if (user_defined_bullet(i).getFont() != -1) {
1455 os << "\\bullet " << i << " "
1456 << user_defined_bullet(i).getFont() << " "
1457 << user_defined_bullet(i).getCharacter() << " "
1458 << user_defined_bullet(i).getSize() << "\n";
1462 os << "\\bulletLaTeX " << i << " \""
1463 << lyx::to_ascii(user_defined_bullet(i).getText())
1469 os << "\\tracking_changes "
1470 << (save_transient_properties ? convert<string>(track_changes) : "false")
1473 os << "\\output_changes "
1474 << (save_transient_properties ? convert<string>(output_changes) : "false")
1477 os << "\\change_bars "
1478 << (save_transient_properties ? convert<string>(change_bars) : "false")
1481 os << "\\postpone_fragile_content " << convert<string>(postpone_fragile_content) << '\n';
1483 os << "\\html_math_output " << html_math_output << '\n'
1484 << "\\html_css_as_file " << html_css_as_file << '\n'
1485 << "\\html_be_strict " << convert<string>(html_be_strict) << '\n';
1487 if (html_math_img_scale != 1.0)
1488 os << "\\html_math_img_scale " << convert<string>(html_math_img_scale) << '\n';
1489 if (!html_latex_start.empty())
1490 os << "\\html_latex_start " << html_latex_start << '\n';
1491 if (!html_latex_end.empty())
1492 os << "\\html_latex_end " << html_latex_end << '\n';
1494 os << pimpl_->authorlist;
1498 void BufferParams::validate(LaTeXFeatures & features) const
1500 features.require(documentClass().required());
1502 if (columns > 1 && language->rightToLeft())
1503 features.require("rtloutputdblcol");
1505 if (output_changes) {
1506 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1507 LaTeXFeatures::isAvailable("xcolor");
1509 switch (features.runparams().flavor) {
1510 case OutputParams::LATEX:
1511 case OutputParams::DVILUATEX:
1513 features.require("ct-xcolor-ulem");
1514 features.require("ulem");
1515 features.require("xcolor");
1517 features.require("ct-none");
1520 case OutputParams::LUATEX:
1521 case OutputParams::PDFLATEX:
1522 case OutputParams::XETEX:
1524 features.require("ct-xcolor-ulem");
1525 features.require("ulem");
1526 features.require("xcolor");
1527 // improves color handling in PDF output
1528 features.require("pdfcolmk");
1530 features.require("ct-none");
1537 features.require("changebar");
1540 // Floats with 'Here definitely' as default setting.
1541 if (float_placement.find('H') != string::npos)
1542 features.require("float");
1544 for (PackageMap::const_iterator it = use_packages.begin();
1545 it != use_packages.end(); ++it) {
1546 if (it->first == "amsmath") {
1547 // AMS Style is at document level
1548 if (it->second == package_on ||
1549 features.isProvided("amsmath"))
1550 features.require(it->first);
1551 } else if (it->second == package_on)
1552 features.require(it->first);
1555 // Document-level line spacing
1556 if (spacing().getSpace() != Spacing::Single && !spacing().isDefault())
1557 features.require("setspace");
1559 // the bullet shapes are buffer level not paragraph level
1560 // so they are tested here
1561 for (int i = 0; i < 4; ++i) {
1562 if (user_defined_bullet(i) == ITEMIZE_DEFAULTS[i])
1564 int const font = user_defined_bullet(i).getFont();
1566 int const c = user_defined_bullet(i).getCharacter();
1572 features.require("latexsym");
1574 } else if (font == 1) {
1575 features.require("amssymb");
1576 } else if (font >= 2 && font <= 5) {
1577 features.require("pifont");
1581 if (pdfoptions().use_hyperref) {
1582 features.require("hyperref");
1583 // due to interferences with babel and hyperref, the color package has to
1584 // be loaded after hyperref when hyperref is used with the colorlinks
1585 // option, see http://www.lyx.org/trac/ticket/5291
1586 if (pdfoptions().colorlinks)
1587 features.require("color");
1589 if (!listings_params.empty()) {
1590 // do not test validity because listings_params is
1591 // supposed to be valid
1593 InsetListingsParams(listings_params).separatedParams(true);
1594 // we can't support all packages, but we should load the color package
1595 if (par.find("\\color", 0) != string::npos)
1596 features.require("color");
1599 // some languages are only available via polyglossia
1600 if (features.hasPolyglossiaExclusiveLanguages())
1601 features.require("polyglossia");
1603 if (useNonTeXFonts && fontsMath() != "auto")
1604 features.require("unicode-math");
1607 features.require("microtype");
1609 if (!language->required().empty())
1610 features.require(language->required());
1614 bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
1615 FileName const & filepath) const
1617 // http://www.tug.org/texmf-dist/doc/latex/base/fixltx2e.pdf
1618 // !! To use the Fix-cm package, load it before \documentclass, and use the command
1619 // \RequirePackage to do so, rather than the normal \usepackage
1620 // Do not try to load any other package before the document class, unless you
1621 // have a thorough understanding of the LATEX internals and know exactly what you
1623 if (features.mustProvide("fix-cm"))
1624 os << "\\RequirePackage{fix-cm}\n";
1625 // Likewise for fixltx2e. If other packages conflict with this policy,
1626 // treat it as a package bug (and report it!)
1627 // See http://www.latex-project.org/cgi-bin/ltxbugs2html?pr=latex/4407
1628 if (features.mustProvide("fixltx2e"))
1629 os << "\\RequirePackage{fixltx2e}\n";
1631 os << "\\documentclass";
1633 DocumentClass const & tclass = documentClass();
1635 ostringstream clsoptions; // the document class options.
1637 if (tokenPos(tclass.opt_fontsize(),
1638 '|', fontsize) >= 0) {
1639 // only write if existing in list (and not default)
1640 clsoptions << subst(tclass.fontsizeformat(), "$$s", fontsize) << ",";
1643 // paper sizes not supported by the class itself need the
1645 vector<string> classpsizes = getVectorFromString(tclass.opt_pagesize(), "|");
1646 bool class_supported_papersize = papersize == PAPER_DEFAULT
1647 || find(classpsizes.begin(), classpsizes.end(), string_papersize[papersize]) != classpsizes.end();
1649 if ((!use_geometry || features.isProvided("geometry-light"))
1650 && class_supported_papersize && papersize != PAPER_DEFAULT)
1651 clsoptions << subst(tclass.pagesizeformat(), "$$s", string_papersize[papersize]) << ",";
1654 if (sides != tclass.sides()) {
1657 clsoptions << "oneside,";
1660 clsoptions << "twoside,";
1666 if (columns != tclass.columns()) {
1668 clsoptions << "twocolumn,";
1670 clsoptions << "onecolumn,";
1674 && orientation == ORIENTATION_LANDSCAPE)
1675 clsoptions << "landscape,";
1678 clsoptions << "fleqn,";
1680 switch(math_numbering_side) {
1682 clsoptions << "leqno,";
1685 clsoptions << "reqno,";
1686 features.require("amsmath");
1692 // language should be a parameter to \documentclass
1693 if (language->babel() == "hebrew"
1694 && default_language->babel() != "hebrew")
1695 // This seems necessary
1696 features.useLanguage(default_language);
1698 ostringstream language_options;
1699 bool const use_babel = features.useBabel() && !features.isProvided("babel");
1700 bool const use_polyglossia = features.usePolyglossia();
1701 bool const global = lyxrc.language_global_options;
1702 if (features.useBabel() || (use_polyglossia && global)) {
1703 language_options << features.getBabelLanguages();
1704 if (!language->babel().empty()) {
1705 if (!language_options.str().empty())
1706 language_options << ',';
1707 language_options << language->babel();
1709 if (global && !language_options.str().empty())
1710 clsoptions << language_options.str() << ',';
1713 // the predefined options from the layout
1714 if (use_default_options && !tclass.options().empty())
1715 clsoptions << tclass.options() << ',';
1717 // the user-defined options
1718 if (!options.empty()) {
1719 clsoptions << options << ',';
1722 string strOptions(clsoptions.str());
1723 if (!strOptions.empty()) {
1724 strOptions = rtrim(strOptions, ",");
1726 os << '[' << from_utf8(strOptions) << ']';
1729 os << '{' << from_ascii(tclass.latexname()) << "}\n";
1730 // end of \documentclass defs
1732 // if we use fontspec or newtxmath, we have to load the AMS packages here
1733 string const ams = features.loadAMSPackages();
1734 bool const ot1 = (main_font_encoding() == "default" || main_font_encoding() == "OT1");
1735 bool const use_newtxmath =
1736 theLaTeXFonts().getLaTeXFont(from_ascii(fontsMath())).getUsedPackage(
1737 ot1, false, false) == "newtxmath";
1738 if ((useNonTeXFonts || use_newtxmath) && !ams.empty())
1739 os << from_ascii(ams);
1741 if (useNonTeXFonts) {
1742 // Babel (as of 2017/11/03) loads fontspec itself
1743 if (!features.isProvided("fontspec")
1744 && !(features.useBabel() && features.isAvailable("babel-2017/11/03")))
1745 os << "\\usepackage{fontspec}\n";
1746 if (features.mustProvide("unicode-math")
1747 && features.isAvailable("unicode-math"))
1748 os << "\\usepackage{unicode-math}\n";
1751 // load CJK support package before font selection
1752 // (see autotests/export/latex/CJK/micro-sign_utf8-cjk-libertine.lyx)
1753 if (!useNonTeXFonts && encoding().package() != Encoding::none && inputenc != "utf8x"
1754 && (encoding().package() == Encoding::CJK || features.mustProvide("CJK"))) {
1755 if (inputenc == "utf8-cjk" || inputenc == "utf8")
1756 os << "\\usepackage{CJKutf8}\n";
1758 os << "\\usepackage[encapsulated]{CJK}\n";
1761 // font selection must be done before loading fontenc.sty
1762 // but after babel with non-TeX fonts
1763 string const fonts = loadFonts(features);
1764 if (!fonts.empty() && (!features.useBabel() || !useNonTeXFonts))
1765 os << from_utf8(fonts);
1767 if (fonts_default_family != "default")
1768 os << "\\renewcommand{\\familydefault}{\\"
1769 << from_ascii(fonts_default_family) << "}\n";
1771 // set font encoding
1772 // non-TeX fonts use font encoding TU (set by fontspec)
1773 if (!useNonTeXFonts && !features.isProvided("fontenc")
1774 && main_font_encoding() != "default") {
1775 // get main font encodings
1776 vector<string> fontencs = font_encodings();
1777 // get font encodings of secondary languages
1778 // FIXME: some languages (hebrew, ...) assume a standard font encoding as last
1779 // option (for text in other languages).
1780 features.getFontEncodings(fontencs);
1781 if (!fontencs.empty()) {
1782 os << "\\usepackage["
1783 << from_ascii(getStringFromVector(fontencs))
1788 // Load textcomp and pmboxdraw before (lua)inputenc (#11454)
1789 if (features.mustProvide("textcomp"))
1790 os << "\\usepackage{textcomp}\n";
1791 if (features.mustProvide("pmboxdraw"))
1792 os << "\\usepackage{pmboxdraw}\n";
1794 // handle inputenc etc.
1795 // (In documents containing text in Thai language,
1796 // we must load inputenc after babel, see lib/languages).
1797 if (!contains(features.getBabelPostsettings(), from_ascii("thai.ldf")))
1798 writeEncodingPreamble(os, features);
1801 if (!features.runparams().includeall && !included_children_.empty()) {
1802 os << "\\includeonly{";
1803 list<string>::const_iterator it = included_children_.begin();
1804 list<string>::const_iterator en = included_children_.end();
1806 for (; it != en; ++it) {
1807 string incfile = *it;
1808 FileName inc = makeAbsPath(incfile, filepath.absFileName());
1809 string mangled = DocFileName(changeExtension(inc.absFileName(), ".tex")).
1811 if (!features.runparams().nice)
1813 // \includeonly doesn't want an extension
1814 incfile = changeExtension(incfile, string());
1815 incfile = support::latex_path(incfile);
1816 if (!incfile.empty()) {
1819 os << from_utf8(incfile);
1826 if (!features.isProvided("geometry")
1827 && (use_geometry || !class_supported_papersize)) {
1828 odocstringstream ods;
1829 if (!getGraphicsDriver("geometry").empty())
1830 ods << getGraphicsDriver("geometry");
1831 if (orientation == ORIENTATION_LANDSCAPE)
1832 ods << ",landscape";
1833 switch (papersize) {
1835 if (!paperwidth.empty())
1836 ods << ",paperwidth="
1837 << from_ascii(paperwidth);
1838 if (!paperheight.empty())
1839 ods << ",paperheight="
1840 << from_ascii(paperheight);
1842 case PAPER_USLETTER:
1844 case PAPER_USEXECUTIVE:
1873 ods << "," << from_ascii(string_papersize_geometry[papersize]);
1878 docstring g_options = trim(ods.str(), ",");
1879 os << "\\usepackage";
1880 // geometry-light means that the class works with geometry, but overwrites
1881 // the package options and paper sizes (memoir does this).
1882 // In this case, all options need to go to \geometry
1883 // and the standard paper sizes need to go to the class options.
1884 if (!g_options.empty() && !features.isProvided("geometry-light")) {
1885 os << '[' << g_options << ']';
1888 os << "{geometry}\n";
1889 if (use_geometry || features.isProvided("geometry-light")) {
1890 os << "\\geometry{verbose";
1891 if (!g_options.empty())
1892 // Output general options here with "geometry light".
1893 os << "," << g_options;
1894 // output this only if use_geometry is true
1896 if (!topmargin.empty())
1897 os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1898 if (!bottommargin.empty())
1899 os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1900 if (!leftmargin.empty())
1901 os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1902 if (!rightmargin.empty())
1903 os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1904 if (!headheight.empty())
1905 os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1906 if (!headsep.empty())
1907 os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1908 if (!footskip.empty())
1909 os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1910 if (!columnsep.empty())
1911 os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
1915 } else if (orientation == ORIENTATION_LANDSCAPE
1916 || papersize != PAPER_DEFAULT) {
1917 features.require("papersize");
1920 if (tokenPos(tclass.opt_pagestyle(), '|', pagestyle) >= 0) {
1921 if (pagestyle == "fancy")
1922 os << "\\usepackage{fancyhdr}\n";
1923 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1926 // only output when the background color is not default
1927 if (isbackgroundcolor == true) {
1928 // only require color here, the background color will be defined
1929 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1931 features.require("color");
1932 features.require("pagecolor");
1935 // only output when the font color is not default
1936 if (isfontcolor == true) {
1937 // only require color here, the font color will be defined
1938 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1940 features.require("color");
1941 features.require("fontcolor");
1944 // Only if class has a ToC hierarchy
1945 if (tclass.hasTocLevels()) {
1946 if (secnumdepth != tclass.secnumdepth()) {
1947 os << "\\setcounter{secnumdepth}{"
1951 if (tocdepth != tclass.tocdepth()) {
1952 os << "\\setcounter{tocdepth}{"
1958 if (paragraph_separation) {
1959 // when skip separation
1960 switch (getDefSkip().kind()) {
1961 case VSpace::SMALLSKIP:
1962 os << "\\setlength{\\parskip}{\\smallskipamount}\n";
1964 case VSpace::MEDSKIP:
1965 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1967 case VSpace::BIGSKIP:
1968 os << "\\setlength{\\parskip}{\\bigskipamount}\n";
1970 case VSpace::LENGTH:
1971 os << "\\setlength{\\parskip}{"
1972 << from_utf8(getDefSkip().length().asLatexString())
1975 default: // should never happen // Then delete it.
1976 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1979 os << "\\setlength{\\parindent}{0pt}\n";
1981 // when separation by indentation
1982 // only output something when a width is given
1983 if (!getParIndent().empty()) {
1984 os << "\\setlength{\\parindent}{"
1985 << from_utf8(getParIndent().asLatexString())
1990 if (is_math_indent) {
1991 // when formula indentation
1992 // only output something when it is not the default
1993 if (!getMathIndent().empty()) {
1994 os << "\\setlength{\\mathindent}{"
1995 << from_utf8(getMathIndent().asString())
2000 // Now insert the LyX specific LaTeX commands...
2001 features.resolveAlternatives();
2002 features.expandMultiples();
2005 if (!output_sync_macro.empty())
2006 os << from_utf8(output_sync_macro) +"\n";
2007 else if (features.runparams().flavor == OutputParams::LATEX)
2008 os << "\\usepackage[active]{srcltx}\n";
2009 else if (features.runparams().flavor == OutputParams::PDFLATEX)
2010 os << "\\synctex=-1\n";
2013 // The package options (via \PassOptionsToPackage)
2014 os << from_ascii(features.getPackageOptions());
2016 // due to interferences with babel and hyperref, the color package has to
2017 // be loaded (when it is not already loaded) before babel when hyperref
2018 // is used with the colorlinks option, see
2019 // http://www.lyx.org/trac/ticket/5291
2020 // we decided therefore to load color always before babel, see
2021 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
2022 os << from_ascii(features.getColorOptions());
2024 // If we use hyperref, jurabib, japanese or varioref,
2025 // we have to call babel before
2027 && (features.isRequired("jurabib")
2028 || features.isRequired("hyperref")
2029 || features.isRequired("varioref")
2030 || features.isRequired("japanese"))) {
2031 os << features.getBabelPresettings();
2033 os << from_utf8(babelCall(language_options.str(),
2034 !lyxrc.language_global_options)) + '\n';
2035 os << features.getBabelPostsettings();
2038 // The optional packages;
2039 os << from_ascii(features.getPackages());
2041 // Additional Indices
2042 if (features.isRequired("splitidx")) {
2043 IndicesList::const_iterator iit = indiceslist().begin();
2044 IndicesList::const_iterator iend = indiceslist().end();
2045 for (; iit != iend; ++iit) {
2046 os << "\\newindex{";
2047 os << escape(iit->shortcut());
2053 os << from_utf8(spacing().writePreamble(features.isProvided("SetSpace")));
2056 // * Hyperref manual: "Make sure it comes last of your loaded
2057 // packages, to give it a fighting chance of not being over-written,
2058 // since its job is to redefine many LaTeX commands."
2059 // * Email from Heiko Oberdiek: "It is usually better to load babel
2060 // before hyperref. Then hyperref has a chance to detect babel.
2061 // * Has to be loaded before the "LyX specific LaTeX commands" to
2062 // avoid errors with algorithm floats.
2063 // use hyperref explicitly if it is required
2064 if (features.isRequired("hyperref")) {
2065 OutputParams tmp_params = features.runparams();
2066 pdfoptions().writeLaTeX(tmp_params, os,
2067 features.isProvided("hyperref"));
2068 // correctly break URLs with hyperref and dvi/ps output
2069 if (features.runparams().hyperref_driver == "dvips"
2070 && features.isAvailable("breakurl"))
2071 os << "\\usepackage{breakurl}\n";
2072 } else if (features.isRequired("nameref"))
2073 // hyperref loads this automatically
2074 os << "\\usepackage{nameref}\n";
2077 os << "\\usepackage";
2078 if (!lineno_opts.empty())
2079 os << "[" << lineno_opts << "]";
2081 os << "\\linenumbers\n";
2084 // bibtopic needs to be loaded after hyperref.
2085 // the dot provides the aux file naming which LyX can detect.
2086 if (features.mustProvide("bibtopic"))
2087 os << "\\usepackage[dot]{bibtopic}\n";
2089 // Will be surrounded by \makeatletter and \makeatother when not empty
2090 otexstringstream atlyxpreamble;
2092 // Some macros LyX will need
2094 TexString tmppreamble = features.getMacros();
2095 if (!tmppreamble.str.empty())
2096 atlyxpreamble << "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2097 "LyX specific LaTeX commands.\n"
2098 << move(tmppreamble)
2101 // the text class specific preamble
2103 docstring tmppreamble = features.getTClassPreamble();
2104 if (!tmppreamble.empty())
2105 atlyxpreamble << "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2106 "Textclass specific LaTeX commands.\n"
2110 // suppress date if selected
2111 // use \@ifundefined because we cannot be sure that every document class
2112 // has a \date command
2114 atlyxpreamble << "\\@ifundefined{date}{}{\\date{}}\n";
2116 /* the user-defined preamble */
2117 if (!containsOnly(preamble, " \n\t")) {
2119 atlyxpreamble << "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2120 "User specified LaTeX commands.\n";
2122 // Check if the user preamble contains uncodable glyphs
2123 odocstringstream user_preamble;
2124 docstring uncodable_glyphs;
2125 Encoding const * const enc = features.runparams().encoding;
2127 for (size_t n = 0; n < preamble.size(); ++n) {
2128 char_type c = preamble[n];
2129 if (!enc->encodable(c)) {
2130 docstring const glyph(1, c);
2131 LYXERR0("Uncodable character '"
2133 << "' in user preamble!");
2134 uncodable_glyphs += glyph;
2135 if (features.runparams().dryrun) {
2136 user_preamble << "<" << _("LyX Warning: ")
2137 << _("uncodable character") << " '";
2138 user_preamble.put(c);
2139 user_preamble << "'>";
2142 user_preamble.put(c);
2145 user_preamble << preamble;
2147 // On BUFFER_VIEW|UPDATE, warn user if we found uncodable glyphs
2148 if (!features.runparams().dryrun && !uncodable_glyphs.empty()) {
2149 frontend::Alert::warning(
2150 _("Uncodable character in user preamble"),
2152 _("The user preamble of your document contains glyphs "
2153 "that are unknown in the current document encoding "
2154 "(namely %1$s).\nThese glyphs are omitted "
2155 " from the output, which may result in "
2156 "incomplete output."
2157 "\n\nPlease select an appropriate "
2158 "document encoding\n"
2159 "(such as utf8) or change the "
2160 "preamble code accordingly."),
2163 atlyxpreamble << user_preamble.str() << '\n';
2166 // footmisc must be loaded after setspace
2167 // Load it here to avoid clashes with footmisc loaded in the user
2168 // preamble. For that reason we also pass the options via
2169 // \PassOptionsToPackage in getPreamble() and not here.
2170 if (features.mustProvide("footmisc"))
2171 atlyxpreamble << "\\usepackage{footmisc}\n";
2173 // subfig loads internally the LaTeX package "caption". As
2174 // caption is a very popular package, users will load it in
2175 // the preamble. Therefore we must load subfig behind the
2176 // user-defined preamble and check if the caption package was
2177 // loaded or not. For the case that caption is loaded before
2178 // subfig, there is the subfig option "caption=false". This
2179 // option also works when a koma-script class is used and
2180 // koma's own caption commands are used instead of caption. We
2181 // use \PassOptionsToPackage here because the user could have
2182 // already loaded subfig in the preamble.
2183 if (features.mustProvide("subfig"))
2184 atlyxpreamble << "\\@ifundefined{showcaptionsetup}{}{%\n"
2185 " \\PassOptionsToPackage{caption=false}{subfig}}\n"
2186 "\\usepackage{subfig}\n";
2188 // Itemize bullet settings need to be last in case the user
2189 // defines their own bullets that use a package included
2190 // in the user-defined preamble -- ARRae
2191 // Actually it has to be done much later than that
2192 // since some packages like frenchb make modifications
2193 // at \begin{document} time -- JMarc
2194 docstring bullets_def;
2195 for (int i = 0; i < 4; ++i) {
2196 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
2197 if (bullets_def.empty())
2198 bullets_def += "\\AtBeginDocument{\n";
2199 bullets_def += " \\def\\labelitemi";
2201 // `i' is one less than the item to modify
2208 bullets_def += "ii";
2214 bullets_def += '{' +
2215 user_defined_bullet(i).getText()
2220 if (!bullets_def.empty())
2221 atlyxpreamble << bullets_def << "}\n\n";
2223 if (!atlyxpreamble.empty())
2224 os << "\n\\makeatletter\n"
2225 << atlyxpreamble.release()
2226 << "\\makeatother\n\n";
2228 // We try to load babel late, in case it interferes with other packages.
2229 // Jurabib, hyperref, varioref, bicaption, menukeys and listings (bug 8995)
2230 // have to be called after babel, though.
2231 if (use_babel && !features.isRequired("jurabib")
2232 && !features.isRequired("hyperref")
2233 && !features.isRequired("varioref")
2234 && !features.isRequired("japanese")) {
2235 os << features.getBabelPresettings();
2237 os << from_utf8(babelCall(language_options.str(),
2238 !lyxrc.language_global_options)) + '\n';
2239 os << features.getBabelPostsettings();
2241 // In documents containing text in Thai language,
2242 // we must load inputenc after babel (see lib/languages).
2243 if (contains(features.getBabelPostsettings(), from_ascii("thai.ldf")))
2244 writeEncodingPreamble(os, features);
2246 // font selection must be done after babel with non-TeX fonts
2247 if (!fonts.empty() && features.useBabel() && useNonTeXFonts)
2248 os << from_utf8(fonts);
2250 if (features.isRequired("bicaption"))
2251 os << "\\usepackage{bicaption}\n";
2252 if (!listings_params.empty()
2253 || features.mustProvide("listings")
2254 || features.mustProvide("minted")) {
2256 os << "\\usepackage{minted}\n";
2258 os << "\\usepackage{listings}\n";
2260 string lst_params = listings_params;
2261 // If minted, do not output the language option (bug 11203)
2262 if (use_minted && contains(lst_params, "language=")) {
2263 vector<string> opts =
2264 getVectorFromString(lst_params, ",", false);
2265 for (size_t i = 0; i < opts.size(); ++i) {
2266 if (prefixIs(opts[i], "language="))
2267 opts.erase(opts.begin() + i--);
2269 lst_params = getStringFromVector(opts, ",");
2271 if (!lst_params.empty()) {
2273 os << "\\setminted{";
2276 // do not test validity because listings_params is
2277 // supposed to be valid
2279 InsetListingsParams(lst_params).separatedParams(true);
2280 os << from_utf8(par);
2284 // xunicode only needs to be loaded if tipa is used
2285 // (the rest is obsoleted by the new TU encoding).
2286 // It needs to be loaded at least after amsmath, amssymb,
2287 // esint and the other packages that provide special glyphs
2288 if (features.mustProvide("tipa") && useNonTeXFonts
2289 && !features.isProvided("xunicode")) {
2290 // The `xunicode` package officially only supports XeTeX,
2291 // but also works with LuaTeX. We work around its XeTeX test.
2292 if (features.runparams().flavor != OutputParams::XETEX) {
2293 os << "% Pretend to xunicode that we are XeTeX\n"
2294 << "\\def\\XeTeXpicfile{}\n";
2296 os << "\\usepackage{xunicode}\n";
2299 // covington must be loaded after beamerarticle
2300 if (features.isRequired("covington"))
2301 os << "\\usepackage{covington}\n";
2303 // Polyglossia must be loaded last ...
2304 if (use_polyglossia) {
2306 os << "\\usepackage{polyglossia}\n";
2307 // set the main language
2308 os << "\\setdefaultlanguage";
2309 if (!language->polyglossiaOpts().empty())
2310 os << "[" << from_ascii(language->polyglossiaOpts()) << "]";
2311 os << "{" << from_ascii(language->polyglossia()) << "}\n";
2312 // now setup the other languages
2313 set<string> const polylangs =
2314 features.getPolyglossiaLanguages();
2315 for (set<string>::const_iterator mit = polylangs.begin();
2316 mit != polylangs.end() ; ++mit) {
2317 // We do not output the options here; they are output in
2318 // the language switch commands. This is safer if multiple
2319 // varieties are used.
2320 if (*mit == language->polyglossia())
2322 os << "\\setotherlanguage";
2323 os << "{" << from_ascii(*mit) << "}\n";
2327 // ... but before biblatex (see #7065)
2328 if ((features.mustProvide("biblatex")
2329 || features.isRequired("biblatex-chicago"))
2330 && !features.isProvided("biblatex-chicago")
2331 && !features.isProvided("biblatex-natbib")
2332 && !features.isProvided("natbib-internal")
2333 && !features.isProvided("natbib")
2334 && !features.isProvided("jurabib")) {
2335 // The biblatex-chicago package has a differing interface
2336 // it uses a wrapper package and loads styles via fixed options
2337 bool const chicago = features.isRequired("biblatex-chicago");
2340 os << "\\usepackage";
2341 if (!biblatex_bibstyle.empty()
2342 && (biblatex_bibstyle == biblatex_citestyle)
2344 opts = "style=" + biblatex_bibstyle;
2346 } else if (!chicago) {
2347 if (!biblatex_bibstyle.empty()) {
2348 opts = "bibstyle=" + biblatex_bibstyle;
2351 if (!biblatex_citestyle.empty()) {
2352 opts += delim + "citestyle=" + biblatex_citestyle;
2356 if (!multibib.empty() && multibib != "child") {
2357 opts += delim + "refsection=" + multibib;
2360 if (bibtexCommand() == "bibtex8"
2361 || prefixIs(bibtexCommand(), "bibtex8 ")) {
2362 opts += delim + "backend=bibtex8";
2364 } else if (bibtexCommand() == "bibtex"
2365 || prefixIs(bibtexCommand(), "bibtex ")) {
2366 opts += delim + "backend=bibtex";
2369 if (!bib_encoding.empty() && encodings.fromLyXName(bib_encoding)) {
2370 opts += delim + "bibencoding="
2371 + encodings.fromLyXName(bib_encoding)->latexName();
2374 if (!biblio_opts.empty())
2375 opts += delim + biblio_opts;
2377 os << "[" << opts << "]";
2379 os << "{biblatex-chicago}\n";
2381 os << "{biblatex}\n";
2385 // Load custom language package here
2386 if (features.langPackage() == LaTeXFeatures::LANG_PACK_CUSTOM) {
2387 if (lang_package == "default")
2388 os << from_utf8(lyxrc.language_custom_package);
2390 os << from_utf8(lang_package);
2394 // Since menukeys uses catoptions, which does some heavy changes on key-value options,
2395 // it is recommended to load menukeys as the last package (even after hyperref)
2396 if (features.isRequired("menukeys"))
2397 os << "\\usepackage{menukeys}\n";
2399 docstring const i18npreamble =
2400 features.getTClassI18nPreamble(use_babel, use_polyglossia,
2402 if (!i18npreamble.empty())
2403 os << i18npreamble + '\n';
2409 void BufferParams::useClassDefaults()
2411 DocumentClass const & tclass = documentClass();
2413 sides = tclass.sides();
2414 columns = tclass.columns();
2415 pagestyle = tclass.pagestyle();
2416 tablestyle = tclass.tablestyle();
2417 use_default_options = true;
2418 // Only if class has a ToC hierarchy
2419 if (tclass.hasTocLevels()) {
2420 secnumdepth = tclass.secnumdepth();
2421 tocdepth = tclass.tocdepth();
2426 bool BufferParams::hasClassDefaults() const
2428 DocumentClass const & tclass = documentClass();
2430 return sides == tclass.sides()
2431 && columns == tclass.columns()
2432 && pagestyle == tclass.pagestyle()
2433 && tablestyle == tclass.tablestyle()
2434 && use_default_options
2435 && secnumdepth == tclass.secnumdepth()
2436 && tocdepth == tclass.tocdepth();
2440 DocumentClass const & BufferParams::documentClass() const
2446 DocumentClassConstPtr BufferParams::documentClassPtr() const
2452 void BufferParams::setDocumentClass(DocumentClassConstPtr tc)
2454 // evil, but this function is evil
2455 doc_class_ = const_pointer_cast<DocumentClass>(tc);
2456 invalidateConverterCache();
2460 bool BufferParams::setBaseClass(string const & classname, string const & path)
2462 LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
2463 LayoutFileList & bcl = LayoutFileList::get();
2464 if (!bcl.haveClass(classname)) {
2466 bformat(_("The layout file:\n"
2468 "could not be found. A default textclass with default\n"
2469 "layouts will be used. LyX will not be able to produce\n"
2471 from_utf8(classname));
2472 frontend::Alert::error(_("Document class not found"), s);
2473 bcl.addEmptyClass(classname);
2476 bool const success = bcl[classname].load(path);
2479 bformat(_("Due to some error in it, the layout file:\n"
2481 "could not be loaded. A default textclass with default\n"
2482 "layouts will be used. LyX will not be able to produce\n"
2484 from_utf8(classname));
2485 frontend::Alert::error(_("Could not load class"), s);
2486 bcl.addEmptyClass(classname);
2489 pimpl_->baseClass_ = classname;
2490 layout_modules_.adaptToBaseClass(baseClass(), removed_modules_);
2495 LayoutFile const * BufferParams::baseClass() const
2497 if (LayoutFileList::get().haveClass(pimpl_->baseClass_))
2498 return &(LayoutFileList::get()[pimpl_->baseClass_]);
2504 LayoutFileIndex const & BufferParams::baseClassID() const
2506 return pimpl_->baseClass_;
2510 void BufferParams::makeDocumentClass(bool const clone)
2515 invalidateConverterCache();
2516 LayoutModuleList mods;
2517 LayoutModuleList::iterator it = layout_modules_.begin();
2518 LayoutModuleList::iterator en = layout_modules_.end();
2519 for (; it != en; ++it)
2520 mods.push_back(*it);
2522 doc_class_ = getDocumentClass(*baseClass(), mods, cite_engine_, clone);
2524 TextClass::ReturnValues success = TextClass::OK;
2525 if (!forced_local_layout_.empty())
2526 success = doc_class_->read(to_utf8(forced_local_layout_),
2528 if (!local_layout_.empty() &&
2529 (success == TextClass::OK || success == TextClass::OK_OLDFORMAT))
2530 success = doc_class_->read(to_utf8(local_layout_), TextClass::MODULE);
2531 if (success != TextClass::OK && success != TextClass::OK_OLDFORMAT) {
2532 docstring const msg = _("Error reading internal layout information");
2533 frontend::Alert::warning(_("Read Error"), msg);
2538 bool BufferParams::layoutModuleCanBeAdded(string const & modName) const
2540 return layout_modules_.moduleCanBeAdded(modName, baseClass());
2544 docstring BufferParams::getLocalLayout(bool forced) const
2547 return from_utf8(doc_class_->forcedLayouts());
2549 return local_layout_;
2553 void BufferParams::setLocalLayout(docstring const & layout, bool forced)
2556 forced_local_layout_ = layout;
2558 local_layout_ = layout;
2562 bool BufferParams::addLayoutModule(string const & modName)
2564 LayoutModuleList::const_iterator it = layout_modules_.begin();
2565 LayoutModuleList::const_iterator end = layout_modules_.end();
2566 for (; it != end; ++it)
2569 layout_modules_.push_back(modName);
2574 string BufferParams::bufferFormat() const
2576 return documentClass().outputFormat();
2580 bool BufferParams::isExportable(string const & format, bool need_viewable) const
2582 FormatList const & formats = exportableFormats(need_viewable);
2583 FormatList::const_iterator fit = formats.begin();
2584 FormatList::const_iterator end = formats.end();
2585 for (; fit != end ; ++fit) {
2586 if ((*fit)->name() == format)
2593 FormatList const & BufferParams::exportableFormats(bool only_viewable) const
2595 FormatList & cached = only_viewable ?
2596 pimpl_->viewableFormatList : pimpl_->exportableFormatList;
2597 bool & valid = only_viewable ?
2598 pimpl_->isViewCacheValid : pimpl_->isExportCacheValid;
2602 vector<string> const backs = backends();
2603 set<string> excludes;
2604 if (useNonTeXFonts) {
2605 excludes.insert("latex");
2606 excludes.insert("pdflatex");
2607 } else if (inputenc != "ascii" && inputenc != "utf8-plain")
2608 // XeTeX with TeX fonts requires input encoding ascii (#10600).
2609 excludes.insert("xetex");
2610 FormatList result = theConverters().getReachable(backs[0], only_viewable,
2612 for (vector<string>::const_iterator it = backs.begin() + 1;
2613 it != backs.end(); ++it) {
2614 FormatList r = theConverters().getReachable(*it, only_viewable,
2616 result.insert(result.end(), r.begin(), r.end());
2618 sort(result.begin(), result.end(), Format::formatSorter);
2625 vector<string> BufferParams::backends() const
2628 string const buffmt = bufferFormat();
2630 // FIXME: Don't hardcode format names here, but use a flag
2631 if (buffmt == "latex") {
2632 if (encoding().package() == Encoding::japanese)
2633 v.push_back("platex");
2635 if (!useNonTeXFonts) {
2636 v.push_back("pdflatex");
2637 v.push_back("latex");
2640 || inputenc == "ascii" || inputenc == "utf8-plain")
2641 v.push_back("xetex");
2642 v.push_back("luatex");
2643 v.push_back("dviluatex");
2646 string rbuffmt = buffmt;
2647 // If we use an OutputFormat in Japanese docs,
2648 // we need special format in order to get the path
2649 // via pLaTeX (#8823)
2650 if (documentClass().hasOutputFormat()
2651 && encoding().package() == Encoding::japanese)
2653 v.push_back(rbuffmt);
2656 v.push_back("xhtml");
2657 v.push_back("text");
2663 OutputParams::FLAVOR BufferParams::getOutputFlavor(string const & format) const
2665 string const dformat = (format.empty() || format == "default") ?
2666 getDefaultOutputFormat() : format;
2667 DefaultFlavorCache::const_iterator it =
2668 default_flavors_.find(dformat);
2670 if (it != default_flavors_.end())
2673 OutputParams::FLAVOR result = OutputParams::LATEX;
2675 // FIXME It'd be better not to hardcode this, but to do
2676 // something with formats.
2677 if (dformat == "xhtml")
2678 result = OutputParams::HTML;
2679 else if (dformat == "text")
2680 result = OutputParams::TEXT;
2681 else if (dformat == "lyx")
2682 result = OutputParams::LYX;
2683 else if (dformat == "pdflatex")
2684 result = OutputParams::PDFLATEX;
2685 else if (dformat == "xetex")
2686 result = OutputParams::XETEX;
2687 else if (dformat == "luatex")
2688 result = OutputParams::LUATEX;
2689 else if (dformat == "dviluatex")
2690 result = OutputParams::DVILUATEX;
2692 // Try to determine flavor of default output format
2693 vector<string> backs = backends();
2694 if (find(backs.begin(), backs.end(), dformat) == backs.end()) {
2695 // Get shortest path to format
2696 Graph::EdgePath path;
2697 for (auto const & bvar : backs) {
2698 Graph::EdgePath p = theConverters().getPath(bvar, dformat);
2699 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2704 result = theConverters().getFlavor(path);
2707 // cache this flavor
2708 default_flavors_[dformat] = result;
2713 string BufferParams::getDefaultOutputFormat() const
2715 if (!default_output_format.empty()
2716 && default_output_format != "default")
2717 return default_output_format;
2719 FormatList const & formats = exportableFormats(true);
2720 if (formats.empty())
2722 // return the first we find
2723 return formats.front()->name();
2725 if (encoding().package() == Encoding::japanese)
2726 return lyxrc.default_platex_view_format;
2728 return lyxrc.default_otf_view_format;
2729 return lyxrc.default_view_format;
2732 Font const BufferParams::getFont() const
2734 FontInfo f = documentClass().defaultfont();
2735 if (fonts_default_family == "rmdefault")
2736 f.setFamily(ROMAN_FAMILY);
2737 else if (fonts_default_family == "sfdefault")
2738 f.setFamily(SANS_FAMILY);
2739 else if (fonts_default_family == "ttdefault")
2740 f.setFamily(TYPEWRITER_FAMILY);
2741 return Font(f, language);
2745 InsetQuotesParams::QuoteStyle BufferParams::getQuoteStyle(string const & qs) const
2747 return quotesstyletranslator().find(qs);
2751 bool BufferParams::isLatex() const
2753 return documentClass().outputType() == LATEX;
2757 bool BufferParams::isLiterate() const
2759 return documentClass().outputType() == LITERATE;
2763 bool BufferParams::isDocBook() const
2765 return documentClass().outputType() == DOCBOOK;
2769 void BufferParams::readPreamble(Lexer & lex)
2771 if (lex.getString() != "\\begin_preamble")
2772 lyxerr << "Error (BufferParams::readPreamble):"
2773 "consistency check failed." << endl;
2775 preamble = lex.getLongString(from_ascii("\\end_preamble"));
2779 void BufferParams::readLocalLayout(Lexer & lex, bool forced)
2781 string const expected = forced ? "\\begin_forced_local_layout" :
2782 "\\begin_local_layout";
2783 if (lex.getString() != expected)
2784 lyxerr << "Error (BufferParams::readLocalLayout):"
2785 "consistency check failed." << endl;
2788 forced_local_layout_ =
2789 lex.getLongString(from_ascii("\\end_forced_local_layout"));
2791 local_layout_ = lex.getLongString(from_ascii("\\end_local_layout"));
2795 bool BufferParams::setLanguage(string const & lang)
2797 Language const *new_language = languages.getLanguage(lang);
2798 if (!new_language) {
2799 // Language lang was not found
2802 language = new_language;
2807 void BufferParams::readLanguage(Lexer & lex)
2809 if (!lex.next()) return;
2811 string const tmptok = lex.getString();
2813 // check if tmptok is part of tex_babel in tex-defs.h
2814 if (!setLanguage(tmptok)) {
2815 // Language tmptok was not found
2816 language = default_language;
2817 lyxerr << "Warning: Setting language `"
2818 << tmptok << "' to `" << language->lang()
2824 void BufferParams::readGraphicsDriver(Lexer & lex)
2829 string const tmptok = lex.getString();
2830 // check if tmptok is part of tex_graphics in tex_defs.h
2833 string const test = tex_graphics[n++];
2835 if (test == tmptok) {
2836 graphics_driver = tmptok;
2841 "Warning: graphics driver `$$Token' not recognized!\n"
2842 " Setting graphics driver to `default'.\n");
2843 graphics_driver = "default";
2850 void BufferParams::readBullets(Lexer & lex)
2855 int const index = lex.getInteger();
2857 int temp_int = lex.getInteger();
2858 user_defined_bullet(index).setFont(temp_int);
2859 temp_bullet(index).setFont(temp_int);
2861 user_defined_bullet(index).setCharacter(temp_int);
2862 temp_bullet(index).setCharacter(temp_int);
2864 user_defined_bullet(index).setSize(temp_int);
2865 temp_bullet(index).setSize(temp_int);
2869 void BufferParams::readBulletsLaTeX(Lexer & lex)
2871 // The bullet class should be able to read this.
2874 int const index = lex.getInteger();
2876 docstring const temp_str = lex.getDocString();
2878 user_defined_bullet(index).setText(temp_str);
2879 temp_bullet(index).setText(temp_str);
2883 void BufferParams::readModules(Lexer & lex)
2885 if (!lex.eatLine()) {
2886 lyxerr << "Error (BufferParams::readModules):"
2887 "Unexpected end of input." << endl;
2891 string mod = lex.getString();
2892 if (mod == "\\end_modules")
2894 addLayoutModule(mod);
2900 void BufferParams::readRemovedModules(Lexer & lex)
2902 if (!lex.eatLine()) {
2903 lyxerr << "Error (BufferParams::readRemovedModules):"
2904 "Unexpected end of input." << endl;
2908 string mod = lex.getString();
2909 if (mod == "\\end_removed_modules")
2911 removed_modules_.push_back(mod);
2914 // now we want to remove any removed modules that were previously
2915 // added. normally, that will be because default modules were added in
2916 // setBaseClass(), which gets called when \textclass is read at the
2917 // start of the read.
2918 list<string>::const_iterator rit = removed_modules_.begin();
2919 list<string>::const_iterator const ren = removed_modules_.end();
2920 for (; rit != ren; ++rit) {
2921 LayoutModuleList::iterator const mit = layout_modules_.begin();
2922 LayoutModuleList::iterator const men = layout_modules_.end();
2923 LayoutModuleList::iterator found = find(mit, men, *rit);
2926 layout_modules_.erase(found);
2931 void BufferParams::readIncludeonly(Lexer & lex)
2933 if (!lex.eatLine()) {
2934 lyxerr << "Error (BufferParams::readIncludeonly):"
2935 "Unexpected end of input." << endl;
2939 string child = lex.getString();
2940 if (child == "\\end_includeonly")
2942 included_children_.push_back(child);
2948 string BufferParams::paperSizeName(PapersizePurpose purpose, string const & psize) const
2950 PAPER_SIZE ppsize = psize.empty() ? papersize : papersizetranslator().find(psize);
2953 if (documentClass().pagesize() == "default")
2954 // could be anything, so don't guess
2956 return paperSizeName(purpose, documentClass().pagesize());
2957 case PAPER_CUSTOM: {
2958 if (purpose == XDVI && !paperwidth.empty() &&
2959 !paperheight.empty()) {
2960 // heightxwidth<unit>
2961 string first = paperwidth;
2962 string second = paperheight;
2963 if (orientation == ORIENTATION_LANDSCAPE)
2966 return first.erase(first.length() - 2)
2972 // dvips and dvipdfm do not know this
2973 if (purpose == DVIPS || purpose == DVIPDFM)
2977 if (purpose == DVIPS || purpose == DVIPDFM)
2981 if (purpose == DVIPS || purpose == DVIPDFM)
2991 if (purpose == DVIPS || purpose == DVIPDFM)
2995 if (purpose == DVIPS || purpose == DVIPDFM)
2999 if (purpose == DVIPS || purpose == DVIPDFM)
3003 if (purpose == DVIPS || purpose == DVIPDFM)
3007 if (purpose == DVIPS || purpose == DVIPDFM)
3011 // dvipdfm does not know this
3012 if (purpose == DVIPDFM)
3016 if (purpose == DVIPDFM)
3020 if (purpose == DVIPS || purpose == DVIPDFM)
3024 if (purpose == DVIPS || purpose == DVIPDFM)
3028 if (purpose == DVIPS || purpose == DVIPDFM)
3032 if (purpose == DVIPS || purpose == DVIPDFM)
3036 if (purpose == DVIPS || purpose == DVIPDFM)
3040 if (purpose == DVIPS || purpose == DVIPDFM)
3044 if (purpose == DVIPS || purpose == DVIPDFM)
3048 if (purpose == DVIPS || purpose == DVIPDFM)
3052 if (purpose == DVIPS || purpose == DVIPDFM)
3056 if (purpose == DVIPS || purpose == DVIPDFM)
3060 if (purpose == DVIPS || purpose == DVIPDFM)
3064 if (purpose == DVIPS || purpose == DVIPDFM)
3068 if (purpose == DVIPS || purpose == DVIPDFM)
3072 if (purpose == DVIPS || purpose == DVIPDFM)
3076 if (purpose == DVIPS || purpose == DVIPDFM)
3079 case PAPER_USEXECUTIVE:
3080 // dvipdfm does not know this
3081 if (purpose == DVIPDFM)
3086 case PAPER_USLETTER:
3088 if (purpose == XDVI)
3095 string const BufferParams::dvips_options() const
3099 // If the class loads the geometry package, we do not know which
3100 // paper size is used, since we do not set it (bug 7013).
3101 // Therefore we must not specify any argument here.
3102 // dvips gets the correct paper size via DVI specials in this case
3103 // (if the class uses the geometry package correctly).
3104 if (documentClass().provides("geometry"))
3108 && papersize == PAPER_CUSTOM
3109 && !lyxrc.print_paper_dimension_flag.empty()
3110 && !paperwidth.empty()
3111 && !paperheight.empty()) {
3112 // using a custom papersize
3113 result = lyxrc.print_paper_dimension_flag;
3114 result += ' ' + paperwidth;
3115 result += ',' + paperheight;
3117 string const paper_option = paperSizeName(DVIPS);
3118 if (!paper_option.empty() && (paper_option != "letter" ||
3119 orientation != ORIENTATION_LANDSCAPE)) {
3120 // dvips won't accept -t letter -t landscape.
3121 // In all other cases, include the paper size
3123 result = lyxrc.print_paper_flag;
3124 result += ' ' + paper_option;
3127 if (orientation == ORIENTATION_LANDSCAPE &&
3128 papersize != PAPER_CUSTOM)
3129 result += ' ' + lyxrc.print_landscape_flag;
3134 string const BufferParams::main_font_encoding() const
3136 if (font_encodings().empty()) {
3137 if (ascii_lowercase(language->fontenc(*this)) == "none")
3141 return font_encodings().back();
3145 vector<string> const BufferParams::font_encodings() const
3147 string doc_fontenc = (fontenc == "auto") ? string() : fontenc;
3149 vector<string> fontencs;
3151 // "default" means "no explicit font encoding"
3152 if (doc_fontenc != "default") {
3153 if (!doc_fontenc.empty())
3154 // If we have a custom setting, we use only that!
3155 return getVectorFromString(doc_fontenc);
3156 if (!language->fontenc(*this).empty()
3157 && ascii_lowercase(language->fontenc(*this)) != "none") {
3158 vector<string> fencs = getVectorFromString(language->fontenc(*this));
3159 for (auto & fe : fencs) {
3160 if (find(fontencs.begin(), fontencs.end(), fe) == fontencs.end())
3161 fontencs.push_back(fe);
3170 string BufferParams::babelCall(string const & lang_opts, bool const langoptions) const
3172 // suppress the babel call if there is no BabelName defined
3173 // for the document language in the lib/languages file and if no
3174 // other languages are used (lang_opts is then empty)
3175 if (lang_opts.empty())
3177 // The prefs may require the languages to
3178 // be submitted to babel itself (not the class).
3180 return "\\usepackage[" + lang_opts + "]{babel}";
3181 return "\\usepackage{babel}";
3185 docstring BufferParams::getGraphicsDriver(string const & package) const
3189 if (package == "geometry") {
3190 if (graphics_driver == "dvips"
3191 || graphics_driver == "dvipdfm"
3192 || graphics_driver == "pdftex"
3193 || graphics_driver == "vtex")
3194 result = from_ascii(graphics_driver);
3195 else if (graphics_driver == "dvipdfmx")
3196 result = from_ascii("dvipdfm");
3203 void BufferParams::writeEncodingPreamble(otexstream & os,
3204 LaTeXFeatures & features) const
3206 // With no-TeX fonts we use utf8-plain without encoding package.
3210 if (inputenc == "auto-legacy") {
3211 string const doc_encoding =
3212 language->encoding()->latexName();
3213 Encoding::Package const package =
3214 language->encoding()->package();
3216 // Create list of inputenc options:
3217 set<string> encoding_set;
3218 // luainputenc fails with more than one encoding
3219 if (features.runparams().flavor != OutputParams::LUATEX
3220 && features.runparams().flavor != OutputParams::DVILUATEX)
3221 // list all input encodings used in the document
3222 encoding_set = features.getEncodingSet(doc_encoding);
3224 // The "japanese" babel-language requires the pLaTeX engine
3225 // which conflicts with "inputenc".
3226 // See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
3227 if ((!encoding_set.empty() || package == Encoding::inputenc)
3228 && !features.isRequired("japanese")
3229 && !features.isProvided("inputenc")) {
3230 os << "\\usepackage[";
3231 set<string>::const_iterator it = encoding_set.begin();
3232 set<string>::const_iterator const end = encoding_set.end();
3234 os << from_ascii(*it);
3237 for (; it != end; ++it)
3238 os << ',' << from_ascii(*it);
3239 if (package == Encoding::inputenc) {
3240 if (!encoding_set.empty())
3242 os << from_ascii(doc_encoding);
3244 if (features.runparams().flavor == OutputParams::LUATEX
3245 || features.runparams().flavor == OutputParams::DVILUATEX)
3246 os << "]{luainputenc}\n";
3248 os << "]{inputenc}\n";
3250 } else if (inputenc != "auto-legacy-plain") {
3251 switch (encoding().package()) {
3252 case Encoding::none:
3254 case Encoding::japanese:
3255 if (encoding().iconvName() != "UTF-8"
3256 && !features.runparams().isFullUnicode())
3257 // don't default to [utf8]{inputenc} with TeXLive >= 18
3258 os << "\\ifdefined\\UseRawInputEncoding\n"
3259 << " \\UseRawInputEncoding\\fi\n";
3261 case Encoding::inputenc:
3262 // do not load inputenc if japanese is used
3263 // or if the class provides inputenc
3264 if (features.isRequired("japanese")
3265 || features.isProvided("inputenc"))
3267 os << "\\usepackage[" << from_ascii(encoding().latexName());
3268 if (features.runparams().flavor == OutputParams::LUATEX
3269 || features.runparams().flavor == OutputParams::DVILUATEX)
3270 os << "]{luainputenc}\n";
3272 os << "]{inputenc}\n";
3276 if (inputenc == "auto-legacy-plain" || features.isRequired("japanese")) {
3277 // don't default to [utf8]{inputenc} with TeXLive >= 18
3278 os << "\\ifdefined\\UseRawInputEncoding\n";
3279 os << " \\UseRawInputEncoding\\fi\n";
3284 string const BufferParams::parseFontName(string const & name) const
3286 string mangled = name;
3287 size_t const idx = mangled.find('[');
3288 if (idx == string::npos || idx == 0)
3291 return mangled.substr(0, idx - 1);
3295 string const BufferParams::loadFonts(LaTeXFeatures & features) const
3297 if (fontsRoman() == "default" && fontsSans() == "default"
3298 && fontsTypewriter() == "default"
3299 && (fontsMath() == "default" || fontsMath() == "auto"))
3305 /* Fontspec (XeTeX, LuaTeX): we provide GUI support for oldstyle
3306 * numbers (Numbers=OldStyle) and sf/tt scaling. The Ligatures=TeX/
3307 * Mapping=tex-text option assures TeX ligatures (such as "--")
3308 * are resolved. Note that tt does not use these ligatures.
3310 * -- add more GUI options?
3311 * -- add more fonts (fonts for other scripts)
3312 * -- if there's a way to find out if a font really supports
3313 * OldStyle, enable/disable the widget accordingly.
3315 if (useNonTeXFonts && features.isAvailable("fontspec")) {
3316 // "Mapping=tex-text" and "Ligatures=TeX" are equivalent.
3317 // However, until v.2 (2010/07/11) fontspec only knew
3318 // Mapping=tex-text (for XeTeX only); then "Ligatures=TeX"
3319 // was introduced for both XeTeX and LuaTeX (LuaTeX
3320 // didn't understand "Mapping=tex-text", while XeTeX
3321 // understood both. With most recent versions, both
3322 // variants are understood by both engines. However,
3323 // we want to provide support for at least TeXLive 2009
3324 // (for XeTeX; LuaTeX is only supported as of v.2)
3325 // As of 2017/11/03, Babel has its own higher-level
3326 // interface on top of fontspec that is to be used.
3327 bool const babelfonts = features.useBabel()
3328 && features.isAvailable("babel-2017/11/03");
3329 string const texmapping =
3330 (features.runparams().flavor == OutputParams::XETEX) ?
3331 "Mapping=tex-text" : "Ligatures=TeX";
3332 if (fontsRoman() != "default") {
3334 os << "\\babelfont{rm}[";
3336 os << "\\setmainfont[";
3337 if (!font_roman_opts.empty())
3338 os << font_roman_opts << ',';
3340 if (fonts_roman_osf)
3341 os << ",Numbers=OldStyle";
3342 os << "]{" << parseFontName(fontsRoman()) << "}\n";
3344 if (fontsSans() != "default") {
3345 string const sans = parseFontName(fontsSans());
3346 if (fontsSansScale() != 100) {
3348 os << "\\babelfont{sf}";
3350 os << "\\setsansfont";
3352 << float(fontsSansScale()) / 100 << ',';
3354 os << "Numbers=OldStyle,";
3355 if (!font_sans_opts.empty())
3356 os << font_sans_opts << ',';
3357 os << texmapping << "]{"
3361 os << "\\babelfont{sf}[";
3363 os << "\\setsansfont[";
3365 os << "Numbers=OldStyle,";
3366 if (!font_sans_opts.empty())
3367 os << font_sans_opts << ',';
3368 os << texmapping << "]{"
3372 if (fontsTypewriter() != "default") {
3373 string const mono = parseFontName(fontsTypewriter());
3374 if (fontsTypewriterScale() != 100) {
3376 os << "\\babelfont{tt}";
3378 os << "\\setmonofont";
3380 << float(fontsTypewriterScale()) / 100;
3381 if (fonts_typewriter_osf)
3382 os << ",Numbers=OldStyle";
3383 if (!font_typewriter_opts.empty())
3384 os << ',' << font_typewriter_opts;
3389 os << "\\babelfont{tt}";
3391 os << "\\setmonofont";
3392 if (!font_typewriter_opts.empty() || fonts_typewriter_osf) {
3394 if (fonts_typewriter_osf)
3395 os << "Numbers=OldStyle";
3396 if (!font_typewriter_opts.empty()) {
3397 if (fonts_typewriter_osf)
3399 os << font_typewriter_opts;
3403 os << '{' << mono << "}\n";
3410 bool const ot1 = (main_font_encoding() == "default" || main_font_encoding() == "OT1");
3411 bool const dryrun = features.runparams().dryrun;
3412 bool const complete = (fontsSans() == "default" && fontsTypewriter() == "default");
3413 bool const nomath = (fontsMath() == "default");
3416 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsRoman())).getLaTeXCode(
3417 dryrun, ot1, complete, fonts_expert_sc, fonts_roman_osf,
3418 nomath, font_roman_opts);
3421 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsSans())).getLaTeXCode(
3422 dryrun, ot1, complete, fonts_expert_sc, fonts_sans_osf,
3423 nomath, font_sans_opts, fontsSansScale());
3425 // MONOSPACED/TYPEWRITER
3426 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsTypewriter())).getLaTeXCode(
3427 dryrun, ot1, complete, fonts_expert_sc, fonts_typewriter_osf,
3428 nomath, font_typewriter_opts, fontsTypewriterScale());
3431 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsMath())).getLaTeXCode(
3432 dryrun, ot1, complete, fonts_expert_sc, fonts_roman_osf,
3439 Encoding const & BufferParams::encoding() const
3441 // Main encoding for LaTeX output.
3443 return *(encodings.fromLyXName("utf8-plain"));
3444 if (inputenc == "auto-legacy" || inputenc == "auto-legacy-plain")
3445 return *language->encoding();
3446 if (inputenc == "utf8" && language->lang() == "japanese")
3447 return *(encodings.fromLyXName("utf8-platex"));
3448 Encoding const * const enc = encodings.fromLyXName(inputenc);
3451 LYXERR0("Unknown inputenc value `" << inputenc
3452 << "'. Using `auto' instead.");
3453 return *language->encoding();
3457 string const & BufferParams::defaultBiblioStyle() const
3459 if (!biblio_style.empty())
3460 return biblio_style;
3462 map<string, string> const & bs = documentClass().defaultBiblioStyle();
3463 auto cit = bs.find(theCiteEnginesList.getTypeAsString(citeEngineType()));
3464 if (cit != bs.end())
3467 return empty_string();
3471 bool const & BufferParams::fullAuthorList() const
3473 return documentClass().fullAuthorList();
3477 string BufferParams::getCiteAlias(string const & s) const
3479 vector<string> commands =
3480 documentClass().citeCommands(citeEngineType());
3481 // If it is a real command, don't treat it as an alias
3482 if (find(commands.begin(), commands.end(), s) != commands.end())
3484 map<string,string> aliases = documentClass().citeCommandAliases();
3485 if (aliases.find(s) != aliases.end())
3491 vector<string> BufferParams::citeCommands() const
3493 static CitationStyle const default_style;
3494 vector<string> commands =
3495 documentClass().citeCommands(citeEngineType());
3496 if (commands.empty())
3497 commands.push_back(default_style.name);
3502 vector<CitationStyle> BufferParams::citeStyles() const
3504 static CitationStyle const default_style;
3505 vector<CitationStyle> styles =
3506 documentClass().citeStyles(citeEngineType());
3508 styles.push_back(default_style);
3513 string const BufferParams::bibtexCommand() const
3515 // Return document-specific setting if available
3516 if (bibtex_command != "default")
3517 return bibtex_command;
3519 // If we have "default" in document settings, consult the prefs
3520 // 1. Japanese (uses a specific processor)
3521 if (encoding().package() == Encoding::japanese) {
3522 if (lyxrc.jbibtex_command != "automatic")
3523 // Return the specified program, if "automatic" is not set
3524 return lyxrc.jbibtex_command;
3525 else if (!useBiblatex()) {
3526 // With classic BibTeX, return pbibtex, jbibtex, bibtex
3527 if (lyxrc.jbibtex_alternatives.find("pbibtex") != lyxrc.jbibtex_alternatives.end())
3529 if (lyxrc.jbibtex_alternatives.find("jbibtex") != lyxrc.jbibtex_alternatives.end())
3534 // 2. All other languages
3535 else if (lyxrc.bibtex_command != "automatic")
3536 // Return the specified program, if "automatic" is not set
3537 return lyxrc.bibtex_command;
3539 // 3. Automatic: find the most suitable for the current cite framework
3540 if (useBiblatex()) {
3541 // For Biblatex, we prefer biber (also for Japanese)
3542 // and fall back to bibtex8 and, as last resort, bibtex
3543 if (lyxrc.bibtex_alternatives.find("biber") != lyxrc.bibtex_alternatives.end())
3545 else if (lyxrc.bibtex_alternatives.find("bibtex8") != lyxrc.bibtex_alternatives.end())
3552 bool BufferParams::useBiblatex() const
3554 return theCiteEnginesList[citeEngine()]->getCiteFramework() == "biblatex";
3558 void BufferParams::invalidateConverterCache() const
3560 pimpl_->isExportCacheValid = false;
3561 pimpl_->isViewCacheValid = false;
3565 // We shouldn't need to reset the params here, since anything
3566 // we need will be recopied.
3567 void BufferParams::copyForAdvFR(const BufferParams & bp)
3569 string const & lang = bp.language->lang();
3571 layout_modules_ = bp.layout_modules_;
3572 string const & doc_class = bp.documentClass().name();
3573 setBaseClass(doc_class);
3577 void BufferParams::setBibFileEncoding(string const & file, string const & enc)
3579 bib_encodings[file] = enc;
3583 string const BufferParams::bibFileEncoding(string const & file) const
3585 if (bib_encodings.find(file) == bib_encodings.end())
3587 return bib_encodings.find(file)->second;