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", "letterpaper", "legalpaper", "executivepaper",
83 "a0paper", "a1paper", "a2paper", "a3paper", "a4paper", "a5paper",
84 "a6paper", "b0paper", "b1paper", "b2paper","b3paper", "b4paper",
85 "b5paper", "b6paper", "c0paper", "c1paper", "c2paper", "c3paper",
86 "c4paper", "c5paper", "c6paper", "b0j", "b1j", "b2j", "b3j", "b4j", "b5j",
91 static char const * const string_orientation[] = {
92 "portrait", "landscape", ""
96 static char const * const tex_graphics[] = {
97 "default", "dvialw", "dvilaser", "dvipdf", "dvipdfm", "dvipdfmx",
98 "dvips", "dvipsone", "dvitops", "dviwin", "dviwindo", "dvi2ps", "emtex",
99 "ln", "oztex", "pctexhp", "pctexps", "pctexwin", "pctex32", "pdftex",
100 "psprint", "pubps", "tcidvi", "textures", "truetex", "vtex", "xdvi",
107 // XeTeX with TeX fonts:
108 // run in 8-bit emulation mode and trick `inputenc` into working with XeTeX
109 static docstring const xetex_pre_inputenc = from_ascii(
110 "\\XeTeXinputencoding \"bytes\" % current file\n"
111 "\\XeTeXdefaultencoding \"bytes\" % included files\n"
113 "\\let\\origUmathchar\\Umathchar\n"
114 "\\let\\Umathchar\\@undefined\n");
115 static docstring const xetex_post_inputenc = from_ascii(
116 "\\let\\Umathchar\\origUmathchar\n"
122 // Paragraph separation
123 typedef Translator<string, BufferParams::ParagraphSeparation> ParSepTranslator;
126 ParSepTranslator const init_parseptranslator()
128 ParSepTranslator translator
129 (string_paragraph_separation[0], BufferParams::ParagraphIndentSeparation);
130 translator.addPair(string_paragraph_separation[1], BufferParams::ParagraphSkipSeparation);
135 ParSepTranslator const & parseptranslator()
137 static ParSepTranslator const translator =
138 init_parseptranslator();
144 typedef Translator<string, InsetQuotesParams::QuoteStyle> QuotesStyleTranslator;
147 QuotesStyleTranslator const init_quotesstyletranslator()
149 QuotesStyleTranslator translator
150 (string_quotes_style[0], InsetQuotesParams::EnglishQuotes);
151 translator.addPair(string_quotes_style[1], InsetQuotesParams::SwedishQuotes);
152 translator.addPair(string_quotes_style[2], InsetQuotesParams::GermanQuotes);
153 translator.addPair(string_quotes_style[3], InsetQuotesParams::PolishQuotes);
154 translator.addPair(string_quotes_style[4], InsetQuotesParams::SwissQuotes);
155 translator.addPair(string_quotes_style[5], InsetQuotesParams::DanishQuotes);
156 translator.addPair(string_quotes_style[6], InsetQuotesParams::PlainQuotes);
157 translator.addPair(string_quotes_style[7], InsetQuotesParams::BritishQuotes);
158 translator.addPair(string_quotes_style[8], InsetQuotesParams::SwedishGQuotes);
159 translator.addPair(string_quotes_style[9], InsetQuotesParams::FrenchQuotes);
160 translator.addPair(string_quotes_style[10], InsetQuotesParams::FrenchINQuotes);
161 translator.addPair(string_quotes_style[11], InsetQuotesParams::RussianQuotes);
162 translator.addPair(string_quotes_style[12], InsetQuotesParams::CJKQuotes);
163 translator.addPair(string_quotes_style[13], InsetQuotesParams::CJKAngleQuotes);
168 QuotesStyleTranslator const & quotesstyletranslator()
170 static QuotesStyleTranslator const translator =
171 init_quotesstyletranslator();
177 typedef Translator<string, PAPER_SIZE> PaperSizeTranslator;
180 static PaperSizeTranslator initPaperSizeTranslator()
182 PaperSizeTranslator translator(string_papersize[0], PAPER_DEFAULT);
183 translator.addPair(string_papersize[1], PAPER_CUSTOM);
184 translator.addPair(string_papersize[2], PAPER_USLETTER);
185 translator.addPair(string_papersize[3], PAPER_USLEGAL);
186 translator.addPair(string_papersize[4], PAPER_USEXECUTIVE);
187 translator.addPair(string_papersize[5], PAPER_A0);
188 translator.addPair(string_papersize[6], PAPER_A1);
189 translator.addPair(string_papersize[7], PAPER_A2);
190 translator.addPair(string_papersize[8], PAPER_A3);
191 translator.addPair(string_papersize[9], PAPER_A4);
192 translator.addPair(string_papersize[10], PAPER_A5);
193 translator.addPair(string_papersize[11], PAPER_A6);
194 translator.addPair(string_papersize[12], PAPER_B0);
195 translator.addPair(string_papersize[13], PAPER_B1);
196 translator.addPair(string_papersize[14], PAPER_B2);
197 translator.addPair(string_papersize[15], PAPER_B3);
198 translator.addPair(string_papersize[16], PAPER_B4);
199 translator.addPair(string_papersize[17], PAPER_B5);
200 translator.addPair(string_papersize[18], PAPER_B6);
201 translator.addPair(string_papersize[19], PAPER_C0);
202 translator.addPair(string_papersize[20], PAPER_C1);
203 translator.addPair(string_papersize[21], PAPER_C2);
204 translator.addPair(string_papersize[22], PAPER_C3);
205 translator.addPair(string_papersize[23], PAPER_C4);
206 translator.addPair(string_papersize[24], PAPER_C5);
207 translator.addPair(string_papersize[25], PAPER_C6);
208 translator.addPair(string_papersize[26], PAPER_JISB0);
209 translator.addPair(string_papersize[27], PAPER_JISB1);
210 translator.addPair(string_papersize[28], PAPER_JISB2);
211 translator.addPair(string_papersize[29], PAPER_JISB3);
212 translator.addPair(string_papersize[30], PAPER_JISB4);
213 translator.addPair(string_papersize[31], PAPER_JISB5);
214 translator.addPair(string_papersize[32], PAPER_JISB6);
219 PaperSizeTranslator const & papersizetranslator()
221 static PaperSizeTranslator const translator =
222 initPaperSizeTranslator();
228 typedef Translator<string, PAPER_ORIENTATION> PaperOrientationTranslator;
231 PaperOrientationTranslator const init_paperorientationtranslator()
233 PaperOrientationTranslator translator(string_orientation[0], ORIENTATION_PORTRAIT);
234 translator.addPair(string_orientation[1], ORIENTATION_LANDSCAPE);
239 PaperOrientationTranslator const & paperorientationtranslator()
241 static PaperOrientationTranslator const translator =
242 init_paperorientationtranslator();
248 typedef Translator<int, PageSides> SidesTranslator;
251 SidesTranslator const init_sidestranslator()
253 SidesTranslator translator(1, OneSide);
254 translator.addPair(2, TwoSides);
259 SidesTranslator const & sidestranslator()
261 static SidesTranslator const translator = init_sidestranslator();
267 typedef Translator<int, BufferParams::Package> PackageTranslator;
270 PackageTranslator const init_packagetranslator()
272 PackageTranslator translator(0, BufferParams::package_off);
273 translator.addPair(1, BufferParams::package_auto);
274 translator.addPair(2, BufferParams::package_on);
279 PackageTranslator const & packagetranslator()
281 static PackageTranslator const translator =
282 init_packagetranslator();
288 typedef Translator<string, Spacing::Space> SpaceTranslator;
291 SpaceTranslator const init_spacetranslator()
293 SpaceTranslator translator("default", Spacing::Default);
294 translator.addPair("single", Spacing::Single);
295 translator.addPair("onehalf", Spacing::Onehalf);
296 translator.addPair("double", Spacing::Double);
297 translator.addPair("other", Spacing::Other);
302 SpaceTranslator const & spacetranslator()
304 static SpaceTranslator const translator = init_spacetranslator();
309 bool inSystemDir(FileName const & document_dir, string & system_dir)
311 // A document is assumed to be in a system LyX directory (not
312 // necessarily the system directory of the running instance)
313 // if both "configure.py" and "chkconfig.ltx" are found in
314 // either document_dir/../ or document_dir/../../.
315 // If true, the system directory path is returned in system_dir
316 // with a trailing path separator.
318 string const msg = "Checking whether document is in a system dir...";
320 string dir = document_dir.absFileName();
322 for (int i = 0; i < 3; ++i) {
323 dir = addPath(dir, "..");
324 if (!fileSearch(dir, "configure.py").empty() &&
325 !fileSearch(dir, "chkconfig.ltx").empty()) {
326 LYXERR(Debug::FILES, msg << " yes");
327 system_dir = addPath(FileName(dir).realPath(), "");
332 LYXERR(Debug::FILES, msg << " no");
333 system_dir = string();
340 class BufferParams::Impl
345 AuthorList authorlist;
346 BranchList branchlist;
347 Bullet temp_bullets[4];
348 Bullet user_defined_bullets[4];
349 IndicesList indiceslist;
353 /** This is the amount of space used for paragraph_separation "skip",
354 * and for detached paragraphs in "indented" documents.
357 PDFOptions pdfoptions;
358 LayoutFileIndex baseClass_;
359 FormatList exportableFormatList;
360 FormatList viewableFormatList;
361 bool isViewCacheValid;
362 bool isExportCacheValid;
366 BufferParams::Impl::Impl()
367 : defskip(VSpace::MEDSKIP), baseClass_(string("")),
368 isViewCacheValid(false), isExportCacheValid(false)
370 // set initial author
372 authorlist.record(Author(from_utf8(lyxrc.user_name), from_utf8(lyxrc.user_email)));
377 BufferParams::MemoryTraits::clone(BufferParams::Impl const * ptr)
380 return new BufferParams::Impl(*ptr);
384 void BufferParams::MemoryTraits::destroy(BufferParams::Impl * ptr)
390 BufferParams::BufferParams()
393 setBaseClass(defaultBaseclass());
394 cite_engine_ = "basic";
395 cite_engine_type_ = ENGINE_TYPE_DEFAULT;
397 paragraph_separation = ParagraphIndentSeparation;
398 is_math_indent = false;
399 math_numbering_side = DEFAULT;
400 quotes_style = InsetQuotesParams::EnglishQuotes;
401 dynamic_quotes = false;
402 fontsize = "default";
405 papersize = PAPER_DEFAULT;
406 orientation = ORIENTATION_PORTRAIT;
407 use_geometry = false;
408 biblio_style = string();
409 use_bibtopic = false;
412 save_transient_properties = true;
413 track_changes = false;
414 output_changes = false;
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_old_figures = false;
435 fonts_sans_scale[0] = 100;
436 fonts_sans_scale[1] = 100;
437 fonts_typewriter_scale[0] = 100;
438 fonts_typewriter_scale[1] = 100;
439 inputenc = "auto-legacy";
440 lang_package = "default";
441 graphics_driver = "default";
442 default_output_format = "default";
443 bibtex_command = "default";
444 index_command = "default";
447 listings_params = string();
448 pagestyle = "default";
449 tablestyle = "default";
450 suppress_date = false;
451 justification = true;
452 // no color is the default (white)
453 backgroundcolor = lyx::rgbFromHexName("#ffffff");
454 isbackgroundcolor = false;
455 // no color is the default (black)
456 fontcolor = lyx::rgbFromHexName("#000000");
458 // light gray is the default font color for greyed-out notes
459 notefontcolor = lyx::rgbFromHexName("#cccccc");
460 boxbgcolor = lyx::rgbFromHexName("#ff0000");
461 compressed = lyxrc.save_compressed;
462 for (int iter = 0; iter < 4; ++iter) {
463 user_defined_bullet(iter) = ITEMIZE_DEFAULTS[iter];
464 temp_bullet(iter) = ITEMIZE_DEFAULTS[iter];
467 indiceslist().addDefault(B_("Index"));
468 html_be_strict = false;
469 html_math_output = MathML;
470 html_math_img_scale = 1.0;
471 html_css_as_file = false;
472 display_pixel_ratio = 1.0;
474 shell_escape = false;
479 // map current author
480 author_map_[pimpl_->authorlist.get(0).bufferId()] = 0;
484 docstring BufferParams::B_(string const & l10n) const
486 LASSERT(language, return from_utf8(l10n));
487 return getMessages(language->code()).get(l10n);
491 BufferParams::Package BufferParams::use_package(std::string const & p) const
493 PackageMap::const_iterator it = use_packages.find(p);
494 if (it == use_packages.end())
500 void BufferParams::use_package(std::string const & p, BufferParams::Package u)
506 map<string, string> const & BufferParams::auto_packages()
508 static map<string, string> packages;
509 if (packages.empty()) {
510 // We could have a race condition here that two threads
511 // discover an empty map at the same time and want to fill
512 // it, but that is no problem, since the same contents is
513 // filled in twice then. Having the locker inside the
514 // packages.empty() condition has the advantage that we
515 // don't need the mutex overhead for simple reading.
517 Mutex::Locker locker(&mutex);
518 // adding a package here implies a file format change!
519 packages["amsmath"] =
520 N_("The LaTeX package amsmath is only used if AMS formula types or symbols from the AMS math toolbars are inserted into formulas");
521 packages["amssymb"] =
522 N_("The LaTeX package amssymb is only used if symbols from the AMS math toolbars are inserted into formulas");
524 N_("The LaTeX package cancel is only used if \\cancel commands are used in formulas");
526 N_("The LaTeX package esint is only used if special integral symbols are inserted into formulas");
527 packages["mathdots"] =
528 N_("The LaTeX package mathdots is only used if the command \\iddots is inserted into formulas");
529 packages["mathtools"] =
530 N_("The LaTeX package mathtools is only used if some mathematical relations are inserted into formulas");
532 N_("The LaTeX package mhchem is only used if either the command \\ce or \\cf is inserted into formulas");
533 packages["stackrel"] =
534 N_("The LaTeX package stackrel is only used if the command \\stackrel with subscript is inserted into formulas");
535 packages["stmaryrd"] =
536 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");
537 packages["undertilde"] =
538 N_("The LaTeX package undertilde is only used if you use the math frame decoration 'utilde'");
544 bool BufferParams::useBibtopic() const
548 return (use_bibtopic || (!multibib.empty() && multibib != "child"));
552 AuthorList & BufferParams::authors()
554 return pimpl_->authorlist;
558 AuthorList const & BufferParams::authors() const
560 return pimpl_->authorlist;
564 void BufferParams::addAuthor(Author a)
566 author_map_[a.bufferId()] = pimpl_->authorlist.record(a);
570 BranchList & BufferParams::branchlist()
572 return pimpl_->branchlist;
576 BranchList const & BufferParams::branchlist() const
578 return pimpl_->branchlist;
582 IndicesList & BufferParams::indiceslist()
584 return pimpl_->indiceslist;
588 IndicesList const & BufferParams::indiceslist() const
590 return pimpl_->indiceslist;
594 Bullet & BufferParams::temp_bullet(lyx::size_type const index)
596 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
597 return pimpl_->temp_bullets[index];
601 Bullet const & BufferParams::temp_bullet(lyx::size_type const index) const
603 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
604 return pimpl_->temp_bullets[index];
608 Bullet & BufferParams::user_defined_bullet(lyx::size_type const index)
610 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
611 return pimpl_->user_defined_bullets[index];
615 Bullet const & BufferParams::user_defined_bullet(lyx::size_type const index) const
617 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
618 return pimpl_->user_defined_bullets[index];
622 Spacing & BufferParams::spacing()
624 return pimpl_->spacing;
628 Spacing const & BufferParams::spacing() const
630 return pimpl_->spacing;
634 PDFOptions & BufferParams::pdfoptions()
636 return pimpl_->pdfoptions;
640 PDFOptions const & BufferParams::pdfoptions() const
642 return pimpl_->pdfoptions;
646 Length const & BufferParams::getMathIndent() const
648 return pimpl_->mathindent;
652 void BufferParams::setMathIndent(Length const & indent)
654 pimpl_->mathindent = indent;
658 Length const & BufferParams::getParIndent() const
660 return pimpl_->parindent;
664 void BufferParams::setParIndent(Length const & indent)
666 pimpl_->parindent = indent;
670 VSpace const & BufferParams::getDefSkip() const
672 return pimpl_->defskip;
676 void BufferParams::setDefSkip(VSpace const & vs)
678 // DEFSKIP will cause an infinite loop
679 LASSERT(vs.kind() != VSpace::DEFSKIP, return);
680 pimpl_->defskip = vs;
684 BufferParams::MathNumber BufferParams::getMathNumber() const
686 if (math_numbering_side != DEFAULT)
687 return math_numbering_side;
688 // FIXME: do not hardcode language here
689 else if (language->lang() == "arabic_arabi"
690 || documentClass().provides("leqno"))
697 string BufferParams::readToken(Lexer & lex, string const & token,
698 FileName const & filepath)
702 if (token == "\\textclass") {
704 string const classname = lex.getString();
705 // if there exists a local layout file, ignore the system one
706 // NOTE: in this case, the textclass (.cls file) is assumed to
709 LayoutFileList & bcl = LayoutFileList::get();
710 if (!filepath.empty()) {
711 // If classname is an absolute path, the document is
712 // using a local layout file which could not be accessed
713 // by a relative path. In this case the path is correct
714 // even if the document was moved to a different
715 // location. However, we will have a problem if the
716 // document was generated on a different platform.
717 bool isabsolute = FileName::isAbsolute(classname);
718 string const classpath = onlyPath(classname);
719 string const path = isabsolute ? classpath
720 : FileName(addPath(filepath.absFileName(),
721 classpath)).realPath();
722 string const oldpath = isabsolute ? string()
723 : FileName(addPath(origin, classpath)).realPath();
724 tcp = bcl.addLocalLayout(onlyFileName(classname), path, oldpath);
726 // that returns non-empty if a "local" layout file is found.
728 result = to_utf8(makeRelPath(from_utf8(onlyPath(tcp)),
729 from_utf8(filepath.absFileName())));
732 setBaseClass(onlyFileName(tcp));
734 setBaseClass(onlyFileName(classname));
735 // We assume that a tex class exists for local or unknown
736 // layouts so this warning, will only be given for system layouts.
737 if (!baseClass()->isTeXClassAvailable()) {
738 docstring const desc =
739 translateIfPossible(from_utf8(baseClass()->description()));
740 docstring const prereqs =
741 from_utf8(baseClass()->prerequisites());
742 docstring const msg =
743 bformat(_("The selected document class\n"
745 "requires external files that are not available.\n"
746 "The document class can still be used, but the\n"
747 "document cannot be compiled until the following\n"
748 "prerequisites are installed:\n"
750 "See section 3.1.2.2 (Class Availability) of the\n"
751 "User's Guide for more information."), desc, prereqs);
752 frontend::Alert::warning(_("Document class not available"),
755 } else if (token == "\\save_transient_properties") {
756 lex >> save_transient_properties;
757 } else if (token == "\\origin") {
759 origin = lex.getString();
760 string const sysdirprefix = "/systemlyxdir/";
761 if (prefixIs(origin, sysdirprefix)) {
763 if (inSystemDir(filepath, docsys))
764 origin.replace(0, sysdirprefix.length() - 1, docsys);
766 origin.replace(0, sysdirprefix.length() - 1,
767 package().system_support().absFileName());
769 } else if (token == "\\begin_preamble") {
771 } else if (token == "\\begin_local_layout") {
772 readLocalLayout(lex, false);
773 } else if (token == "\\begin_forced_local_layout") {
774 readLocalLayout(lex, true);
775 } else if (token == "\\begin_modules") {
777 } else if (token == "\\begin_removed_modules") {
778 readRemovedModules(lex);
779 } else if (token == "\\begin_includeonly") {
780 readIncludeonly(lex);
781 } else if (token == "\\maintain_unincluded_children") {
782 lex >> maintain_unincluded_children;
783 } else if (token == "\\options") {
785 options = lex.getString();
786 } else if (token == "\\use_default_options") {
787 lex >> use_default_options;
788 } else if (token == "\\master") {
790 master = lex.getString();
791 if (!filepath.empty() && FileName::isAbsolute(origin)) {
792 bool const isabs = FileName::isAbsolute(master);
793 FileName const abspath(isabs ? master : origin + master);
794 bool const moved = filepath != FileName(origin);
795 if (moved && abspath.exists()) {
796 docstring const path = isabs
798 : from_utf8(abspath.realPath());
799 docstring const refpath =
800 from_utf8(filepath.absFileName());
801 master = to_utf8(makeRelPath(path, refpath));
804 } else if (token == "\\suppress_date") {
805 lex >> suppress_date;
806 } else if (token == "\\justification") {
807 lex >> justification;
808 } else if (token == "\\language") {
810 } else if (token == "\\language_package") {
812 lang_package = lex.getString();
813 } else if (token == "\\inputencoding") {
815 } else if (token == "\\graphics") {
816 readGraphicsDriver(lex);
817 } else if (token == "\\default_output_format") {
818 lex >> default_output_format;
819 } else if (token == "\\bibtex_command") {
821 bibtex_command = lex.getString();
822 } else if (token == "\\index_command") {
824 index_command = lex.getString();
825 } else if (token == "\\fontencoding") {
827 fontenc = lex.getString();
828 } else if (token == "\\font_roman") {
829 lex >> fonts_roman[0];
830 lex >> fonts_roman[1];
831 } else if (token == "\\font_sans") {
832 lex >> fonts_sans[0];
833 lex >> fonts_sans[1];
834 } else if (token == "\\font_typewriter") {
835 lex >> fonts_typewriter[0];
836 lex >> fonts_typewriter[1];
837 } else if (token == "\\font_math") {
838 lex >> fonts_math[0];
839 lex >> fonts_math[1];
840 } else if (token == "\\font_default_family") {
841 lex >> fonts_default_family;
842 } else if (token == "\\use_non_tex_fonts") {
843 lex >> useNonTeXFonts;
844 } else if (token == "\\font_sc") {
845 lex >> fonts_expert_sc;
846 } else if (token == "\\font_osf") {
847 lex >> fonts_old_figures;
848 } else if (token == "\\font_sf_scale") {
849 lex >> fonts_sans_scale[0];
850 lex >> fonts_sans_scale[1];
851 } else if (token == "\\font_tt_scale") {
852 lex >> fonts_typewriter_scale[0];
853 lex >> fonts_typewriter_scale[1];
854 } else if (token == "\\font_cjk") {
856 } else if (token == "\\use_microtype") {
857 lex >> use_microtype;
858 } else if (token == "\\use_dash_ligatures") {
859 lex >> use_dash_ligatures;
860 } else if (token == "\\paragraph_separation") {
863 paragraph_separation = parseptranslator().find(parsep);
864 } else if (token == "\\paragraph_indentation") {
866 string parindent = lex.getString();
867 if (parindent == "default")
868 pimpl_->parindent = Length();
870 pimpl_->parindent = Length(parindent);
871 } else if (token == "\\defskip") {
873 string const defskip = lex.getString();
874 pimpl_->defskip = VSpace(defskip);
875 if (pimpl_->defskip.kind() == VSpace::DEFSKIP)
877 pimpl_->defskip = VSpace(VSpace::MEDSKIP);
878 } else if (token == "\\is_math_indent") {
879 lex >> is_math_indent;
880 } else if (token == "\\math_indentation") {
882 string mathindent = lex.getString();
883 if (mathindent == "default")
884 pimpl_->mathindent = Length();
886 pimpl_->mathindent = Length(mathindent);
887 } else if (token == "\\math_numbering_side") {
891 math_numbering_side = LEFT;
892 else if (tmp == "right")
893 math_numbering_side = RIGHT;
895 math_numbering_side = DEFAULT;
896 } else if (token == "\\quotes_style") {
899 quotes_style = quotesstyletranslator().find(qstyle);
900 } else if (token == "\\dynamic_quotes") {
901 lex >> dynamic_quotes;
902 } else if (token == "\\papersize") {
905 papersize = papersizetranslator().find(ppsize);
906 } else if (token == "\\use_geometry") {
908 } else if (token == "\\use_package") {
913 use_package(package, packagetranslator().find(use));
914 } else if (token == "\\cite_engine") {
916 cite_engine_ = lex.getString();
917 } else if (token == "\\cite_engine_type") {
920 cite_engine_type_ = theCiteEnginesList.getType(engine_type);
921 } else if (token == "\\biblio_style") {
923 biblio_style = lex.getString();
924 } else if (token == "\\biblio_options") {
926 biblio_opts = trim(lex.getString());
927 } else if (token == "\\biblatex_bibstyle") {
929 biblatex_bibstyle = trim(lex.getString());
930 } else if (token == "\\biblatex_citestyle") {
932 biblatex_citestyle = trim(lex.getString());
933 } else if (token == "\\use_bibtopic") {
935 } else if (token == "\\multibib") {
937 } else if (token == "\\use_indices") {
939 } else if (token == "\\tracking_changes") {
940 lex >> track_changes;
941 } else if (token == "\\output_changes") {
942 lex >> output_changes;
943 } else if (token == "\\branch") {
945 docstring branch = lex.getDocString();
946 branchlist().add(branch);
949 string const tok = lex.getString();
950 if (tok == "\\end_branch")
952 Branch * branch_ptr = branchlist().find(branch);
953 if (tok == "\\selected") {
956 branch_ptr->setSelected(lex.getInteger());
958 if (tok == "\\filename_suffix") {
961 branch_ptr->setFileNameSuffix(lex.getInteger());
963 if (tok == "\\color") {
965 string color = lex.getString();
967 branch_ptr->setColor(color);
968 // Update also the Color table:
970 color = lcolor.getX11Name(Color_background);
972 lcolor.setColor(to_utf8(branch), color);
975 } else if (token == "\\index") {
977 docstring index = lex.getDocString();
979 indiceslist().add(index);
982 string const tok = lex.getString();
983 if (tok == "\\end_index")
985 Index * index_ptr = indiceslist().find(index);
986 if (tok == "\\shortcut") {
988 shortcut = lex.getDocString();
990 index_ptr->setShortcut(shortcut);
992 if (tok == "\\color") {
994 string color = lex.getString();
996 index_ptr->setColor(color);
997 // Update also the Color table:
999 color = lcolor.getX11Name(Color_background);
1001 if (!shortcut.empty())
1002 lcolor.setColor(to_utf8(shortcut), color);
1005 } else if (token == "\\author") {
1007 istringstream ss(lex.getString());
1011 } else if (token == "\\paperorientation") {
1014 orientation = paperorientationtranslator().find(orient);
1015 } else if (token == "\\backgroundcolor") {
1017 backgroundcolor = lyx::rgbFromHexName(lex.getString());
1018 isbackgroundcolor = true;
1019 } else if (token == "\\fontcolor") {
1021 fontcolor = lyx::rgbFromHexName(lex.getString());
1023 } else if (token == "\\notefontcolor") {
1025 string color = lex.getString();
1026 notefontcolor = lyx::rgbFromHexName(color);
1027 lcolor.setColor("notefontcolor", color);
1028 } else if (token == "\\boxbgcolor") {
1030 string color = lex.getString();
1031 boxbgcolor = lyx::rgbFromHexName(color);
1032 lcolor.setColor("boxbgcolor", color);
1033 } else if (token == "\\paperwidth") {
1035 } else if (token == "\\paperheight") {
1037 } else if (token == "\\leftmargin") {
1039 } else if (token == "\\topmargin") {
1041 } else if (token == "\\rightmargin") {
1043 } else if (token == "\\bottommargin") {
1044 lex >> bottommargin;
1045 } else if (token == "\\headheight") {
1047 } else if (token == "\\headsep") {
1049 } else if (token == "\\footskip") {
1051 } else if (token == "\\columnsep") {
1053 } else if (token == "\\paperfontsize") {
1055 } else if (token == "\\papercolumns") {
1057 } else if (token == "\\listings_params") {
1060 listings_params = InsetListingsParams(par).params();
1061 } else if (token == "\\papersides") {
1064 sides = sidestranslator().find(psides);
1065 } else if (token == "\\paperpagestyle") {
1067 } else if (token == "\\tablestyle") {
1069 } else if (token == "\\bullet") {
1071 } else if (token == "\\bulletLaTeX") {
1072 readBulletsLaTeX(lex);
1073 } else if (token == "\\secnumdepth") {
1075 } else if (token == "\\tocdepth") {
1077 } else if (token == "\\spacing") {
1081 if (nspacing == "other") {
1084 spacing().set(spacetranslator().find(nspacing), tmp_val);
1085 } else if (token == "\\float_placement") {
1086 lex >> float_placement;
1087 } else if (token == "\\float_alignment") {
1088 lex >> float_alignment;
1090 } else if (prefixIs(token, "\\pdf_") || token == "\\use_hyperref") {
1091 string toktmp = pdfoptions().readToken(lex, token);
1092 if (!toktmp.empty()) {
1093 lyxerr << "PDFOptions::readToken(): Unknown token: " <<
1097 } else if (token == "\\html_math_output") {
1100 html_math_output = static_cast<MathOutput>(temp);
1101 } else if (token == "\\html_be_strict") {
1102 lex >> html_be_strict;
1103 } else if (token == "\\html_css_as_file") {
1104 lex >> html_css_as_file;
1105 } else if (token == "\\html_math_img_scale") {
1106 lex >> html_math_img_scale;
1107 } else if (token == "\\html_latex_start") {
1109 html_latex_start = lex.getString();
1110 } else if (token == "\\html_latex_end") {
1112 html_latex_end = lex.getString();
1113 } else if (token == "\\output_sync") {
1115 } else if (token == "\\output_sync_macro") {
1116 lex >> output_sync_macro;
1117 } else if (token == "\\use_refstyle") {
1118 lex >> use_refstyle;
1119 } else if (token == "\\use_minted") {
1122 lyxerr << "BufferParams::readToken(): Unknown token: " <<
1132 // Quote argument if it contains spaces
1133 string quoteIfNeeded(string const & str) {
1134 if (contains(str, ' '))
1135 return "\"" + str + "\"";
1141 void BufferParams::writeFile(ostream & os, Buffer const * buf) const
1143 // The top of the file is written by the buffer.
1144 // Prints out the buffer info into the .lyx file given by file
1146 os << "\\save_transient_properties "
1147 << convert<string>(save_transient_properties) << '\n';
1149 // the document directory (must end with a path separator)
1150 // realPath() is used to resolve symlinks, while addPath(..., "")
1151 // ensures a trailing path separator.
1153 string filepath = addPath(buf->fileName().onlyPath().realPath(), "");
1154 string const sysdir = inSystemDir(FileName(filepath), docsys) ? docsys
1155 : addPath(package().system_support().realPath(), "");
1156 string const relpath =
1157 to_utf8(makeRelPath(from_utf8(filepath), from_utf8(sysdir)));
1158 if (!prefixIs(relpath, "../") && !FileName::isAbsolute(relpath))
1159 filepath = addPath("/systemlyxdir", relpath);
1160 else if (!save_transient_properties || !lyxrc.save_origin)
1161 filepath = "unavailable";
1162 os << "\\origin " << quoteIfNeeded(filepath) << '\n';
1165 os << "\\textclass "
1166 << quoteIfNeeded(buf->includedFilePath(addName(buf->layoutPos(),
1167 baseClass()->name()), "layout"))
1170 // then the preamble
1171 if (!preamble.empty()) {
1172 // remove '\n' from the end of preamble
1173 docstring const tmppreamble = rtrim(preamble, "\n");
1174 os << "\\begin_preamble\n"
1175 << to_utf8(tmppreamble)
1176 << "\n\\end_preamble\n";
1180 if (!options.empty()) {
1181 os << "\\options " << options << '\n';
1184 // use the class options defined in the layout?
1185 os << "\\use_default_options "
1186 << convert<string>(use_default_options) << "\n";
1188 // the master document
1189 if (!master.empty()) {
1190 os << "\\master " << master << '\n';
1194 if (!removed_modules_.empty()) {
1195 os << "\\begin_removed_modules" << '\n';
1196 list<string>::const_iterator it = removed_modules_.begin();
1197 list<string>::const_iterator en = removed_modules_.end();
1198 for (; it != en; ++it)
1200 os << "\\end_removed_modules" << '\n';
1204 if (!layout_modules_.empty()) {
1205 os << "\\begin_modules" << '\n';
1206 LayoutModuleList::const_iterator it = layout_modules_.begin();
1207 LayoutModuleList::const_iterator en = layout_modules_.end();
1208 for (; it != en; ++it)
1210 os << "\\end_modules" << '\n';
1214 if (!included_children_.empty()) {
1215 os << "\\begin_includeonly" << '\n';
1216 list<string>::const_iterator it = included_children_.begin();
1217 list<string>::const_iterator en = included_children_.end();
1218 for (; it != en; ++it)
1220 os << "\\end_includeonly" << '\n';
1222 os << "\\maintain_unincluded_children "
1223 << convert<string>(maintain_unincluded_children) << '\n';
1225 // local layout information
1226 docstring const local_layout = getLocalLayout(false);
1227 if (!local_layout.empty()) {
1228 // remove '\n' from the end
1229 docstring const tmplocal = rtrim(local_layout, "\n");
1230 os << "\\begin_local_layout\n"
1231 << to_utf8(tmplocal)
1232 << "\n\\end_local_layout\n";
1234 docstring const forced_local_layout = getLocalLayout(true);
1235 if (!forced_local_layout.empty()) {
1236 // remove '\n' from the end
1237 docstring const tmplocal = rtrim(forced_local_layout, "\n");
1238 os << "\\begin_forced_local_layout\n"
1239 << to_utf8(tmplocal)
1240 << "\n\\end_forced_local_layout\n";
1243 // then the text parameters
1244 if (language != ignore_language)
1245 os << "\\language " << language->lang() << '\n';
1246 os << "\\language_package " << lang_package
1247 << "\n\\inputencoding " << inputenc
1248 << "\n\\fontencoding " << fontenc
1249 << "\n\\font_roman \"" << fonts_roman[0]
1250 << "\" \"" << fonts_roman[1] << '"'
1251 << "\n\\font_sans \"" << fonts_sans[0]
1252 << "\" \"" << fonts_sans[1] << '"'
1253 << "\n\\font_typewriter \"" << fonts_typewriter[0]
1254 << "\" \"" << fonts_typewriter[1] << '"'
1255 << "\n\\font_math \"" << fonts_math[0]
1256 << "\" \"" << fonts_math[1] << '"'
1257 << "\n\\font_default_family " << fonts_default_family
1258 << "\n\\use_non_tex_fonts " << convert<string>(useNonTeXFonts)
1259 << "\n\\font_sc " << convert<string>(fonts_expert_sc)
1260 << "\n\\font_osf " << convert<string>(fonts_old_figures)
1261 << "\n\\font_sf_scale " << fonts_sans_scale[0]
1262 << ' ' << fonts_sans_scale[1]
1263 << "\n\\font_tt_scale " << fonts_typewriter_scale[0]
1264 << ' ' << fonts_typewriter_scale[1]
1266 if (!fonts_cjk.empty()) {
1267 os << "\\font_cjk " << fonts_cjk << '\n';
1269 os << "\\use_microtype " << convert<string>(use_microtype) << '\n';
1270 os << "\\use_dash_ligatures " << convert<string>(use_dash_ligatures) << '\n';
1271 os << "\\graphics " << graphics_driver << '\n';
1272 os << "\\default_output_format " << default_output_format << '\n';
1273 os << "\\output_sync " << output_sync << '\n';
1274 if (!output_sync_macro.empty())
1275 os << "\\output_sync_macro \"" << output_sync_macro << "\"\n";
1276 os << "\\bibtex_command " << bibtex_command << '\n';
1277 os << "\\index_command " << index_command << '\n';
1279 if (!float_placement.empty())
1280 os << "\\float_placement " << float_placement << '\n';
1281 if (!float_alignment.empty())
1282 os << "\\float_alignment " << float_alignment << '\n';
1283 os << "\\paperfontsize " << fontsize << '\n';
1285 spacing().writeFile(os);
1286 pdfoptions().writeFile(os);
1288 os << "\\papersize " << string_papersize[papersize]
1289 << "\n\\use_geometry " << convert<string>(use_geometry);
1290 map<string, string> const & packages = auto_packages();
1291 for (map<string, string>::const_iterator it = packages.begin();
1292 it != packages.end(); ++it)
1293 os << "\n\\use_package " << it->first << ' '
1294 << use_package(it->first);
1296 os << "\n\\cite_engine ";
1298 if (!cite_engine_.empty())
1303 os << "\n\\cite_engine_type " << theCiteEnginesList.getTypeAsString(cite_engine_type_);
1305 if (!biblio_style.empty())
1306 os << "\n\\biblio_style " << biblio_style;
1307 if (!biblio_opts.empty())
1308 os << "\n\\biblio_options " << biblio_opts;
1309 if (!biblatex_bibstyle.empty())
1310 os << "\n\\biblatex_bibstyle " << biblatex_bibstyle;
1311 if (!biblatex_citestyle.empty())
1312 os << "\n\\biblatex_citestyle " << biblatex_citestyle;
1313 if (!multibib.empty())
1314 os << "\n\\multibib " << multibib;
1316 os << "\n\\use_bibtopic " << convert<string>(use_bibtopic)
1317 << "\n\\use_indices " << convert<string>(use_indices)
1318 << "\n\\paperorientation " << string_orientation[orientation]
1319 << "\n\\suppress_date " << convert<string>(suppress_date)
1320 << "\n\\justification " << convert<string>(justification)
1321 << "\n\\use_refstyle " << use_refstyle
1322 << "\n\\use_minted " << use_minted
1324 if (isbackgroundcolor == true)
1325 os << "\\backgroundcolor " << lyx::X11hexname(backgroundcolor) << '\n';
1326 if (isfontcolor == true)
1327 os << "\\fontcolor " << lyx::X11hexname(fontcolor) << '\n';
1328 if (notefontcolor != lyx::rgbFromHexName("#cccccc"))
1329 os << "\\notefontcolor " << lyx::X11hexname(notefontcolor) << '\n';
1330 if (boxbgcolor != lyx::rgbFromHexName("#ff0000"))
1331 os << "\\boxbgcolor " << lyx::X11hexname(boxbgcolor) << '\n';
1333 BranchList::const_iterator it = branchlist().begin();
1334 BranchList::const_iterator end = branchlist().end();
1335 for (; it != end; ++it) {
1336 os << "\\branch " << to_utf8(it->branch())
1337 << "\n\\selected " << it->isSelected()
1338 << "\n\\filename_suffix " << it->hasFileNameSuffix()
1339 << "\n\\color " << lyx::X11hexname(it->color())
1344 IndicesList::const_iterator iit = indiceslist().begin();
1345 IndicesList::const_iterator iend = indiceslist().end();
1346 for (; iit != iend; ++iit) {
1347 os << "\\index " << to_utf8(iit->index())
1348 << "\n\\shortcut " << to_utf8(iit->shortcut())
1349 << "\n\\color " << lyx::X11hexname(iit->color())
1354 if (!paperwidth.empty())
1355 os << "\\paperwidth "
1356 << VSpace(paperwidth).asLyXCommand() << '\n';
1357 if (!paperheight.empty())
1358 os << "\\paperheight "
1359 << VSpace(paperheight).asLyXCommand() << '\n';
1360 if (!leftmargin.empty())
1361 os << "\\leftmargin "
1362 << VSpace(leftmargin).asLyXCommand() << '\n';
1363 if (!topmargin.empty())
1364 os << "\\topmargin "
1365 << VSpace(topmargin).asLyXCommand() << '\n';
1366 if (!rightmargin.empty())
1367 os << "\\rightmargin "
1368 << VSpace(rightmargin).asLyXCommand() << '\n';
1369 if (!bottommargin.empty())
1370 os << "\\bottommargin "
1371 << VSpace(bottommargin).asLyXCommand() << '\n';
1372 if (!headheight.empty())
1373 os << "\\headheight "
1374 << VSpace(headheight).asLyXCommand() << '\n';
1375 if (!headsep.empty())
1377 << VSpace(headsep).asLyXCommand() << '\n';
1378 if (!footskip.empty())
1380 << VSpace(footskip).asLyXCommand() << '\n';
1381 if (!columnsep.empty())
1382 os << "\\columnsep "
1383 << VSpace(columnsep).asLyXCommand() << '\n';
1384 os << "\\secnumdepth " << secnumdepth
1385 << "\n\\tocdepth " << tocdepth
1386 << "\n\\paragraph_separation "
1387 << string_paragraph_separation[paragraph_separation];
1388 if (!paragraph_separation)
1389 os << "\n\\paragraph_indentation "
1390 << (getParIndent().empty() ? "default" : getParIndent().asString());
1392 os << "\n\\defskip " << getDefSkip().asLyXCommand();
1393 os << "\n\\is_math_indent " << is_math_indent;
1395 os << "\n\\math_indentation "
1396 << (getMathIndent().empty() ? "default" : getMathIndent().asString());
1397 os << "\n\\math_numbering_side ";
1398 switch(math_numbering_side) {
1408 os << "\n\\quotes_style "
1409 << string_quotes_style[quotes_style]
1410 << "\n\\dynamic_quotes " << dynamic_quotes
1411 << "\n\\papercolumns " << columns
1412 << "\n\\papersides " << sides
1413 << "\n\\paperpagestyle " << pagestyle
1414 << "\n\\tablestyle " << tablestyle << '\n';
1415 if (!listings_params.empty())
1416 os << "\\listings_params \"" <<
1417 InsetListingsParams(listings_params).encodedString() << "\"\n";
1418 for (int i = 0; i < 4; ++i) {
1419 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1420 if (user_defined_bullet(i).getFont() != -1) {
1421 os << "\\bullet " << i << " "
1422 << user_defined_bullet(i).getFont() << " "
1423 << user_defined_bullet(i).getCharacter() << " "
1424 << user_defined_bullet(i).getSize() << "\n";
1428 os << "\\bulletLaTeX " << i << " \""
1429 << lyx::to_ascii(user_defined_bullet(i).getText())
1435 os << "\\tracking_changes "
1436 << (save_transient_properties ? convert<string>(track_changes) : "false")
1439 os << "\\output_changes "
1440 << (save_transient_properties ? convert<string>(output_changes) : "false")
1443 os << "\\html_math_output " << html_math_output << '\n'
1444 << "\\html_css_as_file " << html_css_as_file << '\n'
1445 << "\\html_be_strict " << convert<string>(html_be_strict) << '\n';
1447 if (html_math_img_scale != 1.0)
1448 os << "\\html_math_img_scale " << convert<string>(html_math_img_scale) << '\n';
1449 if (!html_latex_start.empty())
1450 os << "\\html_latex_start " << html_latex_start << '\n';
1451 if (!html_latex_end.empty())
1452 os << "\\html_latex_end " << html_latex_end << '\n';
1454 os << pimpl_->authorlist;
1458 void BufferParams::validate(LaTeXFeatures & features) const
1460 features.require(documentClass().requires());
1462 if (columns > 1 && language->rightToLeft())
1463 features.require("rtloutputdblcol");
1465 if (output_changes) {
1466 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1467 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1468 LaTeXFeatures::isAvailable("xcolor");
1470 switch (features.runparams().flavor) {
1471 case OutputParams::LATEX:
1472 case OutputParams::DVILUATEX:
1474 features.require("ct-dvipost");
1475 features.require("dvipost");
1476 } else if (xcolorulem) {
1477 features.require("ct-xcolor-ulem");
1478 features.require("ulem");
1479 features.require("xcolor");
1481 features.require("ct-none");
1484 case OutputParams::LUATEX:
1485 case OutputParams::PDFLATEX:
1486 case OutputParams::XETEX:
1488 features.require("ct-xcolor-ulem");
1489 features.require("ulem");
1490 features.require("xcolor");
1491 // improves color handling in PDF output
1492 features.require("pdfcolmk");
1494 features.require("ct-none");
1502 // Floats with 'Here definitely' as default setting.
1503 if (float_placement.find('H') != string::npos)
1504 features.require("float");
1506 for (PackageMap::const_iterator it = use_packages.begin();
1507 it != use_packages.end(); ++it) {
1508 if (it->first == "amsmath") {
1509 // AMS Style is at document level
1510 if (it->second == package_on ||
1511 features.isProvided("amsmath"))
1512 features.require(it->first);
1513 } else if (it->second == package_on)
1514 features.require(it->first);
1517 // Document-level line spacing
1518 if (spacing().getSpace() != Spacing::Single && !spacing().isDefault())
1519 features.require("setspace");
1521 // the bullet shapes are buffer level not paragraph level
1522 // so they are tested here
1523 for (int i = 0; i < 4; ++i) {
1524 if (user_defined_bullet(i) == ITEMIZE_DEFAULTS[i])
1526 int const font = user_defined_bullet(i).getFont();
1528 int const c = user_defined_bullet(i).getCharacter();
1534 features.require("latexsym");
1536 } else if (font == 1) {
1537 features.require("amssymb");
1538 } else if (font >= 2 && font <= 5) {
1539 features.require("pifont");
1543 if (pdfoptions().use_hyperref) {
1544 features.require("hyperref");
1545 // due to interferences with babel and hyperref, the color package has to
1546 // be loaded after hyperref when hyperref is used with the colorlinks
1547 // option, see http://www.lyx.org/trac/ticket/5291
1548 if (pdfoptions().colorlinks)
1549 features.require("color");
1551 if (!listings_params.empty()) {
1552 // do not test validity because listings_params is
1553 // supposed to be valid
1555 InsetListingsParams(listings_params).separatedParams(true);
1556 // we can't support all packages, but we should load the color package
1557 if (par.find("\\color", 0) != string::npos)
1558 features.require("color");
1561 // some languages are only available via polyglossia
1562 if (features.hasPolyglossiaExclusiveLanguages())
1563 features.require("polyglossia");
1565 if (useNonTeXFonts && fontsMath() != "auto")
1566 features.require("unicode-math");
1569 features.require("microtype");
1571 if (!language->requires().empty())
1572 features.require(language->requires());
1576 bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
1577 FileName const & filepath) const
1579 // http://www.tug.org/texmf-dist/doc/latex/base/fixltx2e.pdf
1580 // !! To use the Fix-cm package, load it before \documentclass, and use the command
1581 // \RequirePackage to do so, rather than the normal \usepackage
1582 // Do not try to load any other package before the document class, unless you
1583 // have a thorough understanding of the LATEX internals and know exactly what you
1585 if (features.mustProvide("fix-cm"))
1586 os << "\\RequirePackage{fix-cm}\n";
1587 // Likewise for fixltx2e. If other packages conflict with this policy,
1588 // treat it as a package bug (and report it!)
1589 // See http://www.latex-project.org/cgi-bin/ltxbugs2html?pr=latex/4407
1590 if (features.mustProvide("fixltx2e"))
1591 os << "\\RequirePackage{fixltx2e}\n";
1593 os << "\\documentclass";
1595 DocumentClass const & tclass = documentClass();
1597 ostringstream clsoptions; // the document class options.
1599 if (tokenPos(tclass.opt_fontsize(),
1600 '|', fontsize) >= 0) {
1601 // only write if existing in list (and not default)
1602 clsoptions << fontsize << "pt,";
1605 // all paper sizes except of A4, A5, B5 and the US sizes need the
1607 bool nonstandard_papersize = papersize != PAPER_DEFAULT
1608 && papersize != PAPER_USLETTER
1609 && papersize != PAPER_USLEGAL
1610 && papersize != PAPER_USEXECUTIVE
1611 && papersize != PAPER_A4
1612 && papersize != PAPER_A5
1613 && papersize != PAPER_B5;
1615 if (!use_geometry) {
1616 switch (papersize) {
1618 clsoptions << "a4paper,";
1620 case PAPER_USLETTER:
1621 clsoptions << "letterpaper,";
1624 clsoptions << "a5paper,";
1627 clsoptions << "b5paper,";
1629 case PAPER_USEXECUTIVE:
1630 clsoptions << "executivepaper,";
1633 clsoptions << "legalpaper,";
1667 if (sides != tclass.sides()) {
1670 clsoptions << "oneside,";
1673 clsoptions << "twoside,";
1679 if (columns != tclass.columns()) {
1681 clsoptions << "twocolumn,";
1683 clsoptions << "onecolumn,";
1687 && orientation == ORIENTATION_LANDSCAPE)
1688 clsoptions << "landscape,";
1691 clsoptions << "fleqn,";
1693 switch(math_numbering_side) {
1695 clsoptions << "leqno,";
1698 clsoptions << "reqno,";
1699 features.require("amsmath");
1705 // language should be a parameter to \documentclass
1706 if (language->babel() == "hebrew"
1707 && default_language->babel() != "hebrew")
1708 // This seems necessary
1709 features.useLanguage(default_language);
1711 ostringstream language_options;
1712 bool const use_babel = features.useBabel() && !features.isProvided("babel");
1713 bool const use_polyglossia = features.usePolyglossia();
1714 bool const global = lyxrc.language_global_options;
1715 if (features.useBabel() || (use_polyglossia && global)) {
1716 language_options << features.getBabelLanguages();
1717 if (!language->babel().empty()) {
1718 if (!language_options.str().empty())
1719 language_options << ',';
1720 language_options << language->babel();
1722 if (global && !language_options.str().empty())
1723 clsoptions << language_options.str() << ',';
1726 // the predefined options from the layout
1727 if (use_default_options && !tclass.options().empty())
1728 clsoptions << tclass.options() << ',';
1730 // the user-defined options
1731 if (!options.empty()) {
1732 clsoptions << options << ',';
1735 string strOptions(clsoptions.str());
1736 if (!strOptions.empty()) {
1737 strOptions = rtrim(strOptions, ",");
1739 os << '[' << from_utf8(strOptions) << ']';
1742 os << '{' << from_ascii(tclass.latexname()) << "}\n";
1743 // end of \documentclass defs
1745 // if we use fontspec or newtxmath, we have to load the AMS packages here
1746 string const ams = features.loadAMSPackages();
1747 bool const ot1 = (main_font_encoding() == "default" || main_font_encoding() == "OT1");
1748 bool const use_newtxmath =
1749 theLaTeXFonts().getLaTeXFont(from_ascii(fontsMath())).getUsedPackage(
1750 ot1, false, false) == "newtxmath";
1751 if ((useNonTeXFonts || use_newtxmath) && !ams.empty())
1752 os << from_ascii(ams);
1754 if (useNonTeXFonts) {
1755 if (!features.isProvided("fontspec"))
1756 os << "\\usepackage{fontspec}\n";
1757 if (features.mustProvide("unicode-math")
1758 && features.isAvailable("unicode-math"))
1759 os << "\\usepackage{unicode-math}\n";
1762 // load CJK support package before font selection
1763 // (see autotests/export/latex/CJK/micro-sign_utf8-cjk-libertine.lyx)
1764 if (!useNonTeXFonts && encoding().package() != Encoding::none && inputenc != "utf8x"
1765 && (encoding().package() == Encoding::CJK || features.mustProvide("CJK"))) {
1766 if (inputenc == "utf8-cjk" || inputenc == "utf8")
1767 os << "\\usepackage{CJKutf8}\n";
1769 os << "\\usepackage[encapsulated]{CJK}\n";
1772 // font selection must be done before loading fontenc.sty
1773 string const fonts = loadFonts(features);
1775 os << from_utf8(fonts);
1777 if (fonts_default_family != "default")
1778 os << "\\renewcommand{\\familydefault}{\\"
1779 << from_ascii(fonts_default_family) << "}\n";
1781 // set font encoding
1782 // non-TeX fonts use font encoding TU (set by fontspec)
1783 if (!useNonTeXFonts && !features.isProvided("fontenc")
1784 && main_font_encoding() != "default") {
1785 // get main font encodings
1786 vector<string> fontencs = font_encodings();
1787 // get font encodings of secondary languages
1788 // FIXME: some languages (hebrew, ...) assume a standard font encoding as last
1789 // option (for text in other languages).
1790 features.getFontEncodings(fontencs);
1791 if (!fontencs.empty()) {
1792 os << "\\usepackage["
1793 << from_ascii(getStringFromVector(fontencs))
1798 // Load textcomp and pmboxdraw before (lua)inputenc (#11454)
1799 if (features.mustProvide("textcomp"))
1800 os << "\\usepackage{textcomp}\n";
1801 if (features.mustProvide("pmboxdraw"))
1802 os << "\\usepackage{pmboxdraw}\n";
1804 // FIXME: In any document containing text in Thai language,
1805 // we must load babel before inputenc (see lib/languages).
1806 // handle inputenc etc.
1807 writeEncodingPreamble(os, features);
1810 if (!features.runparams().includeall && !included_children_.empty()) {
1811 os << "\\includeonly{";
1812 list<string>::const_iterator it = included_children_.begin();
1813 list<string>::const_iterator en = included_children_.end();
1815 for (; it != en; ++it) {
1816 string incfile = *it;
1817 FileName inc = makeAbsPath(incfile, filepath.absFileName());
1818 string mangled = DocFileName(changeExtension(inc.absFileName(), ".tex")).
1820 if (!features.runparams().nice)
1822 // \includeonly doesn't want an extension
1823 incfile = changeExtension(incfile, string());
1824 incfile = support::latex_path(incfile);
1825 if (!incfile.empty()) {
1828 os << from_utf8(incfile);
1835 if (!features.isProvided("geometry")
1836 && (use_geometry || nonstandard_papersize)) {
1837 odocstringstream ods;
1838 if (!getGraphicsDriver("geometry").empty())
1839 ods << getGraphicsDriver("geometry");
1840 if (orientation == ORIENTATION_LANDSCAPE)
1841 ods << ",landscape";
1842 switch (papersize) {
1844 if (!paperwidth.empty())
1845 ods << ",paperwidth="
1846 << from_ascii(paperwidth);
1847 if (!paperheight.empty())
1848 ods << ",paperheight="
1849 << from_ascii(paperheight);
1851 case PAPER_USLETTER:
1852 ods << ",letterpaper";
1855 ods << ",legalpaper";
1857 case PAPER_USEXECUTIVE:
1858 ods << ",executivepaper";
1947 docstring const g_options = trim(ods.str(), ",");
1948 os << "\\usepackage";
1949 if (!g_options.empty())
1950 os << '[' << g_options << ']';
1951 os << "{geometry}\n";
1952 // output this only if use_geometry is true
1954 os << "\\geometry{verbose";
1955 if (!topmargin.empty())
1956 os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1957 if (!bottommargin.empty())
1958 os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1959 if (!leftmargin.empty())
1960 os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1961 if (!rightmargin.empty())
1962 os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1963 if (!headheight.empty())
1964 os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1965 if (!headsep.empty())
1966 os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1967 if (!footskip.empty())
1968 os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1969 if (!columnsep.empty())
1970 os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
1973 } else if (orientation == ORIENTATION_LANDSCAPE
1974 || papersize != PAPER_DEFAULT) {
1975 features.require("papersize");
1978 if (tokenPos(tclass.opt_pagestyle(), '|', pagestyle) >= 0) {
1979 if (pagestyle == "fancy")
1980 os << "\\usepackage{fancyhdr}\n";
1981 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1984 // only output when the background color is not default
1985 if (isbackgroundcolor == true) {
1986 // only require color here, the background color will be defined
1987 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1989 features.require("color");
1990 features.require("pagecolor");
1993 // only output when the font color is not default
1994 if (isfontcolor == true) {
1995 // only require color here, the font color will be defined
1996 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1998 features.require("color");
1999 features.require("fontcolor");
2002 // Only if class has a ToC hierarchy
2003 if (tclass.hasTocLevels()) {
2004 if (secnumdepth != tclass.secnumdepth()) {
2005 os << "\\setcounter{secnumdepth}{"
2009 if (tocdepth != tclass.tocdepth()) {
2010 os << "\\setcounter{tocdepth}{"
2016 if (paragraph_separation) {
2017 // when skip separation
2018 switch (getDefSkip().kind()) {
2019 case VSpace::SMALLSKIP:
2020 os << "\\setlength{\\parskip}{\\smallskipamount}\n";
2022 case VSpace::MEDSKIP:
2023 os << "\\setlength{\\parskip}{\\medskipamount}\n";
2025 case VSpace::BIGSKIP:
2026 os << "\\setlength{\\parskip}{\\bigskipamount}\n";
2028 case VSpace::LENGTH:
2029 os << "\\setlength{\\parskip}{"
2030 << from_utf8(getDefSkip().length().asLatexString())
2033 default: // should never happen // Then delete it.
2034 os << "\\setlength{\\parskip}{\\medskipamount}\n";
2037 os << "\\setlength{\\parindent}{0pt}\n";
2039 // when separation by indentation
2040 // only output something when a width is given
2041 if (!getParIndent().empty()) {
2042 os << "\\setlength{\\parindent}{"
2043 << from_utf8(getParIndent().asLatexString())
2048 if (is_math_indent) {
2049 // when formula indentation
2050 // only output something when it is not the default
2051 if (!getMathIndent().empty()) {
2052 os << "\\setlength{\\mathindent}{"
2053 << from_utf8(getMathIndent().asString())
2058 // Now insert the LyX specific LaTeX commands...
2059 features.resolveAlternatives();
2060 features.expandMultiples();
2063 if (!output_sync_macro.empty())
2064 os << from_utf8(output_sync_macro) +"\n";
2065 else if (features.runparams().flavor == OutputParams::LATEX)
2066 os << "\\usepackage[active]{srcltx}\n";
2067 else if (features.runparams().flavor == OutputParams::PDFLATEX)
2068 os << "\\synctex=-1\n";
2071 // The package options (via \PassOptionsToPackage)
2072 os << from_ascii(features.getPackageOptions());
2074 // due to interferences with babel and hyperref, the color package has to
2075 // be loaded (when it is not already loaded) before babel when hyperref
2076 // is used with the colorlinks option, see
2077 // http://www.lyx.org/trac/ticket/5291
2078 // we decided therefore to load color always before babel, see
2079 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
2080 os << from_ascii(features.getColorOptions());
2082 // If we use hyperref, jurabib, japanese or varioref,
2083 // we have to call babel before
2085 && (features.isRequired("jurabib")
2086 || features.isRequired("hyperref")
2087 || features.isRequired("varioref")
2088 || features.isRequired("japanese"))) {
2089 os << features.getBabelPresettings();
2091 os << from_utf8(babelCall(language_options.str(),
2092 !lyxrc.language_global_options)) + '\n';
2093 os << features.getBabelPostsettings();
2096 // The optional packages;
2097 os << from_ascii(features.getPackages());
2099 // Additional Indices
2100 if (features.isRequired("splitidx")) {
2101 IndicesList::const_iterator iit = indiceslist().begin();
2102 IndicesList::const_iterator iend = indiceslist().end();
2103 for (; iit != iend; ++iit) {
2104 os << "\\newindex{";
2105 os << escape(iit->shortcut());
2111 os << from_utf8(spacing().writePreamble(features.isProvided("SetSpace")));
2114 // * Hyperref manual: "Make sure it comes last of your loaded
2115 // packages, to give it a fighting chance of not being over-written,
2116 // since its job is to redefine many LaTeX commands."
2117 // * Email from Heiko Oberdiek: "It is usually better to load babel
2118 // before hyperref. Then hyperref has a chance to detect babel.
2119 // * Has to be loaded before the "LyX specific LaTeX commands" to
2120 // avoid errors with algorithm floats.
2121 // use hyperref explicitly if it is required
2122 if (features.isRequired("hyperref")) {
2123 OutputParams tmp_params = features.runparams();
2124 pdfoptions().writeLaTeX(tmp_params, os,
2125 features.isProvided("hyperref"));
2126 // correctly break URLs with hyperref and dvi/ps output
2127 if (features.runparams().hyperref_driver == "dvips"
2128 && features.isAvailable("breakurl"))
2129 os << "\\usepackage{breakurl}\n";
2130 } else if (features.isRequired("nameref"))
2131 // hyperref loads this automatically
2132 os << "\\usepackage{nameref}\n";
2134 // bibtopic needs to be loaded after hyperref.
2135 // the dot provides the aux file naming which LyX can detect.
2136 if (features.mustProvide("bibtopic"))
2137 os << "\\usepackage[dot]{bibtopic}\n";
2139 // Will be surrounded by \makeatletter and \makeatother when not empty
2140 otexstringstream atlyxpreamble;
2142 // Some macros LyX will need
2144 TexString tmppreamble = features.getMacros();
2145 if (!tmppreamble.str.empty())
2146 atlyxpreamble << "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2147 "LyX specific LaTeX commands.\n"
2148 << move(tmppreamble)
2151 // the text class specific preamble
2153 docstring tmppreamble = features.getTClassPreamble();
2154 if (!tmppreamble.empty())
2155 atlyxpreamble << "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2156 "Textclass specific LaTeX commands.\n"
2160 // suppress date if selected
2161 // use \@ifundefined because we cannot be sure that every document class
2162 // has a \date command
2164 atlyxpreamble << "\\@ifundefined{date}{}{\\date{}}\n";
2166 /* the user-defined preamble */
2167 if (!containsOnly(preamble, " \n\t")) {
2169 atlyxpreamble << "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2170 "User specified LaTeX commands.\n";
2172 // Check if the user preamble contains uncodable glyphs
2173 odocstringstream user_preamble;
2174 docstring uncodable_glyphs;
2175 Encoding const * const enc = features.runparams().encoding;
2177 for (size_t n = 0; n < preamble.size(); ++n) {
2178 char_type c = preamble[n];
2179 if (!enc->encodable(c)) {
2180 docstring const glyph(1, c);
2181 LYXERR0("Uncodable character '"
2183 << "' in user preamble!");
2184 uncodable_glyphs += glyph;
2185 if (features.runparams().dryrun) {
2186 user_preamble << "<" << _("LyX Warning: ")
2187 << _("uncodable character") << " '";
2188 user_preamble.put(c);
2189 user_preamble << "'>";
2192 user_preamble.put(c);
2195 user_preamble << preamble;
2197 // On BUFFER_VIEW|UPDATE, warn user if we found uncodable glyphs
2198 if (!features.runparams().dryrun && !uncodable_glyphs.empty()) {
2199 frontend::Alert::warning(
2200 _("Uncodable character in user preamble"),
2202 _("The user preamble of your document contains glyphs "
2203 "that are unknown in the current document encoding "
2204 "(namely %1$s).\nThese glyphs are omitted "
2205 " from the output, which may result in "
2206 "incomplete output."
2207 "\n\nPlease select an appropriate "
2208 "document encoding\n"
2209 "(such as utf8) or change the "
2210 "preamble code accordingly."),
2213 atlyxpreamble << user_preamble.str() << '\n';
2216 // footmisc must be loaded after setspace
2217 // Load it here to avoid clashes with footmisc loaded in the user
2218 // preamble. For that reason we also pass the options via
2219 // \PassOptionsToPackage in getPreamble() and not here.
2220 if (features.mustProvide("footmisc"))
2221 atlyxpreamble << "\\usepackage{footmisc}\n";
2223 // subfig loads internally the LaTeX package "caption". As
2224 // caption is a very popular package, users will load it in
2225 // the preamble. Therefore we must load subfig behind the
2226 // user-defined preamble and check if the caption package was
2227 // loaded or not. For the case that caption is loaded before
2228 // subfig, there is the subfig option "caption=false". This
2229 // option also works when a koma-script class is used and
2230 // koma's own caption commands are used instead of caption. We
2231 // use \PassOptionsToPackage here because the user could have
2232 // already loaded subfig in the preamble.
2233 if (features.mustProvide("subfig"))
2234 atlyxpreamble << "\\@ifundefined{showcaptionsetup}{}{%\n"
2235 " \\PassOptionsToPackage{caption=false}{subfig}}\n"
2236 "\\usepackage{subfig}\n";
2238 // Itemize bullet settings need to be last in case the user
2239 // defines their own bullets that use a package included
2240 // in the user-defined preamble -- ARRae
2241 // Actually it has to be done much later than that
2242 // since some packages like frenchb make modifications
2243 // at \begin{document} time -- JMarc
2244 docstring bullets_def;
2245 for (int i = 0; i < 4; ++i) {
2246 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
2247 if (bullets_def.empty())
2248 bullets_def += "\\AtBeginDocument{\n";
2249 bullets_def += " \\def\\labelitemi";
2251 // `i' is one less than the item to modify
2258 bullets_def += "ii";
2264 bullets_def += '{' +
2265 user_defined_bullet(i).getText()
2270 if (!bullets_def.empty())
2271 atlyxpreamble << bullets_def << "}\n\n";
2273 if (!atlyxpreamble.empty())
2274 os << "\n\\makeatletter\n"
2275 << atlyxpreamble.release()
2276 << "\\makeatother\n\n";
2278 // We try to load babel late, in case it interferes with other packages.
2279 // Jurabib, hyperref, varioref, bicaption, menukeys and listings (bug 8995)
2280 // have to be called after babel, though.
2281 if (use_babel && !features.isRequired("jurabib")
2282 && !features.isRequired("hyperref")
2283 && !features.isRequired("varioref")
2284 && !features.isRequired("japanese")) {
2285 os << features.getBabelPresettings();
2287 os << from_utf8(babelCall(language_options.str(),
2288 !lyxrc.language_global_options)) + '\n';
2289 os << features.getBabelPostsettings();
2291 if (features.isRequired("bicaption"))
2292 os << "\\usepackage{bicaption}\n";
2293 if (!listings_params.empty()
2294 || features.mustProvide("listings")
2295 || features.mustProvide("minted")) {
2297 os << "\\usepackage{minted}\n";
2299 os << "\\usepackage{listings}\n";
2301 string lst_params = listings_params;
2302 // If minted, do not output the language option (bug 11203)
2303 if (use_minted && contains(lst_params, "language=")) {
2304 vector<string> opts =
2305 getVectorFromString(lst_params, ",", false);
2306 for (size_t i = 0; i < opts.size(); ++i) {
2307 if (prefixIs(opts[i], "language="))
2308 opts.erase(opts.begin() + i--);
2310 lst_params = getStringFromVector(opts, ",");
2312 if (!lst_params.empty()) {
2314 os << "\\setminted{";
2317 // do not test validity because listings_params is
2318 // supposed to be valid
2320 InsetListingsParams(lst_params).separatedParams(true);
2321 os << from_utf8(par);
2325 // xunicode only needs to be loaded if tipa is used
2326 // (the rest is obsoleted by the new TU encoding).
2327 // It needs to be loaded at least after amsmath, amssymb,
2328 // esint and the other packages that provide special glyphs
2329 if (features.mustProvide("tipa") && useNonTeXFonts
2330 && !features.isProvided("xunicode")) {
2331 // The `xunicode` package officially only supports XeTeX,
2332 // but also works with LuaTeX. We work around its XeTeX test.
2333 if (features.runparams().flavor != OutputParams::XETEX) {
2334 os << "% Pretend to xunicode that we are XeTeX\n"
2335 << "\\def\\XeTeXpicfile{}\n";
2337 os << "\\usepackage{xunicode}\n";
2340 // covington must be loaded after beamerarticle
2341 if (features.isRequired("covington"))
2342 os << "\\usepackage{covington}\n";
2344 // Polyglossia must be loaded last ...
2345 if (use_polyglossia) {
2347 os << "\\usepackage{polyglossia}\n";
2348 // set the main language
2349 os << "\\setdefaultlanguage";
2350 if (!language->polyglossiaOpts().empty())
2351 os << "[" << from_ascii(language->polyglossiaOpts()) << "]";
2352 os << "{" << from_ascii(language->polyglossia()) << "}\n";
2353 // now setup the other languages
2354 set<string> const polylangs =
2355 features.getPolyglossiaLanguages();
2356 for (set<string>::const_iterator mit = polylangs.begin();
2357 mit != polylangs.end() ; ++mit) {
2358 // We do not output the options here; they are output in
2359 // the language switch commands. This is safer if multiple
2360 // varieties are used.
2361 if (*mit == language->polyglossia())
2363 os << "\\setotherlanguage";
2364 os << "{" << from_ascii(*mit) << "}\n";
2368 // ... but before biblatex (see #7065)
2369 if ((features.mustProvide("biblatex")
2370 || features.isRequired("biblatex-chicago"))
2371 && !features.isProvided("biblatex-chicago")
2372 && !features.isProvided("biblatex-natbib")
2373 && !features.isProvided("natbib-internal")
2374 && !features.isProvided("natbib")
2375 && !features.isProvided("jurabib")) {
2376 // The biblatex-chicago package has a differing interface
2377 // it uses a wrapper package and loads styles via fixed options
2378 bool const chicago = features.isRequired("biblatex-chicago");
2381 os << "\\usepackage";
2382 if (!biblatex_bibstyle.empty()
2383 && (biblatex_bibstyle == biblatex_citestyle)
2385 opts = "style=" + biblatex_bibstyle;
2387 } else if (!chicago) {
2388 if (!biblatex_bibstyle.empty()) {
2389 opts = "bibstyle=" + biblatex_bibstyle;
2392 if (!biblatex_citestyle.empty()) {
2393 opts += delim + "citestyle=" + biblatex_citestyle;
2397 if (!multibib.empty() && multibib != "child") {
2398 opts += delim + "refsection=" + multibib;
2401 if (bibtexCommand() == "bibtex8"
2402 || prefixIs(bibtexCommand(), "bibtex8 ")) {
2403 opts += delim + "backend=bibtex8";
2405 } else if (bibtexCommand() == "bibtex"
2406 || prefixIs(bibtexCommand(), "bibtex ")) {
2407 opts += delim + "backend=bibtex";
2410 if (!bib_encoding.empty() && encodings.fromLyXName(bib_encoding)) {
2411 opts += delim + "bibencoding="
2412 + encodings.fromLyXName(bib_encoding)->latexName();
2415 if (!biblio_opts.empty())
2416 opts += delim + biblio_opts;
2418 os << "[" << opts << "]";
2420 os << "{biblatex-chicago}\n";
2422 os << "{biblatex}\n";
2426 // Load custom language package here
2427 if (features.langPackage() == LaTeXFeatures::LANG_PACK_CUSTOM) {
2428 if (lang_package == "default")
2429 os << from_utf8(lyxrc.language_custom_package);
2431 os << from_utf8(lang_package);
2435 // Since menukeys uses catoptions, which does some heavy changes on key-value options,
2436 // it is recommended to load menukeys as the last package (even after hyperref)
2437 if (features.isRequired("menukeys"))
2438 os << "\\usepackage{menukeys}\n";
2440 docstring const i18npreamble =
2441 features.getTClassI18nPreamble(use_babel, use_polyglossia,
2443 if (!i18npreamble.empty())
2444 os << i18npreamble + '\n';
2450 void BufferParams::useClassDefaults()
2452 DocumentClass const & tclass = documentClass();
2454 sides = tclass.sides();
2455 columns = tclass.columns();
2456 pagestyle = tclass.pagestyle();
2457 tablestyle = tclass.tablestyle();
2458 use_default_options = true;
2459 // Only if class has a ToC hierarchy
2460 if (tclass.hasTocLevels()) {
2461 secnumdepth = tclass.secnumdepth();
2462 tocdepth = tclass.tocdepth();
2467 bool BufferParams::hasClassDefaults() const
2469 DocumentClass const & tclass = documentClass();
2471 return sides == tclass.sides()
2472 && columns == tclass.columns()
2473 && pagestyle == tclass.pagestyle()
2474 && tablestyle == tclass.tablestyle()
2475 && use_default_options
2476 && secnumdepth == tclass.secnumdepth()
2477 && tocdepth == tclass.tocdepth();
2481 DocumentClass const & BufferParams::documentClass() const
2487 DocumentClassConstPtr BufferParams::documentClassPtr() const
2493 void BufferParams::setDocumentClass(DocumentClassConstPtr tc)
2495 // evil, but this function is evil
2496 doc_class_ = const_pointer_cast<DocumentClass>(tc);
2497 invalidateConverterCache();
2501 bool BufferParams::setBaseClass(string const & classname, string const & path)
2503 LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
2504 LayoutFileList & bcl = LayoutFileList::get();
2505 if (!bcl.haveClass(classname)) {
2507 bformat(_("The layout file:\n"
2509 "could not be found. A default textclass with default\n"
2510 "layouts will be used. LyX will not be able to produce\n"
2512 from_utf8(classname));
2513 frontend::Alert::error(_("Document class not found"), s);
2514 bcl.addEmptyClass(classname);
2517 bool const success = bcl[classname].load(path);
2520 bformat(_("Due to some error in it, the layout file:\n"
2522 "could not be loaded. A default textclass with default\n"
2523 "layouts will be used. LyX will not be able to produce\n"
2525 from_utf8(classname));
2526 frontend::Alert::error(_("Could not load class"), s);
2527 bcl.addEmptyClass(classname);
2530 pimpl_->baseClass_ = classname;
2531 layout_modules_.adaptToBaseClass(baseClass(), removed_modules_);
2536 LayoutFile const * BufferParams::baseClass() const
2538 if (LayoutFileList::get().haveClass(pimpl_->baseClass_))
2539 return &(LayoutFileList::get()[pimpl_->baseClass_]);
2545 LayoutFileIndex const & BufferParams::baseClassID() const
2547 return pimpl_->baseClass_;
2551 void BufferParams::makeDocumentClass(bool const clone)
2556 invalidateConverterCache();
2557 LayoutModuleList mods;
2558 LayoutModuleList::iterator it = layout_modules_.begin();
2559 LayoutModuleList::iterator en = layout_modules_.end();
2560 for (; it != en; ++it)
2561 mods.push_back(*it);
2563 doc_class_ = getDocumentClass(*baseClass(), mods, cite_engine_, clone);
2565 TextClass::ReturnValues success = TextClass::OK;
2566 if (!forced_local_layout_.empty())
2567 success = doc_class_->read(to_utf8(forced_local_layout_),
2569 if (!local_layout_.empty() &&
2570 (success == TextClass::OK || success == TextClass::OK_OLDFORMAT))
2571 success = doc_class_->read(to_utf8(local_layout_), TextClass::MODULE);
2572 if (success != TextClass::OK && success != TextClass::OK_OLDFORMAT) {
2573 docstring const msg = _("Error reading internal layout information");
2574 frontend::Alert::warning(_("Read Error"), msg);
2579 bool BufferParams::layoutModuleCanBeAdded(string const & modName) const
2581 return layout_modules_.moduleCanBeAdded(modName, baseClass());
2585 docstring BufferParams::getLocalLayout(bool forced) const
2588 return from_utf8(doc_class_->forcedLayouts());
2590 return local_layout_;
2594 void BufferParams::setLocalLayout(docstring const & layout, bool forced)
2597 forced_local_layout_ = layout;
2599 local_layout_ = layout;
2603 bool BufferParams::addLayoutModule(string const & modName)
2605 LayoutModuleList::const_iterator it = layout_modules_.begin();
2606 LayoutModuleList::const_iterator end = layout_modules_.end();
2607 for (; it != end; ++it)
2610 layout_modules_.push_back(modName);
2615 string BufferParams::bufferFormat() const
2617 return documentClass().outputFormat();
2621 bool BufferParams::isExportable(string const & format, bool need_viewable) const
2623 FormatList const & formats = exportableFormats(need_viewable);
2624 FormatList::const_iterator fit = formats.begin();
2625 FormatList::const_iterator end = formats.end();
2626 for (; fit != end ; ++fit) {
2627 if ((*fit)->name() == format)
2634 FormatList const & BufferParams::exportableFormats(bool only_viewable) const
2636 FormatList & cached = only_viewable ?
2637 pimpl_->viewableFormatList : pimpl_->exportableFormatList;
2638 bool & valid = only_viewable ?
2639 pimpl_->isViewCacheValid : pimpl_->isExportCacheValid;
2643 vector<string> const backs = backends();
2644 set<string> excludes;
2645 if (useNonTeXFonts) {
2646 excludes.insert("latex");
2647 excludes.insert("pdflatex");
2648 } else if (inputenc != "ascii" && inputenc != "utf8"
2649 && inputenc != "utf8x" && inputenc != "utf8-plain")
2650 // XeTeX with TeX fonts requires input encoding ascii or utf8
2651 // (https://www.tug.org/pipermail/xetex/2010-April/016452.html).
2652 excludes.insert("xetex");
2653 FormatList result = theConverters().getReachable(backs[0], only_viewable,
2655 for (vector<string>::const_iterator it = backs.begin() + 1;
2656 it != backs.end(); ++it) {
2657 FormatList r = theConverters().getReachable(*it, only_viewable,
2659 result.insert(result.end(), r.begin(), r.end());
2661 sort(result.begin(), result.end(), Format::formatSorter);
2668 vector<string> BufferParams::backends() const
2671 string const buffmt = bufferFormat();
2673 // FIXME: Don't hardcode format names here, but use a flag
2674 if (buffmt == "latex") {
2675 if (encoding().package() == Encoding::japanese)
2676 v.push_back("platex");
2678 if (!useNonTeXFonts) {
2679 v.push_back("pdflatex");
2680 v.push_back("latex");
2682 if (useNonTeXFonts || inputenc == "ascii" || inputenc == "utf8"
2683 || inputenc == "utf8x" || inputenc == "utf8-plain")
2684 v.push_back("xetex");
2685 v.push_back("luatex");
2686 v.push_back("dviluatex");
2689 string rbuffmt = buffmt;
2690 // If we use an OutputFormat in Japanese docs,
2691 // we need special format in order to get the path
2692 // via pLaTeX (#8823)
2693 if (documentClass().hasOutputFormat()
2694 && encoding().package() == Encoding::japanese)
2696 v.push_back(rbuffmt);
2699 v.push_back("xhtml");
2700 v.push_back("text");
2706 OutputParams::FLAVOR BufferParams::getOutputFlavor(string const & format) const
2708 string const dformat = (format.empty() || format == "default") ?
2709 getDefaultOutputFormat() : format;
2710 DefaultFlavorCache::const_iterator it =
2711 default_flavors_.find(dformat);
2713 if (it != default_flavors_.end())
2716 OutputParams::FLAVOR result = OutputParams::LATEX;
2718 // FIXME It'd be better not to hardcode this, but to do
2719 // something with formats.
2720 if (dformat == "xhtml")
2721 result = OutputParams::HTML;
2722 else if (dformat == "text")
2723 result = OutputParams::TEXT;
2724 else if (dformat == "lyx")
2725 result = OutputParams::LYX;
2726 else if (dformat == "pdflatex")
2727 result = OutputParams::PDFLATEX;
2728 else if (dformat == "xetex")
2729 result = OutputParams::XETEX;
2730 else if (dformat == "luatex")
2731 result = OutputParams::LUATEX;
2732 else if (dformat == "dviluatex")
2733 result = OutputParams::DVILUATEX;
2735 // Try to determine flavor of default output format
2736 vector<string> backs = backends();
2737 if (find(backs.begin(), backs.end(), dformat) == backs.end()) {
2738 // Get shortest path to format
2739 Graph::EdgePath path;
2740 for (auto const & bvar : backs) {
2741 Graph::EdgePath p = theConverters().getPath(bvar, dformat);
2742 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2747 result = theConverters().getFlavor(path);
2750 // cache this flavor
2751 default_flavors_[dformat] = result;
2756 string BufferParams::getDefaultOutputFormat() const
2758 if (!default_output_format.empty()
2759 && default_output_format != "default")
2760 return default_output_format;
2762 FormatList const & formats = exportableFormats(true);
2763 if (formats.empty())
2765 // return the first we find
2766 return formats.front()->name();
2768 if (encoding().package() == Encoding::japanese)
2769 return lyxrc.default_platex_view_format;
2771 return lyxrc.default_otf_view_format;
2772 return lyxrc.default_view_format;
2775 Font const BufferParams::getFont() const
2777 FontInfo f = documentClass().defaultfont();
2778 if (fonts_default_family == "rmdefault")
2779 f.setFamily(ROMAN_FAMILY);
2780 else if (fonts_default_family == "sfdefault")
2781 f.setFamily(SANS_FAMILY);
2782 else if (fonts_default_family == "ttdefault")
2783 f.setFamily(TYPEWRITER_FAMILY);
2784 return Font(f, language);
2788 InsetQuotesParams::QuoteStyle BufferParams::getQuoteStyle(string const & qs) const
2790 return quotesstyletranslator().find(qs);
2794 bool BufferParams::isLatex() const
2796 return documentClass().outputType() == LATEX;
2800 bool BufferParams::isLiterate() const
2802 return documentClass().outputType() == LITERATE;
2806 bool BufferParams::isDocBook() const
2808 return documentClass().outputType() == DOCBOOK;
2812 void BufferParams::readPreamble(Lexer & lex)
2814 if (lex.getString() != "\\begin_preamble")
2815 lyxerr << "Error (BufferParams::readPreamble):"
2816 "consistency check failed." << endl;
2818 preamble = lex.getLongString(from_ascii("\\end_preamble"));
2822 void BufferParams::readLocalLayout(Lexer & lex, bool forced)
2824 string const expected = forced ? "\\begin_forced_local_layout" :
2825 "\\begin_local_layout";
2826 if (lex.getString() != expected)
2827 lyxerr << "Error (BufferParams::readLocalLayout):"
2828 "consistency check failed." << endl;
2831 forced_local_layout_ =
2832 lex.getLongString(from_ascii("\\end_forced_local_layout"));
2834 local_layout_ = lex.getLongString(from_ascii("\\end_local_layout"));
2838 bool BufferParams::setLanguage(string const & lang)
2840 Language const *new_language = languages.getLanguage(lang);
2841 if (!new_language) {
2842 // Language lang was not found
2845 language = new_language;
2850 void BufferParams::readLanguage(Lexer & lex)
2852 if (!lex.next()) return;
2854 string const tmptok = lex.getString();
2856 // check if tmptok is part of tex_babel in tex-defs.h
2857 if (!setLanguage(tmptok)) {
2858 // Language tmptok was not found
2859 language = default_language;
2860 lyxerr << "Warning: Setting language `"
2861 << tmptok << "' to `" << language->lang()
2867 void BufferParams::readGraphicsDriver(Lexer & lex)
2872 string const tmptok = lex.getString();
2873 // check if tmptok is part of tex_graphics in tex_defs.h
2876 string const test = tex_graphics[n++];
2878 if (test == tmptok) {
2879 graphics_driver = tmptok;
2884 "Warning: graphics driver `$$Token' not recognized!\n"
2885 " Setting graphics driver to `default'.\n");
2886 graphics_driver = "default";
2893 void BufferParams::readBullets(Lexer & lex)
2898 int const index = lex.getInteger();
2900 int temp_int = lex.getInteger();
2901 user_defined_bullet(index).setFont(temp_int);
2902 temp_bullet(index).setFont(temp_int);
2904 user_defined_bullet(index).setCharacter(temp_int);
2905 temp_bullet(index).setCharacter(temp_int);
2907 user_defined_bullet(index).setSize(temp_int);
2908 temp_bullet(index).setSize(temp_int);
2912 void BufferParams::readBulletsLaTeX(Lexer & lex)
2914 // The bullet class should be able to read this.
2917 int const index = lex.getInteger();
2919 docstring const temp_str = lex.getDocString();
2921 user_defined_bullet(index).setText(temp_str);
2922 temp_bullet(index).setText(temp_str);
2926 void BufferParams::readModules(Lexer & lex)
2928 if (!lex.eatLine()) {
2929 lyxerr << "Error (BufferParams::readModules):"
2930 "Unexpected end of input." << endl;
2934 string mod = lex.getString();
2935 if (mod == "\\end_modules")
2937 addLayoutModule(mod);
2943 void BufferParams::readRemovedModules(Lexer & lex)
2945 if (!lex.eatLine()) {
2946 lyxerr << "Error (BufferParams::readRemovedModules):"
2947 "Unexpected end of input." << endl;
2951 string mod = lex.getString();
2952 if (mod == "\\end_removed_modules")
2954 removed_modules_.push_back(mod);
2957 // now we want to remove any removed modules that were previously
2958 // added. normally, that will be because default modules were added in
2959 // setBaseClass(), which gets called when \textclass is read at the
2960 // start of the read.
2961 list<string>::const_iterator rit = removed_modules_.begin();
2962 list<string>::const_iterator const ren = removed_modules_.end();
2963 for (; rit != ren; ++rit) {
2964 LayoutModuleList::iterator const mit = layout_modules_.begin();
2965 LayoutModuleList::iterator const men = layout_modules_.end();
2966 LayoutModuleList::iterator found = find(mit, men, *rit);
2969 layout_modules_.erase(found);
2974 void BufferParams::readIncludeonly(Lexer & lex)
2976 if (!lex.eatLine()) {
2977 lyxerr << "Error (BufferParams::readIncludeonly):"
2978 "Unexpected end of input." << endl;
2982 string child = lex.getString();
2983 if (child == "\\end_includeonly")
2985 included_children_.push_back(child);
2991 string BufferParams::paperSizeName(PapersizePurpose purpose) const
2993 switch (papersize) {
2995 // could be anything, so don't guess
2997 case PAPER_CUSTOM: {
2998 if (purpose == XDVI && !paperwidth.empty() &&
2999 !paperheight.empty()) {
3000 // heightxwidth<unit>
3001 string first = paperwidth;
3002 string second = paperheight;
3003 if (orientation == ORIENTATION_LANDSCAPE)
3006 return first.erase(first.length() - 2)
3012 // dvips and dvipdfm do not know this
3013 if (purpose == DVIPS || purpose == DVIPDFM)
3017 if (purpose == DVIPS || purpose == DVIPDFM)
3021 if (purpose == DVIPS || purpose == DVIPDFM)
3031 if (purpose == DVIPS || purpose == DVIPDFM)
3035 if (purpose == DVIPS || purpose == DVIPDFM)
3039 if (purpose == DVIPS || purpose == DVIPDFM)
3043 if (purpose == DVIPS || purpose == DVIPDFM)
3047 if (purpose == DVIPS || purpose == DVIPDFM)
3051 // dvipdfm does not know this
3052 if (purpose == DVIPDFM)
3056 if (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)
3080 if (purpose == DVIPS || purpose == DVIPDFM)
3084 if (purpose == DVIPS || purpose == DVIPDFM)
3088 if (purpose == DVIPS || purpose == DVIPDFM)
3092 if (purpose == DVIPS || purpose == DVIPDFM)
3096 if (purpose == DVIPS || purpose == DVIPDFM)
3100 if (purpose == DVIPS || purpose == DVIPDFM)
3104 if (purpose == DVIPS || purpose == DVIPDFM)
3108 if (purpose == DVIPS || purpose == DVIPDFM)
3112 if (purpose == DVIPS || purpose == DVIPDFM)
3116 if (purpose == DVIPS || purpose == DVIPDFM)
3119 case PAPER_USEXECUTIVE:
3120 // dvipdfm does not know this
3121 if (purpose == DVIPDFM)
3126 case PAPER_USLETTER:
3128 if (purpose == XDVI)
3135 string const BufferParams::dvips_options() const
3139 // If the class loads the geometry package, we do not know which
3140 // paper size is used, since we do not set it (bug 7013).
3141 // Therefore we must not specify any argument here.
3142 // dvips gets the correct paper size via DVI specials in this case
3143 // (if the class uses the geometry package correctly).
3144 if (documentClass().provides("geometry"))
3148 && papersize == PAPER_CUSTOM
3149 && !lyxrc.print_paper_dimension_flag.empty()
3150 && !paperwidth.empty()
3151 && !paperheight.empty()) {
3152 // using a custom papersize
3153 result = lyxrc.print_paper_dimension_flag;
3154 result += ' ' + paperwidth;
3155 result += ',' + paperheight;
3157 string const paper_option = paperSizeName(DVIPS);
3158 if (!paper_option.empty() && (paper_option != "letter" ||
3159 orientation != ORIENTATION_LANDSCAPE)) {
3160 // dvips won't accept -t letter -t landscape.
3161 // In all other cases, include the paper size
3163 result = lyxrc.print_paper_flag;
3164 result += ' ' + paper_option;
3167 if (orientation == ORIENTATION_LANDSCAPE &&
3168 papersize != PAPER_CUSTOM)
3169 result += ' ' + lyxrc.print_landscape_flag;
3174 string const BufferParams::main_font_encoding() const
3176 if (font_encodings().empty()) {
3177 if (ascii_lowercase(language->fontenc(*this)) == "none")
3181 return font_encodings().back();
3185 vector<string> const BufferParams::font_encodings() const
3187 string doc_fontenc = (fontenc == "auto") ? string() : fontenc;
3189 vector<string> fontencs;
3191 // "default" means "no explicit font encoding"
3192 if (doc_fontenc != "default") {
3193 if (!doc_fontenc.empty())
3194 // If we have a custom setting, we use only that!
3195 return getVectorFromString(doc_fontenc);
3196 if (!language->fontenc(*this).empty()
3197 && ascii_lowercase(language->fontenc(*this)) != "none") {
3198 vector<string> fencs = getVectorFromString(language->fontenc(*this));
3199 for (auto & fe : fencs) {
3200 if (find(fontencs.begin(), fontencs.end(), fe) == fontencs.end())
3201 fontencs.push_back(fe);
3210 string BufferParams::babelCall(string const & lang_opts, bool const langoptions) const
3212 // suppress the babel call if there is no BabelName defined
3213 // for the document language in the lib/languages file and if no
3214 // other languages are used (lang_opts is then empty)
3215 if (lang_opts.empty())
3217 // The prefs may require the languages to
3218 // be submitted to babel itself (not the class).
3220 return "\\usepackage[" + lang_opts + "]{babel}";
3221 return "\\usepackage{babel}";
3225 docstring BufferParams::getGraphicsDriver(string const & package) const
3229 if (package == "geometry") {
3230 if (graphics_driver == "dvips"
3231 || graphics_driver == "dvipdfm"
3232 || graphics_driver == "pdftex"
3233 || graphics_driver == "vtex")
3234 result = from_ascii(graphics_driver);
3235 else if (graphics_driver == "dvipdfmx")
3236 result = from_ascii("dvipdfm");
3243 void BufferParams::writeEncodingPreamble(otexstream & os,
3244 LaTeXFeatures & features) const
3246 // With no-TeX fonts we use utf8-plain without encoding package.
3250 if (inputenc == "auto-legacy") {
3251 string const doc_encoding =
3252 language->encoding()->latexName();
3253 Encoding::Package const package =
3254 language->encoding()->package();
3256 // Create list of inputenc options:
3257 set<string> encoding_set;
3258 // luainputenc fails with more than one encoding
3259 if (features.runparams().flavor != OutputParams::LUATEX
3260 && features.runparams().flavor != OutputParams::DVILUATEX)
3261 // list all input encodings used in the document
3262 encoding_set = features.getEncodingSet(doc_encoding);
3264 // The "japanese" babel-language requires the pLaTeX engine
3265 // which conflicts with "inputenc".
3266 // See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
3267 if ((!encoding_set.empty() || package == Encoding::inputenc)
3268 && !features.isRequired("japanese")
3269 && !features.isProvided("inputenc")) {
3270 os << "\\usepackage[";
3271 set<string>::const_iterator it = encoding_set.begin();
3272 set<string>::const_iterator const end = encoding_set.end();
3274 os << from_ascii(*it);
3277 for (; it != end; ++it)
3278 os << ',' << from_ascii(*it);
3279 if (package == Encoding::inputenc) {
3280 if (!encoding_set.empty())
3282 os << from_ascii(doc_encoding);
3284 if (features.runparams().flavor == OutputParams::LUATEX
3285 || features.runparams().flavor == OutputParams::DVILUATEX)
3286 os << "]{luainputenc}\n";
3288 os << "]{inputenc}\n";
3290 } else if (inputenc != "auto-legacy-plain") {
3291 switch (encoding().package()) {
3292 case Encoding::none:
3294 case Encoding::japanese:
3295 if (encoding().iconvName() != "UTF-8"
3296 && !features.runparams().isFullUnicode())
3297 // don't default to [utf8]{inputenc} with TeXLive >= 18
3298 os << "\\ifdefined\\UseRawInputEncoding\n"
3299 << " \\UseRawInputEncoding\\fi\n";
3301 case Encoding::inputenc:
3302 // do not load inputenc if japanese is used
3303 // or if the class provides inputenc
3304 if (features.isRequired("japanese")
3305 || features.isProvided("inputenc"))
3307 if (features.runparams().flavor == OutputParams::XETEX)
3308 os << xetex_pre_inputenc;
3309 os << "\\usepackage[" << from_ascii(encoding().latexName());
3310 if (features.runparams().flavor == OutputParams::LUATEX
3311 || features.runparams().flavor == OutputParams::DVILUATEX)
3312 os << "]{luainputenc}\n";
3314 os << "]{inputenc}\n";
3315 if (features.runparams().flavor == OutputParams::XETEX)
3316 os << xetex_post_inputenc;
3320 if (inputenc == "auto-legacy-plain" || features.isRequired("japanese")) {
3321 // don't default to [utf8]{inputenc} with TeXLive >= 18
3322 os << "\\ifdefined\\UseRawInputEncoding\n";
3323 os << " \\UseRawInputEncoding\\fi\n";
3328 string const BufferParams::parseFontName(string const & name) const
3330 string mangled = name;
3331 size_t const idx = mangled.find('[');
3332 if (idx == string::npos || idx == 0)
3335 return mangled.substr(0, idx - 1);
3339 string const BufferParams::loadFonts(LaTeXFeatures & features) const
3341 if (fontsRoman() == "default" && fontsSans() == "default"
3342 && fontsTypewriter() == "default"
3343 && (fontsMath() == "default" || fontsMath() == "auto"))
3349 /* Fontspec (XeTeX, LuaTeX): we provide GUI support for oldstyle
3350 * numbers (Numbers=OldStyle) and sf/tt scaling. The Ligatures=TeX/
3351 * Mapping=tex-text option assures TeX ligatures (such as "--")
3352 * are resolved. Note that tt does not use these ligatures.
3354 * -- add more GUI options?
3355 * -- add more fonts (fonts for other scripts)
3356 * -- if there's a way to find out if a font really supports
3357 * OldStyle, enable/disable the widget accordingly.
3359 if (useNonTeXFonts && features.isAvailable("fontspec")) {
3360 // "Mapping=tex-text" and "Ligatures=TeX" are equivalent.
3361 // However, until v.2 (2010/07/11) fontspec only knew
3362 // Mapping=tex-text (for XeTeX only); then "Ligatures=TeX"
3363 // was introduced for both XeTeX and LuaTeX (LuaTeX
3364 // didn't understand "Mapping=tex-text", while XeTeX
3365 // understood both. With most recent versions, both
3366 // variants are understood by both engines. However,
3367 // we want to provide support for at least TeXLive 2009
3368 // (for XeTeX; LuaTeX is only supported as of v.2)
3369 string const texmapping =
3370 (features.runparams().flavor == OutputParams::XETEX) ?
3371 "Mapping=tex-text" : "Ligatures=TeX";
3372 if (fontsRoman() != "default") {
3373 os << "\\setmainfont[" << texmapping;
3374 if (fonts_old_figures)
3375 os << ",Numbers=OldStyle";
3376 os << "]{" << parseFontName(fontsRoman()) << "}\n";
3378 if (fontsSans() != "default") {
3379 string const sans = parseFontName(fontsSans());
3380 if (fontsSansScale() != 100)
3381 os << "\\setsansfont[Scale="
3382 << float(fontsSansScale()) / 100
3383 << "," << texmapping << "]{"
3386 os << "\\setsansfont[" << texmapping << "]{"
3389 if (fontsTypewriter() != "default") {
3390 string const mono = parseFontName(fontsTypewriter());
3391 if (fontsTypewriterScale() != 100)
3392 os << "\\setmonofont[Scale="
3393 << float(fontsTypewriterScale()) / 100
3397 os << "\\setmonofont{"
3404 bool const ot1 = (main_font_encoding() == "default" || main_font_encoding() == "OT1");
3405 bool const dryrun = features.runparams().dryrun;
3406 bool const complete = (fontsSans() == "default" && fontsTypewriter() == "default");
3407 bool const nomath = (fontsMath() == "default");
3410 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsRoman())).getLaTeXCode(
3411 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3415 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsSans())).getLaTeXCode(
3416 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3417 nomath, fontsSansScale());
3419 // MONOSPACED/TYPEWRITER
3420 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsTypewriter())).getLaTeXCode(
3421 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3422 nomath, fontsTypewriterScale());
3425 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsMath())).getLaTeXCode(
3426 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3433 Encoding const & BufferParams::encoding() const
3435 // Main encoding for LaTeX output.
3437 return *(encodings.fromLyXName("utf8-plain"));
3438 if (inputenc == "auto-legacy" || inputenc == "auto-legacy-plain")
3439 return *language->encoding();
3440 if (inputenc == "utf8" && language->lang() == "japanese")
3441 return *(encodings.fromLyXName("utf8-platex"));
3442 Encoding const * const enc = encodings.fromLyXName(inputenc);
3445 LYXERR0("Unknown inputenc value `" << inputenc
3446 << "'. Using `auto' instead.");
3447 return *language->encoding();
3451 string const & BufferParams::defaultBiblioStyle() const
3453 if (!biblio_style.empty())
3454 return biblio_style;
3456 map<string, string> const & bs = documentClass().defaultBiblioStyle();
3457 auto cit = bs.find(theCiteEnginesList.getTypeAsString(citeEngineType()));
3458 if (cit != bs.end())
3461 return empty_string();
3465 bool const & BufferParams::fullAuthorList() const
3467 return documentClass().fullAuthorList();
3471 string BufferParams::getCiteAlias(string const & s) const
3473 vector<string> commands =
3474 documentClass().citeCommands(citeEngineType());
3475 // If it is a real command, don't treat it as an alias
3476 if (find(commands.begin(), commands.end(), s) != commands.end())
3478 map<string,string> aliases = documentClass().citeCommandAliases();
3479 if (aliases.find(s) != aliases.end())
3485 vector<string> BufferParams::citeCommands() const
3487 static CitationStyle const default_style;
3488 vector<string> commands =
3489 documentClass().citeCommands(citeEngineType());
3490 if (commands.empty())
3491 commands.push_back(default_style.name);
3496 vector<CitationStyle> BufferParams::citeStyles() const
3498 static CitationStyle const default_style;
3499 vector<CitationStyle> styles =
3500 documentClass().citeStyles(citeEngineType());
3502 styles.push_back(default_style);
3507 string const BufferParams::bibtexCommand() const
3509 // Return document-specific setting if available
3510 if (bibtex_command != "default")
3511 return bibtex_command;
3513 // If we have "default" in document settings, consult the prefs
3514 // 1. Japanese (uses a specific processor)
3515 if (encoding().package() == Encoding::japanese) {
3516 if (lyxrc.jbibtex_command != "automatic")
3517 // Return the specified program, if "automatic" is not set
3518 return lyxrc.jbibtex_command;
3519 else if (!useBiblatex()) {
3520 // With classic BibTeX, return pbibtex, jbibtex, bibtex
3521 if (lyxrc.jbibtex_alternatives.find("pbibtex") != lyxrc.jbibtex_alternatives.end())
3523 if (lyxrc.jbibtex_alternatives.find("jbibtex") != lyxrc.jbibtex_alternatives.end())
3528 // 2. All other languages
3529 else if (lyxrc.bibtex_command != "automatic")
3530 // Return the specified program, if "automatic" is not set
3531 return lyxrc.bibtex_command;
3533 // 3. Automatic: find the most suitable for the current cite framework
3534 if (useBiblatex()) {
3535 // For Biblatex, we prefer biber (also for Japanese)
3536 // and fall back to bibtex8 and, as last resort, bibtex
3537 if (lyxrc.bibtex_alternatives.find("biber") != lyxrc.bibtex_alternatives.end())
3539 else if (lyxrc.bibtex_alternatives.find("bibtex8") != lyxrc.bibtex_alternatives.end())
3546 bool BufferParams::useBiblatex() const
3548 return theCiteEnginesList[citeEngine()]->getCiteFramework() == "biblatex";
3552 void BufferParams::invalidateConverterCache() const
3554 pimpl_->isExportCacheValid = false;
3555 pimpl_->isViewCacheValid = false;
3559 // We shouldn't need to reset the params here, since anything
3560 // we need will be recopied.
3561 void BufferParams::copyForAdvFR(const BufferParams & bp)
3563 string const & lang = bp.language->lang();
3565 layout_modules_ = bp.layout_modules_;
3566 string const & doc_class = bp.documentClass().name();
3567 setBaseClass(doc_class);
3571 void BufferParams::setBibFileEncoding(string const & file, string const & enc)
3573 bib_encodings[file] = enc;
3577 string const BufferParams::bibFileEncoding(string const & file) const
3579 if (bib_encodings.find(file) == bib_encodings.end())
3581 return bib_encodings.find(file)->second;