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",
111 // Paragraph separation
112 typedef Translator<string, BufferParams::ParagraphSeparation> ParSepTranslator;
115 ParSepTranslator const init_parseptranslator()
117 ParSepTranslator translator
118 (string_paragraph_separation[0], BufferParams::ParagraphIndentSeparation);
119 translator.addPair(string_paragraph_separation[1], BufferParams::ParagraphSkipSeparation);
124 ParSepTranslator const & parseptranslator()
126 static ParSepTranslator const translator =
127 init_parseptranslator();
133 typedef Translator<string, InsetQuotesParams::QuoteStyle> QuotesStyleTranslator;
136 QuotesStyleTranslator const init_quotesstyletranslator()
138 QuotesStyleTranslator translator
139 (string_quotes_style[0], InsetQuotesParams::EnglishQuotes);
140 translator.addPair(string_quotes_style[1], InsetQuotesParams::SwedishQuotes);
141 translator.addPair(string_quotes_style[2], InsetQuotesParams::GermanQuotes);
142 translator.addPair(string_quotes_style[3], InsetQuotesParams::PolishQuotes);
143 translator.addPair(string_quotes_style[4], InsetQuotesParams::SwissQuotes);
144 translator.addPair(string_quotes_style[5], InsetQuotesParams::DanishQuotes);
145 translator.addPair(string_quotes_style[6], InsetQuotesParams::PlainQuotes);
146 translator.addPair(string_quotes_style[7], InsetQuotesParams::BritishQuotes);
147 translator.addPair(string_quotes_style[8], InsetQuotesParams::SwedishGQuotes);
148 translator.addPair(string_quotes_style[9], InsetQuotesParams::FrenchQuotes);
149 translator.addPair(string_quotes_style[10], InsetQuotesParams::FrenchINQuotes);
150 translator.addPair(string_quotes_style[11], InsetQuotesParams::RussianQuotes);
151 translator.addPair(string_quotes_style[12], InsetQuotesParams::CJKQuotes);
152 translator.addPair(string_quotes_style[13], InsetQuotesParams::CJKAngleQuotes);
157 QuotesStyleTranslator const & quotesstyletranslator()
159 static QuotesStyleTranslator const translator =
160 init_quotesstyletranslator();
166 typedef Translator<string, PAPER_SIZE> PaperSizeTranslator;
169 static PaperSizeTranslator initPaperSizeTranslator()
171 PaperSizeTranslator translator(string_papersize[0], PAPER_DEFAULT);
172 translator.addPair(string_papersize[1], PAPER_CUSTOM);
173 translator.addPair(string_papersize[2], PAPER_USLETTER);
174 translator.addPair(string_papersize[3], PAPER_USLEGAL);
175 translator.addPair(string_papersize[4], PAPER_USEXECUTIVE);
176 translator.addPair(string_papersize[5], PAPER_A0);
177 translator.addPair(string_papersize[6], PAPER_A1);
178 translator.addPair(string_papersize[7], PAPER_A2);
179 translator.addPair(string_papersize[8], PAPER_A3);
180 translator.addPair(string_papersize[9], PAPER_A4);
181 translator.addPair(string_papersize[10], PAPER_A5);
182 translator.addPair(string_papersize[11], PAPER_A6);
183 translator.addPair(string_papersize[12], PAPER_B0);
184 translator.addPair(string_papersize[13], PAPER_B1);
185 translator.addPair(string_papersize[14], PAPER_B2);
186 translator.addPair(string_papersize[15], PAPER_B3);
187 translator.addPair(string_papersize[16], PAPER_B4);
188 translator.addPair(string_papersize[17], PAPER_B5);
189 translator.addPair(string_papersize[18], PAPER_B6);
190 translator.addPair(string_papersize[19], PAPER_C0);
191 translator.addPair(string_papersize[20], PAPER_C1);
192 translator.addPair(string_papersize[21], PAPER_C2);
193 translator.addPair(string_papersize[22], PAPER_C3);
194 translator.addPair(string_papersize[23], PAPER_C4);
195 translator.addPair(string_papersize[24], PAPER_C5);
196 translator.addPair(string_papersize[25], PAPER_C6);
197 translator.addPair(string_papersize[26], PAPER_JISB0);
198 translator.addPair(string_papersize[27], PAPER_JISB1);
199 translator.addPair(string_papersize[28], PAPER_JISB2);
200 translator.addPair(string_papersize[29], PAPER_JISB3);
201 translator.addPair(string_papersize[30], PAPER_JISB4);
202 translator.addPair(string_papersize[31], PAPER_JISB5);
203 translator.addPair(string_papersize[32], PAPER_JISB6);
208 PaperSizeTranslator const & papersizetranslator()
210 static PaperSizeTranslator const translator =
211 initPaperSizeTranslator();
217 typedef Translator<string, PAPER_ORIENTATION> PaperOrientationTranslator;
220 PaperOrientationTranslator const init_paperorientationtranslator()
222 PaperOrientationTranslator translator(string_orientation[0], ORIENTATION_PORTRAIT);
223 translator.addPair(string_orientation[1], ORIENTATION_LANDSCAPE);
228 PaperOrientationTranslator const & paperorientationtranslator()
230 static PaperOrientationTranslator const translator =
231 init_paperorientationtranslator();
237 typedef Translator<int, PageSides> SidesTranslator;
240 SidesTranslator const init_sidestranslator()
242 SidesTranslator translator(1, OneSide);
243 translator.addPair(2, TwoSides);
248 SidesTranslator const & sidestranslator()
250 static SidesTranslator const translator = init_sidestranslator();
256 typedef Translator<int, BufferParams::Package> PackageTranslator;
259 PackageTranslator const init_packagetranslator()
261 PackageTranslator translator(0, BufferParams::package_off);
262 translator.addPair(1, BufferParams::package_auto);
263 translator.addPair(2, BufferParams::package_on);
268 PackageTranslator const & packagetranslator()
270 static PackageTranslator const translator =
271 init_packagetranslator();
277 typedef Translator<string, Spacing::Space> SpaceTranslator;
280 SpaceTranslator const init_spacetranslator()
282 SpaceTranslator translator("default", Spacing::Default);
283 translator.addPair("single", Spacing::Single);
284 translator.addPair("onehalf", Spacing::Onehalf);
285 translator.addPair("double", Spacing::Double);
286 translator.addPair("other", Spacing::Other);
291 SpaceTranslator const & spacetranslator()
293 static SpaceTranslator const translator = init_spacetranslator();
298 bool inSystemDir(FileName const & document_dir, string & system_dir)
300 // A document is assumed to be in a system LyX directory (not
301 // necessarily the system directory of the running instance)
302 // if both "configure.py" and "chkconfig.ltx" are found in
303 // either document_dir/../ or document_dir/../../.
304 // If true, the system directory path is returned in system_dir
305 // with a trailing path separator.
307 string const msg = "Checking whether document is in a system dir...";
309 string dir = document_dir.absFileName();
311 for (int i = 0; i < 2; ++i) {
312 dir = addPath(dir, "..");
313 if (!fileSearch(dir, "configure.py").empty() &&
314 !fileSearch(dir, "chkconfig.ltx").empty()) {
315 LYXERR(Debug::FILES, msg << " yes");
316 system_dir = addPath(FileName(dir).realPath(), "");
321 LYXERR(Debug::FILES, msg << " no");
322 system_dir = string();
329 class BufferParams::Impl
334 AuthorList authorlist;
335 BranchList branchlist;
336 Bullet temp_bullets[4];
337 Bullet user_defined_bullets[4];
338 IndicesList indiceslist;
342 /** This is the amount of space used for paragraph_separation "skip",
343 * and for detached paragraphs in "indented" documents.
346 PDFOptions pdfoptions;
347 LayoutFileIndex baseClass_;
348 FormatList exportableFormatList;
349 FormatList viewableFormatList;
350 bool isViewCacheValid;
351 bool isExportCacheValid;
355 BufferParams::Impl::Impl()
356 : defskip(VSpace::MEDSKIP), baseClass_(string("")),
357 isViewCacheValid(false), isExportCacheValid(false)
359 // set initial author
361 authorlist.record(Author(from_utf8(lyxrc.user_name), from_utf8(lyxrc.user_email)));
366 BufferParams::MemoryTraits::clone(BufferParams::Impl const * ptr)
369 return new BufferParams::Impl(*ptr);
373 void BufferParams::MemoryTraits::destroy(BufferParams::Impl * ptr)
379 BufferParams::BufferParams()
382 setBaseClass(defaultBaseclass());
383 cite_engine_ = "basic";
384 cite_engine_type_ = ENGINE_TYPE_DEFAULT;
386 paragraph_separation = ParagraphIndentSeparation;
387 is_math_indent = false;
388 math_numbering_side = DEFAULT;
389 quotes_style = InsetQuotesParams::EnglishQuotes;
390 dynamic_quotes = false;
391 fontsize = "default";
394 papersize = PAPER_DEFAULT;
395 orientation = ORIENTATION_PORTRAIT;
396 use_geometry = false;
397 biblio_style = string();
398 use_bibtopic = false;
401 save_transient_properties = true;
402 track_changes = false;
403 output_changes = false;
404 use_default_options = true;
405 maintain_unincluded_children = false;
408 language = default_language;
410 fonts_roman[0] = "default";
411 fonts_roman[1] = "default";
412 fonts_sans[0] = "default";
413 fonts_sans[1] = "default";
414 fonts_typewriter[0] = "default";
415 fonts_typewriter[1] = "default";
416 fonts_math[0] = "auto";
417 fonts_math[1] = "auto";
418 fonts_default_family = "default";
419 useNonTeXFonts = false;
420 use_microtype = false;
421 use_dash_ligatures = true;
422 fonts_expert_sc = false;
423 fonts_old_figures = false;
424 fonts_sans_scale[0] = 100;
425 fonts_sans_scale[1] = 100;
426 fonts_typewriter_scale[0] = 100;
427 fonts_typewriter_scale[1] = 100;
429 lang_package = "default";
430 graphics_driver = "default";
431 default_output_format = "default";
432 bibtex_command = "default";
433 index_command = "default";
436 listings_params = string();
437 pagestyle = "default";
438 suppress_date = false;
439 justification = true;
440 // no color is the default (white)
441 backgroundcolor = lyx::rgbFromHexName("#ffffff");
442 isbackgroundcolor = false;
443 // no color is the default (black)
444 fontcolor = lyx::rgbFromHexName("#000000");
446 // light gray is the default font color for greyed-out notes
447 notefontcolor = lyx::rgbFromHexName("#cccccc");
448 boxbgcolor = lyx::rgbFromHexName("#ff0000");
449 compressed = lyxrc.save_compressed;
450 for (int iter = 0; iter < 4; ++iter) {
451 user_defined_bullet(iter) = ITEMIZE_DEFAULTS[iter];
452 temp_bullet(iter) = ITEMIZE_DEFAULTS[iter];
455 indiceslist().addDefault(B_("Index"));
456 html_be_strict = false;
457 html_math_output = MathML;
458 html_math_img_scale = 1.0;
459 html_css_as_file = false;
460 display_pixel_ratio = 1.0;
462 shell_escape = false;
467 // map current author
468 author_map_[pimpl_->authorlist.get(0).bufferId()] = 0;
472 docstring BufferParams::B_(string const & l10n) const
474 LASSERT(language, return from_utf8(l10n));
475 return getMessages(language->code()).get(l10n);
479 BufferParams::Package BufferParams::use_package(std::string const & p) const
481 PackageMap::const_iterator it = use_packages.find(p);
482 if (it == use_packages.end())
488 void BufferParams::use_package(std::string const & p, BufferParams::Package u)
494 map<string, string> const & BufferParams::auto_packages()
496 static map<string, string> packages;
497 if (packages.empty()) {
498 // We could have a race condition here that two threads
499 // discover an empty map at the same time and want to fill
500 // it, but that is no problem, since the same contents is
501 // filled in twice then. Having the locker inside the
502 // packages.empty() condition has the advantage that we
503 // don't need the mutex overhead for simple reading.
505 Mutex::Locker locker(&mutex);
506 // adding a package here implies a file format change!
507 packages["amsmath"] =
508 N_("The LaTeX package amsmath is only used if AMS formula types or symbols from the AMS math toolbars are inserted into formulas");
509 packages["amssymb"] =
510 N_("The LaTeX package amssymb is only used if symbols from the AMS math toolbars are inserted into formulas");
512 N_("The LaTeX package cancel is only used if \\cancel commands are used in formulas");
514 N_("The LaTeX package esint is only used if special integral symbols are inserted into formulas");
515 packages["mathdots"] =
516 N_("The LaTeX package mathdots is only used if the command \\iddots is inserted into formulas");
517 packages["mathtools"] =
518 N_("The LaTeX package mathtools is only used if some mathematical relations are inserted into formulas");
520 N_("The LaTeX package mhchem is only used if either the command \\ce or \\cf is inserted into formulas");
521 packages["stackrel"] =
522 N_("The LaTeX package stackrel is only used if the command \\stackrel with subscript is inserted into formulas");
523 packages["stmaryrd"] =
524 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");
525 packages["undertilde"] =
526 N_("The LaTeX package undertilde is only used if you use the math frame decoration 'utilde'");
532 bool BufferParams::useBibtopic() const
536 return (use_bibtopic || (!multibib.empty() && multibib != "child"));
540 AuthorList & BufferParams::authors()
542 return pimpl_->authorlist;
546 AuthorList const & BufferParams::authors() const
548 return pimpl_->authorlist;
552 void BufferParams::addAuthor(Author a)
554 author_map_[a.bufferId()] = pimpl_->authorlist.record(a);
558 BranchList & BufferParams::branchlist()
560 return pimpl_->branchlist;
564 BranchList const & BufferParams::branchlist() const
566 return pimpl_->branchlist;
570 IndicesList & BufferParams::indiceslist()
572 return pimpl_->indiceslist;
576 IndicesList const & BufferParams::indiceslist() const
578 return pimpl_->indiceslist;
582 Bullet & BufferParams::temp_bullet(lyx::size_type const index)
584 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
585 return pimpl_->temp_bullets[index];
589 Bullet const & BufferParams::temp_bullet(lyx::size_type const index) const
591 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
592 return pimpl_->temp_bullets[index];
596 Bullet & BufferParams::user_defined_bullet(lyx::size_type const index)
598 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
599 return pimpl_->user_defined_bullets[index];
603 Bullet const & BufferParams::user_defined_bullet(lyx::size_type const index) const
605 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
606 return pimpl_->user_defined_bullets[index];
610 Spacing & BufferParams::spacing()
612 return pimpl_->spacing;
616 Spacing const & BufferParams::spacing() const
618 return pimpl_->spacing;
622 PDFOptions & BufferParams::pdfoptions()
624 return pimpl_->pdfoptions;
628 PDFOptions const & BufferParams::pdfoptions() const
630 return pimpl_->pdfoptions;
634 Length const & BufferParams::getMathIndent() const
636 return pimpl_->mathindent;
640 void BufferParams::setMathIndent(Length const & indent)
642 pimpl_->mathindent = indent;
646 Length const & BufferParams::getParIndent() const
648 return pimpl_->parindent;
652 void BufferParams::setParIndent(Length const & indent)
654 pimpl_->parindent = indent;
658 VSpace const & BufferParams::getDefSkip() const
660 return pimpl_->defskip;
664 void BufferParams::setDefSkip(VSpace const & vs)
666 // DEFSKIP will cause an infinite loop
667 LASSERT(vs.kind() != VSpace::DEFSKIP, return);
668 pimpl_->defskip = vs;
672 BufferParams::MathNumber BufferParams::getMathNumber() const
674 if (math_numbering_side != DEFAULT)
675 return math_numbering_side;
676 // FIXME: do not hardcode language here
677 else if (language->lang() == "arabic_arabi"
678 || documentClass().provides("leqno"))
685 string BufferParams::readToken(Lexer & lex, string const & token,
686 FileName const & filepath)
690 if (token == "\\textclass") {
692 string const classname = lex.getString();
693 // if there exists a local layout file, ignore the system one
694 // NOTE: in this case, the textclass (.cls file) is assumed to
697 LayoutFileList & bcl = LayoutFileList::get();
698 if (!filepath.empty()) {
699 // If classname is an absolute path, the document is
700 // using a local layout file which could not be accessed
701 // by a relative path. In this case the path is correct
702 // even if the document was moved to a different
703 // location. However, we will have a problem if the
704 // document was generated on a different platform.
705 bool isabsolute = FileName::isAbsolute(classname);
706 string const classpath = onlyPath(classname);
707 string const path = isabsolute ? classpath
708 : FileName(addPath(filepath.absFileName(),
709 classpath)).realPath();
710 string const oldpath = isabsolute ? string()
711 : FileName(addPath(origin, classpath)).realPath();
712 tcp = bcl.addLocalLayout(onlyFileName(classname), path, oldpath);
714 // that returns non-empty if a "local" layout file is found.
716 result = to_utf8(makeRelPath(from_utf8(onlyPath(tcp)),
717 from_utf8(filepath.absFileName())));
720 setBaseClass(onlyFileName(tcp));
722 setBaseClass(onlyFileName(classname));
723 // We assume that a tex class exists for local or unknown
724 // layouts so this warning, will only be given for system layouts.
725 if (!baseClass()->isTeXClassAvailable()) {
726 docstring const desc =
727 translateIfPossible(from_utf8(baseClass()->description()));
728 docstring const prereqs =
729 from_utf8(baseClass()->prerequisites());
730 docstring const msg =
731 bformat(_("The selected document class\n"
733 "requires external files that are not available.\n"
734 "The document class can still be used, but the\n"
735 "document cannot be compiled until the following\n"
736 "prerequisites are installed:\n"
738 "See section 3.1.2.2 (Class Availability) of the\n"
739 "User's Guide for more information."), desc, prereqs);
740 frontend::Alert::warning(_("Document class not available"),
743 } else if (token == "\\save_transient_properties") {
744 lex >> save_transient_properties;
745 } else if (token == "\\origin") {
747 origin = lex.getString();
748 string const sysdirprefix = "/systemlyxdir/";
749 if (prefixIs(origin, sysdirprefix)) {
751 if (inSystemDir(filepath, docsys))
752 origin.replace(0, sysdirprefix.length() - 1, docsys);
754 origin.replace(0, sysdirprefix.length() - 1,
755 package().system_support().absFileName());
757 } else if (token == "\\begin_preamble") {
759 } else if (token == "\\begin_local_layout") {
760 readLocalLayout(lex, false);
761 } else if (token == "\\begin_forced_local_layout") {
762 readLocalLayout(lex, true);
763 } else if (token == "\\begin_modules") {
765 } else if (token == "\\begin_removed_modules") {
766 readRemovedModules(lex);
767 } else if (token == "\\begin_includeonly") {
768 readIncludeonly(lex);
769 } else if (token == "\\maintain_unincluded_children") {
770 lex >> maintain_unincluded_children;
771 } else if (token == "\\options") {
773 options = lex.getString();
774 } else if (token == "\\use_default_options") {
775 lex >> use_default_options;
776 } else if (token == "\\master") {
778 master = lex.getString();
779 if (!filepath.empty() && FileName::isAbsolute(origin)) {
780 bool const isabs = FileName::isAbsolute(master);
781 FileName const abspath(isabs ? master : origin + master);
782 bool const moved = filepath != FileName(origin);
783 if (moved && abspath.exists()) {
784 docstring const path = isabs
786 : from_utf8(abspath.realPath());
787 docstring const refpath =
788 from_utf8(filepath.absFileName());
789 master = to_utf8(makeRelPath(path, refpath));
792 } else if (token == "\\suppress_date") {
793 lex >> suppress_date;
794 } else if (token == "\\justification") {
795 lex >> justification;
796 } else if (token == "\\language") {
798 } else if (token == "\\language_package") {
800 lang_package = lex.getString();
801 } else if (token == "\\inputencoding") {
803 } else if (token == "\\graphics") {
804 readGraphicsDriver(lex);
805 } else if (token == "\\default_output_format") {
806 lex >> default_output_format;
807 } else if (token == "\\bibtex_command") {
809 bibtex_command = lex.getString();
810 } else if (token == "\\index_command") {
812 index_command = lex.getString();
813 } else if (token == "\\fontencoding") {
815 fontenc = lex.getString();
816 } else if (token == "\\font_roman") {
817 lex >> fonts_roman[0];
818 lex >> fonts_roman[1];
819 } else if (token == "\\font_sans") {
820 lex >> fonts_sans[0];
821 lex >> fonts_sans[1];
822 } else if (token == "\\font_typewriter") {
823 lex >> fonts_typewriter[0];
824 lex >> fonts_typewriter[1];
825 } else if (token == "\\font_math") {
826 lex >> fonts_math[0];
827 lex >> fonts_math[1];
828 } else if (token == "\\font_default_family") {
829 lex >> fonts_default_family;
830 } else if (token == "\\use_non_tex_fonts") {
831 lex >> useNonTeXFonts;
832 } else if (token == "\\font_sc") {
833 lex >> fonts_expert_sc;
834 } else if (token == "\\font_osf") {
835 lex >> fonts_old_figures;
836 } else if (token == "\\font_sf_scale") {
837 lex >> fonts_sans_scale[0];
838 lex >> fonts_sans_scale[1];
839 } else if (token == "\\font_tt_scale") {
840 lex >> fonts_typewriter_scale[0];
841 lex >> fonts_typewriter_scale[1];
842 } else if (token == "\\font_cjk") {
844 } else if (token == "\\use_microtype") {
845 lex >> use_microtype;
846 } else if (token == "\\use_dash_ligatures") {
847 lex >> use_dash_ligatures;
848 } else if (token == "\\paragraph_separation") {
851 paragraph_separation = parseptranslator().find(parsep);
852 } else if (token == "\\paragraph_indentation") {
854 string parindent = lex.getString();
855 if (parindent == "default")
856 pimpl_->parindent = Length();
858 pimpl_->parindent = Length(parindent);
859 } else if (token == "\\defskip") {
861 string const defskip = lex.getString();
862 pimpl_->defskip = VSpace(defskip);
863 if (pimpl_->defskip.kind() == VSpace::DEFSKIP)
865 pimpl_->defskip = VSpace(VSpace::MEDSKIP);
866 } else if (token == "\\is_math_indent") {
867 lex >> is_math_indent;
868 } else if (token == "\\math_indentation") {
870 string mathindent = lex.getString();
871 if (mathindent == "default")
872 pimpl_->mathindent = Length();
874 pimpl_->mathindent = Length(mathindent);
875 } else if (token == "\\math_numbering_side") {
879 math_numbering_side = LEFT;
880 else if (tmp == "right")
881 math_numbering_side = RIGHT;
883 math_numbering_side = DEFAULT;
884 } else if (token == "\\quotes_style") {
887 quotes_style = quotesstyletranslator().find(qstyle);
888 } else if (token == "\\dynamic_quotes") {
889 lex >> dynamic_quotes;
890 } else if (token == "\\papersize") {
893 papersize = papersizetranslator().find(ppsize);
894 } else if (token == "\\use_geometry") {
896 } else if (token == "\\use_package") {
901 use_package(package, packagetranslator().find(use));
902 } else if (token == "\\cite_engine") {
904 cite_engine_ = lex.getString();
905 } else if (token == "\\cite_engine_type") {
908 cite_engine_type_ = theCiteEnginesList.getType(engine_type);
909 } else if (token == "\\biblio_style") {
911 biblio_style = lex.getString();
912 } else if (token == "\\biblio_options") {
914 biblio_opts = trim(lex.getString());
915 } else if (token == "\\biblatex_bibstyle") {
917 biblatex_bibstyle = trim(lex.getString());
918 } else if (token == "\\biblatex_citestyle") {
920 biblatex_citestyle = trim(lex.getString());
921 } else if (token == "\\use_bibtopic") {
923 } else if (token == "\\multibib") {
925 } else if (token == "\\use_indices") {
927 } else if (token == "\\tracking_changes") {
928 lex >> track_changes;
929 } else if (token == "\\output_changes") {
930 lex >> output_changes;
931 } else if (token == "\\branch") {
933 docstring branch = lex.getDocString();
934 branchlist().add(branch);
937 string const tok = lex.getString();
938 if (tok == "\\end_branch")
940 Branch * branch_ptr = branchlist().find(branch);
941 if (tok == "\\selected") {
944 branch_ptr->setSelected(lex.getInteger());
946 if (tok == "\\filename_suffix") {
949 branch_ptr->setFileNameSuffix(lex.getInteger());
951 if (tok == "\\color") {
953 string color = lex.getString();
955 branch_ptr->setColor(color);
956 // Update also the Color table:
958 color = lcolor.getX11Name(Color_background);
960 lcolor.setColor(to_utf8(branch), color);
963 } else if (token == "\\index") {
965 docstring index = lex.getDocString();
967 indiceslist().add(index);
970 string const tok = lex.getString();
971 if (tok == "\\end_index")
973 Index * index_ptr = indiceslist().find(index);
974 if (tok == "\\shortcut") {
976 shortcut = lex.getDocString();
978 index_ptr->setShortcut(shortcut);
980 if (tok == "\\color") {
982 string color = lex.getString();
984 index_ptr->setColor(color);
985 // Update also the Color table:
987 color = lcolor.getX11Name(Color_background);
989 if (!shortcut.empty())
990 lcolor.setColor(to_utf8(shortcut), color);
993 } else if (token == "\\author") {
995 istringstream ss(lex.getString());
999 } else if (token == "\\paperorientation") {
1002 orientation = paperorientationtranslator().find(orient);
1003 } else if (token == "\\backgroundcolor") {
1005 backgroundcolor = lyx::rgbFromHexName(lex.getString());
1006 isbackgroundcolor = true;
1007 } else if (token == "\\fontcolor") {
1009 fontcolor = lyx::rgbFromHexName(lex.getString());
1011 } else if (token == "\\notefontcolor") {
1013 string color = lex.getString();
1014 notefontcolor = lyx::rgbFromHexName(color);
1015 lcolor.setColor("notefontcolor", color);
1016 } else if (token == "\\boxbgcolor") {
1018 string color = lex.getString();
1019 boxbgcolor = lyx::rgbFromHexName(color);
1020 lcolor.setColor("boxbgcolor", color);
1021 } else if (token == "\\paperwidth") {
1023 } else if (token == "\\paperheight") {
1025 } else if (token == "\\leftmargin") {
1027 } else if (token == "\\topmargin") {
1029 } else if (token == "\\rightmargin") {
1031 } else if (token == "\\bottommargin") {
1032 lex >> bottommargin;
1033 } else if (token == "\\headheight") {
1035 } else if (token == "\\headsep") {
1037 } else if (token == "\\footskip") {
1039 } else if (token == "\\columnsep") {
1041 } else if (token == "\\paperfontsize") {
1043 } else if (token == "\\papercolumns") {
1045 } else if (token == "\\listings_params") {
1048 listings_params = InsetListingsParams(par).params();
1049 } else if (token == "\\papersides") {
1052 sides = sidestranslator().find(psides);
1053 } else if (token == "\\paperpagestyle") {
1055 } else if (token == "\\bullet") {
1057 } else if (token == "\\bulletLaTeX") {
1058 readBulletsLaTeX(lex);
1059 } else if (token == "\\secnumdepth") {
1061 } else if (token == "\\tocdepth") {
1063 } else if (token == "\\spacing") {
1067 if (nspacing == "other") {
1070 spacing().set(spacetranslator().find(nspacing), tmp_val);
1071 } else if (token == "\\float_placement") {
1072 lex >> float_placement;
1073 } else if (token == "\\float_alignment") {
1074 lex >> float_alignment;
1076 } else if (prefixIs(token, "\\pdf_") || token == "\\use_hyperref") {
1077 string toktmp = pdfoptions().readToken(lex, token);
1078 if (!toktmp.empty()) {
1079 lyxerr << "PDFOptions::readToken(): Unknown token: " <<
1083 } else if (token == "\\html_math_output") {
1086 html_math_output = static_cast<MathOutput>(temp);
1087 } else if (token == "\\html_be_strict") {
1088 lex >> html_be_strict;
1089 } else if (token == "\\html_css_as_file") {
1090 lex >> html_css_as_file;
1091 } else if (token == "\\html_math_img_scale") {
1092 lex >> html_math_img_scale;
1093 } else if (token == "\\html_latex_start") {
1095 html_latex_start = lex.getString();
1096 } else if (token == "\\html_latex_end") {
1098 html_latex_end = lex.getString();
1099 } else if (token == "\\output_sync") {
1101 } else if (token == "\\output_sync_macro") {
1102 lex >> output_sync_macro;
1103 } else if (token == "\\use_refstyle") {
1104 lex >> use_refstyle;
1105 } else if (token == "\\use_minted") {
1108 lyxerr << "BufferParams::readToken(): Unknown token: " <<
1118 // Quote argument if it contains spaces
1119 string quoteIfNeeded(string const & str) {
1120 if (contains(str, ' '))
1121 return "\"" + str + "\"";
1127 void BufferParams::writeFile(ostream & os, Buffer const * buf) const
1129 // The top of the file is written by the buffer.
1130 // Prints out the buffer info into the .lyx file given by file
1132 os << "\\save_transient_properties "
1133 << convert<string>(save_transient_properties) << '\n';
1135 // the document directory (must end with a path separator)
1136 // realPath() is used to resolve symlinks, while addPath(..., "")
1137 // ensures a trailing path separator.
1139 string filepath = addPath(buf->fileName().onlyPath().realPath(), "");
1140 string const sysdir = inSystemDir(FileName(filepath), docsys) ? docsys
1141 : addPath(package().system_support().realPath(), "");
1142 string const relpath =
1143 to_utf8(makeRelPath(from_utf8(filepath), from_utf8(sysdir)));
1144 if (!prefixIs(relpath, "../") && !FileName::isAbsolute(relpath))
1145 filepath = addPath("/systemlyxdir", relpath);
1146 else if (!save_transient_properties || !lyxrc.save_origin)
1147 filepath = "unavailable";
1148 os << "\\origin " << quoteIfNeeded(filepath) << '\n';
1151 os << "\\textclass "
1152 << quoteIfNeeded(buf->includedFilePath(addName(buf->layoutPos(),
1153 baseClass()->name()), "layout"))
1156 // then the preamble
1157 if (!preamble.empty()) {
1158 // remove '\n' from the end of preamble
1159 docstring const tmppreamble = rtrim(preamble, "\n");
1160 os << "\\begin_preamble\n"
1161 << to_utf8(tmppreamble)
1162 << "\n\\end_preamble\n";
1166 if (!options.empty()) {
1167 os << "\\options " << options << '\n';
1170 // use the class options defined in the layout?
1171 os << "\\use_default_options "
1172 << convert<string>(use_default_options) << "\n";
1174 // the master document
1175 if (!master.empty()) {
1176 os << "\\master " << master << '\n';
1180 if (!removed_modules_.empty()) {
1181 os << "\\begin_removed_modules" << '\n';
1182 list<string>::const_iterator it = removed_modules_.begin();
1183 list<string>::const_iterator en = removed_modules_.end();
1184 for (; it != en; ++it)
1186 os << "\\end_removed_modules" << '\n';
1190 if (!layout_modules_.empty()) {
1191 os << "\\begin_modules" << '\n';
1192 LayoutModuleList::const_iterator it = layout_modules_.begin();
1193 LayoutModuleList::const_iterator en = layout_modules_.end();
1194 for (; it != en; ++it)
1196 os << "\\end_modules" << '\n';
1200 if (!included_children_.empty()) {
1201 os << "\\begin_includeonly" << '\n';
1202 list<string>::const_iterator it = included_children_.begin();
1203 list<string>::const_iterator en = included_children_.end();
1204 for (; it != en; ++it)
1206 os << "\\end_includeonly" << '\n';
1208 os << "\\maintain_unincluded_children "
1209 << convert<string>(maintain_unincluded_children) << '\n';
1211 // local layout information
1212 docstring const local_layout = getLocalLayout(false);
1213 if (!local_layout.empty()) {
1214 // remove '\n' from the end
1215 docstring const tmplocal = rtrim(local_layout, "\n");
1216 os << "\\begin_local_layout\n"
1217 << to_utf8(tmplocal)
1218 << "\n\\end_local_layout\n";
1220 docstring const forced_local_layout = getLocalLayout(true);
1221 if (!forced_local_layout.empty()) {
1222 // remove '\n' from the end
1223 docstring const tmplocal = rtrim(forced_local_layout, "\n");
1224 os << "\\begin_forced_local_layout\n"
1225 << to_utf8(tmplocal)
1226 << "\n\\end_forced_local_layout\n";
1229 // then the text parameters
1230 if (language != ignore_language)
1231 os << "\\language " << language->lang() << '\n';
1232 os << "\\language_package " << lang_package
1233 << "\n\\inputencoding " << inputenc
1234 << "\n\\fontencoding " << fontenc
1235 << "\n\\font_roman \"" << fonts_roman[0]
1236 << "\" \"" << fonts_roman[1] << '"'
1237 << "\n\\font_sans \"" << fonts_sans[0]
1238 << "\" \"" << fonts_sans[1] << '"'
1239 << "\n\\font_typewriter \"" << fonts_typewriter[0]
1240 << "\" \"" << fonts_typewriter[1] << '"'
1241 << "\n\\font_math \"" << fonts_math[0]
1242 << "\" \"" << fonts_math[1] << '"'
1243 << "\n\\font_default_family " << fonts_default_family
1244 << "\n\\use_non_tex_fonts " << convert<string>(useNonTeXFonts)
1245 << "\n\\font_sc " << convert<string>(fonts_expert_sc)
1246 << "\n\\font_osf " << convert<string>(fonts_old_figures)
1247 << "\n\\font_sf_scale " << fonts_sans_scale[0]
1248 << ' ' << fonts_sans_scale[1]
1249 << "\n\\font_tt_scale " << fonts_typewriter_scale[0]
1250 << ' ' << fonts_typewriter_scale[1]
1252 if (!fonts_cjk.empty()) {
1253 os << "\\font_cjk " << fonts_cjk << '\n';
1255 os << "\\use_microtype " << convert<string>(use_microtype) << '\n';
1256 os << "\\use_dash_ligatures " << convert<string>(use_dash_ligatures) << '\n';
1257 os << "\\graphics " << graphics_driver << '\n';
1258 os << "\\default_output_format " << default_output_format << '\n';
1259 os << "\\output_sync " << output_sync << '\n';
1260 if (!output_sync_macro.empty())
1261 os << "\\output_sync_macro \"" << output_sync_macro << "\"\n";
1262 os << "\\bibtex_command " << bibtex_command << '\n';
1263 os << "\\index_command " << index_command << '\n';
1265 if (!float_placement.empty())
1266 os << "\\float_placement " << float_placement << '\n';
1267 if (!float_alignment.empty())
1268 os << "\\float_alignment " << float_alignment << '\n';
1269 os << "\\paperfontsize " << fontsize << '\n';
1271 spacing().writeFile(os);
1272 pdfoptions().writeFile(os);
1274 os << "\\papersize " << string_papersize[papersize]
1275 << "\n\\use_geometry " << convert<string>(use_geometry);
1276 map<string, string> const & packages = auto_packages();
1277 for (map<string, string>::const_iterator it = packages.begin();
1278 it != packages.end(); ++it)
1279 os << "\n\\use_package " << it->first << ' '
1280 << use_package(it->first);
1282 os << "\n\\cite_engine ";
1284 if (!cite_engine_.empty())
1289 os << "\n\\cite_engine_type " << theCiteEnginesList.getTypeAsString(cite_engine_type_);
1291 if (!biblio_style.empty())
1292 os << "\n\\biblio_style " << biblio_style;
1293 if (!biblio_opts.empty())
1294 os << "\n\\biblio_options " << biblio_opts;
1295 if (!biblatex_bibstyle.empty())
1296 os << "\n\\biblatex_bibstyle " << biblatex_bibstyle;
1297 if (!biblatex_citestyle.empty())
1298 os << "\n\\biblatex_citestyle " << biblatex_citestyle;
1299 if (!multibib.empty())
1300 os << "\n\\multibib " << multibib;
1302 os << "\n\\use_bibtopic " << convert<string>(use_bibtopic)
1303 << "\n\\use_indices " << convert<string>(use_indices)
1304 << "\n\\paperorientation " << string_orientation[orientation]
1305 << "\n\\suppress_date " << convert<string>(suppress_date)
1306 << "\n\\justification " << convert<string>(justification)
1307 << "\n\\use_refstyle " << use_refstyle
1308 << "\n\\use_minted " << use_minted
1310 if (isbackgroundcolor == true)
1311 os << "\\backgroundcolor " << lyx::X11hexname(backgroundcolor) << '\n';
1312 if (isfontcolor == true)
1313 os << "\\fontcolor " << lyx::X11hexname(fontcolor) << '\n';
1314 if (notefontcolor != lyx::rgbFromHexName("#cccccc"))
1315 os << "\\notefontcolor " << lyx::X11hexname(notefontcolor) << '\n';
1316 if (boxbgcolor != lyx::rgbFromHexName("#ff0000"))
1317 os << "\\boxbgcolor " << lyx::X11hexname(boxbgcolor) << '\n';
1319 BranchList::const_iterator it = branchlist().begin();
1320 BranchList::const_iterator end = branchlist().end();
1321 for (; it != end; ++it) {
1322 os << "\\branch " << to_utf8(it->branch())
1323 << "\n\\selected " << it->isSelected()
1324 << "\n\\filename_suffix " << it->hasFileNameSuffix()
1325 << "\n\\color " << lyx::X11hexname(it->color())
1330 IndicesList::const_iterator iit = indiceslist().begin();
1331 IndicesList::const_iterator iend = indiceslist().end();
1332 for (; iit != iend; ++iit) {
1333 os << "\\index " << to_utf8(iit->index())
1334 << "\n\\shortcut " << to_utf8(iit->shortcut())
1335 << "\n\\color " << lyx::X11hexname(iit->color())
1340 if (!paperwidth.empty())
1341 os << "\\paperwidth "
1342 << VSpace(paperwidth).asLyXCommand() << '\n';
1343 if (!paperheight.empty())
1344 os << "\\paperheight "
1345 << VSpace(paperheight).asLyXCommand() << '\n';
1346 if (!leftmargin.empty())
1347 os << "\\leftmargin "
1348 << VSpace(leftmargin).asLyXCommand() << '\n';
1349 if (!topmargin.empty())
1350 os << "\\topmargin "
1351 << VSpace(topmargin).asLyXCommand() << '\n';
1352 if (!rightmargin.empty())
1353 os << "\\rightmargin "
1354 << VSpace(rightmargin).asLyXCommand() << '\n';
1355 if (!bottommargin.empty())
1356 os << "\\bottommargin "
1357 << VSpace(bottommargin).asLyXCommand() << '\n';
1358 if (!headheight.empty())
1359 os << "\\headheight "
1360 << VSpace(headheight).asLyXCommand() << '\n';
1361 if (!headsep.empty())
1363 << VSpace(headsep).asLyXCommand() << '\n';
1364 if (!footskip.empty())
1366 << VSpace(footskip).asLyXCommand() << '\n';
1367 if (!columnsep.empty())
1368 os << "\\columnsep "
1369 << VSpace(columnsep).asLyXCommand() << '\n';
1370 os << "\\secnumdepth " << secnumdepth
1371 << "\n\\tocdepth " << tocdepth
1372 << "\n\\paragraph_separation "
1373 << string_paragraph_separation[paragraph_separation];
1374 if (!paragraph_separation)
1375 os << "\n\\paragraph_indentation "
1376 << (getParIndent().empty() ? "default" : getParIndent().asString());
1378 os << "\n\\defskip " << getDefSkip().asLyXCommand();
1379 os << "\n\\is_math_indent " << is_math_indent;
1381 os << "\n\\math_indentation "
1382 << (getMathIndent().empty() ? "default" : getMathIndent().asString());
1383 os << "\n\\math_numbering_side ";
1384 switch(math_numbering_side) {
1394 os << "\n\\quotes_style "
1395 << string_quotes_style[quotes_style]
1396 << "\n\\dynamic_quotes " << dynamic_quotes
1397 << "\n\\papercolumns " << columns
1398 << "\n\\papersides " << sides
1399 << "\n\\paperpagestyle " << pagestyle << '\n';
1400 if (!listings_params.empty())
1401 os << "\\listings_params \"" <<
1402 InsetListingsParams(listings_params).encodedString() << "\"\n";
1403 for (int i = 0; i < 4; ++i) {
1404 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1405 if (user_defined_bullet(i).getFont() != -1) {
1406 os << "\\bullet " << i << " "
1407 << user_defined_bullet(i).getFont() << " "
1408 << user_defined_bullet(i).getCharacter() << " "
1409 << user_defined_bullet(i).getSize() << "\n";
1413 os << "\\bulletLaTeX " << i << " \""
1414 << lyx::to_ascii(user_defined_bullet(i).getText())
1420 os << "\\tracking_changes "
1421 << (save_transient_properties ? convert<string>(track_changes) : "false")
1424 os << "\\output_changes "
1425 << (save_transient_properties ? convert<string>(output_changes) : "false")
1428 os << "\\html_math_output " << html_math_output << '\n'
1429 << "\\html_css_as_file " << html_css_as_file << '\n'
1430 << "\\html_be_strict " << convert<string>(html_be_strict) << '\n';
1432 if (html_math_img_scale != 1.0)
1433 os << "\\html_math_img_scale " << convert<string>(html_math_img_scale) << '\n';
1434 if (!html_latex_start.empty())
1435 os << "\\html_latex_start " << html_latex_start << '\n';
1436 if (!html_latex_end.empty())
1437 os << "\\html_latex_end " << html_latex_end << '\n';
1439 os << pimpl_->authorlist;
1443 void BufferParams::validate(LaTeXFeatures & features) const
1445 features.require(documentClass().requires());
1447 if (columns > 1 && language->rightToLeft())
1448 features.require("rtloutputdblcol");
1450 if (output_changes) {
1451 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1452 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1453 LaTeXFeatures::isAvailable("xcolor");
1455 switch (features.runparams().flavor) {
1456 case OutputParams::LATEX:
1457 case OutputParams::DVILUATEX:
1459 features.require("ct-dvipost");
1460 features.require("dvipost");
1461 } else if (xcolorulem) {
1462 features.require("ct-xcolor-ulem");
1463 features.require("ulem");
1464 features.require("xcolor");
1466 features.require("ct-none");
1469 case OutputParams::LUATEX:
1470 case OutputParams::PDFLATEX:
1471 case OutputParams::XETEX:
1473 features.require("ct-xcolor-ulem");
1474 features.require("ulem");
1475 features.require("xcolor");
1476 // improves color handling in PDF output
1477 features.require("pdfcolmk");
1479 features.require("ct-none");
1487 // Floats with 'Here definitely' as default setting.
1488 if (float_placement.find('H') != string::npos)
1489 features.require("float");
1491 for (PackageMap::const_iterator it = use_packages.begin();
1492 it != use_packages.end(); ++it) {
1493 if (it->first == "amsmath") {
1494 // AMS Style is at document level
1495 if (it->second == package_on ||
1496 features.isProvided("amsmath"))
1497 features.require(it->first);
1498 } else if (it->second == package_on)
1499 features.require(it->first);
1502 // Document-level line spacing
1503 if (spacing().getSpace() != Spacing::Single && !spacing().isDefault())
1504 features.require("setspace");
1506 // the bullet shapes are buffer level not paragraph level
1507 // so they are tested here
1508 for (int i = 0; i < 4; ++i) {
1509 if (user_defined_bullet(i) == ITEMIZE_DEFAULTS[i])
1511 int const font = user_defined_bullet(i).getFont();
1513 int const c = user_defined_bullet(i).getCharacter();
1519 features.require("latexsym");
1521 } else if (font == 1) {
1522 features.require("amssymb");
1523 } else if (font >= 2 && font <= 5) {
1524 features.require("pifont");
1528 if (pdfoptions().use_hyperref) {
1529 features.require("hyperref");
1530 // due to interferences with babel and hyperref, the color package has to
1531 // be loaded after hyperref when hyperref is used with the colorlinks
1532 // option, see http://www.lyx.org/trac/ticket/5291
1533 if (pdfoptions().colorlinks)
1534 features.require("color");
1536 if (!listings_params.empty()) {
1537 // do not test validity because listings_params is
1538 // supposed to be valid
1540 InsetListingsParams(listings_params).separatedParams(true);
1541 // we can't support all packages, but we should load the color package
1542 if (par.find("\\color", 0) != string::npos)
1543 features.require("color");
1546 // some languages are only available via polyglossia
1547 if (features.hasPolyglossiaExclusiveLanguages())
1548 features.require("polyglossia");
1550 if (useNonTeXFonts && fontsMath() != "auto")
1551 features.require("unicode-math");
1554 features.require("microtype");
1556 if (!language->requires().empty())
1557 features.require(language->requires());
1561 bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
1562 FileName const & filepath) const
1564 // http://www.tug.org/texmf-dist/doc/latex/base/fixltx2e.pdf
1565 // !! To use the Fix-cm package, load it before \documentclass, and use the command
1566 // \RequirePackage to do so, rather than the normal \usepackage
1567 // Do not try to load any other package before the document class, unless you
1568 // have a thorough understanding of the LATEX internals and know exactly what you
1570 if (features.mustProvide("fix-cm"))
1571 os << "\\RequirePackage{fix-cm}\n";
1572 // Likewise for fixltx2e. If other packages conflict with this policy,
1573 // treat it as a package bug (and report it!)
1574 // See http://www.latex-project.org/cgi-bin/ltxbugs2html?pr=latex/4407
1575 if (features.mustProvide("fixltx2e"))
1576 os << "\\RequirePackage{fixltx2e}\n";
1578 os << "\\documentclass";
1580 DocumentClass const & tclass = documentClass();
1582 ostringstream clsoptions; // the document class options.
1584 if (tokenPos(tclass.opt_fontsize(),
1585 '|', fontsize) >= 0) {
1586 // only write if existing in list (and not default)
1587 clsoptions << fontsize << "pt,";
1590 // all paper sizes except of A4, A5, B5 and the US sizes need the
1592 bool nonstandard_papersize = papersize != PAPER_DEFAULT
1593 && papersize != PAPER_USLETTER
1594 && papersize != PAPER_USLEGAL
1595 && papersize != PAPER_USEXECUTIVE
1596 && papersize != PAPER_A4
1597 && papersize != PAPER_A5
1598 && papersize != PAPER_B5;
1600 if (!use_geometry) {
1601 switch (papersize) {
1603 clsoptions << "a4paper,";
1605 case PAPER_USLETTER:
1606 clsoptions << "letterpaper,";
1609 clsoptions << "a5paper,";
1612 clsoptions << "b5paper,";
1614 case PAPER_USEXECUTIVE:
1615 clsoptions << "executivepaper,";
1618 clsoptions << "legalpaper,";
1652 if (sides != tclass.sides()) {
1655 clsoptions << "oneside,";
1658 clsoptions << "twoside,";
1664 if (columns != tclass.columns()) {
1666 clsoptions << "twocolumn,";
1668 clsoptions << "onecolumn,";
1672 && orientation == ORIENTATION_LANDSCAPE)
1673 clsoptions << "landscape,";
1676 clsoptions << "fleqn,";
1678 switch(math_numbering_side) {
1680 clsoptions << "leqno,";
1683 clsoptions << "reqno,";
1684 features.require("amsmath");
1690 // language should be a parameter to \documentclass
1691 if (language->babel() == "hebrew"
1692 && default_language->babel() != "hebrew")
1693 // This seems necessary
1694 features.useLanguage(default_language);
1696 ostringstream language_options;
1697 bool const use_babel = features.useBabel() && !features.isProvided("babel");
1698 bool const use_polyglossia = features.usePolyglossia();
1699 bool const global = lyxrc.language_global_options;
1700 if (features.useBabel() || (use_polyglossia && global)) {
1701 language_options << features.getBabelLanguages();
1702 if (!language->babel().empty()) {
1703 if (!language_options.str().empty())
1704 language_options << ',';
1705 language_options << language->babel();
1707 if (global && !features.needBabelLangOptions()
1708 && !language_options.str().empty())
1709 clsoptions << language_options.str() << ',';
1712 // the predefined options from the layout
1713 if (use_default_options && !tclass.options().empty())
1714 clsoptions << tclass.options() << ',';
1716 // the user-defined options
1717 if (!options.empty()) {
1718 clsoptions << options << ',';
1721 string strOptions(clsoptions.str());
1722 if (!strOptions.empty()) {
1723 strOptions = rtrim(strOptions, ",");
1725 os << '[' << from_utf8(strOptions) << ']';
1728 os << '{' << from_ascii(tclass.latexname()) << "}\n";
1729 // end of \documentclass defs
1731 // if we use fontspec or newtxmath, we have to load the AMS packages here
1732 string const ams = features.loadAMSPackages();
1733 bool const ot1 = (main_font_encoding() == "default" || main_font_encoding() == "OT1");
1734 bool const use_newtxmath =
1735 theLaTeXFonts().getLaTeXFont(from_ascii(fontsMath())).getUsedPackage(
1736 ot1, false, false) == "newtxmath";
1737 if ((useNonTeXFonts || use_newtxmath) && !ams.empty())
1738 os << from_ascii(ams);
1740 if (useNonTeXFonts) {
1741 if (!features.isProvided("fontspec"))
1742 os << "\\usepackage{fontspec}\n";
1743 if (features.mustProvide("unicode-math")
1744 && features.isAvailable("unicode-math"))
1745 os << "\\usepackage{unicode-math}\n";
1748 // load CJK support package before font selection
1749 // (see autotests/export/latex/CJK/micro-sign_utf8-cjk-libertine.lyx)
1750 if (!useNonTeXFonts && encoding().package() != Encoding::none && inputenc != "utf8x"
1751 && (encoding().package() == Encoding::CJK || features.mustProvide("CJK"))) {
1752 if (inputenc == "utf8-cjk" || inputenc == "utf8")
1753 os << "\\usepackage{CJKutf8}\n";
1755 os << "\\usepackage[encapsulated]{CJK}\n";
1758 // font selection must be done before loading fontenc.sty
1759 string const fonts = loadFonts(features);
1761 os << from_utf8(fonts);
1763 if (fonts_default_family != "default")
1764 os << "\\renewcommand{\\familydefault}{\\"
1765 << from_ascii(fonts_default_family) << "}\n";
1767 // set font encoding
1768 // XeTeX and LuaTeX (with OS fonts) do not need fontenc
1769 if (!useNonTeXFonts && !features.isProvided("fontenc")
1770 && main_font_encoding() != "default") {
1771 // get main font encodings
1772 vector<string> fontencs = font_encodings();
1773 // get font encodings of secondary languages
1774 features.getFontEncodings(fontencs);
1775 if (!fontencs.empty()) {
1776 os << "\\usepackage["
1777 << from_ascii(getStringFromVector(fontencs))
1782 // Load textcomp and pmboxdraw before (lua)inputenc (#11454)
1783 if (features.mustProvide("textcomp"))
1784 os << "\\usepackage{textcomp}\n";
1785 if (features.mustProvide("pmboxdraw"))
1786 os << "\\usepackage{pmboxdraw}\n";
1788 // handle inputenc etc.
1789 writeEncodingPreamble(os, features);
1792 if (!features.runparams().includeall && !included_children_.empty()) {
1793 os << "\\includeonly{";
1794 list<string>::const_iterator it = included_children_.begin();
1795 list<string>::const_iterator en = included_children_.end();
1797 for (; it != en; ++it) {
1798 string incfile = *it;
1799 FileName inc = makeAbsPath(incfile, filepath.absFileName());
1800 string mangled = DocFileName(changeExtension(inc.absFileName(), ".tex")).
1802 if (!features.runparams().nice)
1804 // \includeonly doesn't want an extension
1805 incfile = changeExtension(incfile, string());
1806 incfile = support::latex_path(incfile);
1807 if (!incfile.empty()) {
1810 os << from_utf8(incfile);
1817 if (!features.isProvided("geometry")
1818 && (use_geometry || nonstandard_papersize)) {
1819 odocstringstream ods;
1820 if (!getGraphicsDriver("geometry").empty())
1821 ods << getGraphicsDriver("geometry");
1822 if (orientation == ORIENTATION_LANDSCAPE)
1823 ods << ",landscape";
1824 switch (papersize) {
1826 if (!paperwidth.empty())
1827 ods << ",paperwidth="
1828 << from_ascii(paperwidth);
1829 if (!paperheight.empty())
1830 ods << ",paperheight="
1831 << from_ascii(paperheight);
1833 case PAPER_USLETTER:
1834 ods << ",letterpaper";
1837 ods << ",legalpaper";
1839 case PAPER_USEXECUTIVE:
1840 ods << ",executivepaper";
1929 docstring const g_options = trim(ods.str(), ",");
1930 os << "\\usepackage";
1931 if (!g_options.empty())
1932 os << '[' << g_options << ']';
1933 os << "{geometry}\n";
1934 // output this only if use_geometry is true
1936 os << "\\geometry{verbose";
1937 if (!topmargin.empty())
1938 os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1939 if (!bottommargin.empty())
1940 os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1941 if (!leftmargin.empty())
1942 os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1943 if (!rightmargin.empty())
1944 os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1945 if (!headheight.empty())
1946 os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1947 if (!headsep.empty())
1948 os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1949 if (!footskip.empty())
1950 os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1951 if (!columnsep.empty())
1952 os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
1955 } else if (orientation == ORIENTATION_LANDSCAPE
1956 || papersize != PAPER_DEFAULT) {
1957 features.require("papersize");
1960 if (tokenPos(tclass.opt_pagestyle(), '|', pagestyle) >= 0) {
1961 if (pagestyle == "fancy")
1962 os << "\\usepackage{fancyhdr}\n";
1963 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1966 // only output when the background color is not default
1967 if (isbackgroundcolor == true) {
1968 // only require color here, the background color will be defined
1969 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1971 features.require("color");
1972 features.require("pagecolor");
1975 // only output when the font color is not default
1976 if (isfontcolor == true) {
1977 // only require color here, the font color will be defined
1978 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1980 features.require("color");
1981 features.require("fontcolor");
1984 // Only if class has a ToC hierarchy
1985 if (tclass.hasTocLevels()) {
1986 if (secnumdepth != tclass.secnumdepth()) {
1987 os << "\\setcounter{secnumdepth}{"
1991 if (tocdepth != tclass.tocdepth()) {
1992 os << "\\setcounter{tocdepth}{"
1998 if (paragraph_separation) {
1999 // when skip separation
2000 switch (getDefSkip().kind()) {
2001 case VSpace::SMALLSKIP:
2002 os << "\\setlength{\\parskip}{\\smallskipamount}\n";
2004 case VSpace::MEDSKIP:
2005 os << "\\setlength{\\parskip}{\\medskipamount}\n";
2007 case VSpace::BIGSKIP:
2008 os << "\\setlength{\\parskip}{\\bigskipamount}\n";
2010 case VSpace::LENGTH:
2011 os << "\\setlength{\\parskip}{"
2012 << from_utf8(getDefSkip().length().asLatexString())
2015 default: // should never happen // Then delete it.
2016 os << "\\setlength{\\parskip}{\\medskipamount}\n";
2019 os << "\\setlength{\\parindent}{0pt}\n";
2021 // when separation by indentation
2022 // only output something when a width is given
2023 if (!getParIndent().empty()) {
2024 os << "\\setlength{\\parindent}{"
2025 << from_utf8(getParIndent().asLatexString())
2030 if (is_math_indent) {
2031 // when formula indentation
2032 // only output something when it is not the default
2033 if (!getMathIndent().empty()) {
2034 os << "\\setlength{\\mathindent}{"
2035 << from_utf8(getMathIndent().asString())
2040 // Now insert the LyX specific LaTeX commands...
2041 features.resolveAlternatives();
2042 features.expandMultiples();
2045 if (!output_sync_macro.empty())
2046 os << from_utf8(output_sync_macro) +"\n";
2047 else if (features.runparams().flavor == OutputParams::LATEX)
2048 os << "\\usepackage[active]{srcltx}\n";
2049 else if (features.runparams().flavor == OutputParams::PDFLATEX)
2050 os << "\\synctex=-1\n";
2053 // The package options (via \PassOptionsToPackage)
2054 os << from_ascii(features.getPackageOptions());
2056 // due to interferences with babel and hyperref, the color package has to
2057 // be loaded (when it is not already loaded) before babel when hyperref
2058 // is used with the colorlinks option, see
2059 // http://www.lyx.org/trac/ticket/5291
2060 // we decided therefore to load color always before babel, see
2061 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
2062 os << from_ascii(features.getColorOptions());
2064 // If we use hyperref, jurabib, japanese or varioref,
2065 // we have to call babel before
2067 && (features.isRequired("jurabib")
2068 || features.isRequired("hyperref")
2069 || features.isRequired("varioref")
2070 || features.isRequired("japanese"))) {
2071 os << features.getBabelPresettings();
2073 os << from_utf8(babelCall(language_options.str(),
2074 features.needBabelLangOptions())) + '\n';
2075 os << features.getBabelPostsettings();
2078 // The optional packages;
2079 os << from_ascii(features.getPackages());
2081 // Additional Indices
2082 if (features.isRequired("splitidx")) {
2083 IndicesList::const_iterator iit = indiceslist().begin();
2084 IndicesList::const_iterator iend = indiceslist().end();
2085 for (; iit != iend; ++iit) {
2086 os << "\\newindex{";
2087 os << escape(iit->shortcut());
2093 os << from_utf8(spacing().writePreamble(features.isProvided("SetSpace")));
2096 // * Hyperref manual: "Make sure it comes last of your loaded
2097 // packages, to give it a fighting chance of not being over-written,
2098 // since its job is to redefine many LaTeX commands."
2099 // * Email from Heiko Oberdiek: "It is usually better to load babel
2100 // before hyperref. Then hyperref has a chance to detect babel.
2101 // * Has to be loaded before the "LyX specific LaTeX commands" to
2102 // avoid errors with algorithm floats.
2103 // use hyperref explicitly if it is required
2104 if (features.isRequired("hyperref")) {
2105 OutputParams tmp_params = features.runparams();
2106 pdfoptions().writeLaTeX(tmp_params, os,
2107 features.isProvided("hyperref"));
2108 // correctly break URLs with hyperref and dvi/ps output
2109 if (features.runparams().hyperref_driver == "dvips"
2110 && features.isAvailable("breakurl"))
2111 os << "\\usepackage{breakurl}\n";
2112 } else if (features.isRequired("nameref"))
2113 // hyperref loads this automatically
2114 os << "\\usepackage{nameref}\n";
2116 // bibtopic needs to be loaded after hyperref.
2117 // the dot provides the aux file naming which LyX can detect.
2118 if (features.mustProvide("bibtopic"))
2119 os << "\\usepackage[dot]{bibtopic}\n";
2121 // Will be surrounded by \makeatletter and \makeatother when not empty
2122 otexstringstream atlyxpreamble;
2124 // Some macros LyX will need
2126 TexString tmppreamble = features.getMacros();
2127 if (!tmppreamble.str.empty())
2128 atlyxpreamble << "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2129 "LyX specific LaTeX commands.\n"
2130 << move(tmppreamble)
2133 // the text class specific preamble
2135 docstring tmppreamble = features.getTClassPreamble();
2136 if (!tmppreamble.empty())
2137 atlyxpreamble << "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2138 "Textclass specific LaTeX commands.\n"
2142 // suppress date if selected
2143 // use \@ifundefined because we cannot be sure that every document class
2144 // has a \date command
2146 atlyxpreamble << "\\@ifundefined{date}{}{\\date{}}\n";
2148 /* the user-defined preamble */
2149 if (!containsOnly(preamble, " \n\t")) {
2151 atlyxpreamble << "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2152 "User specified LaTeX commands.\n";
2154 // Check if the user preamble contains uncodable glyphs
2155 odocstringstream user_preamble;
2156 docstring uncodable_glyphs;
2157 Encoding const * const enc = features.runparams().encoding;
2159 for (size_t n = 0; n < preamble.size(); ++n) {
2160 char_type c = preamble[n];
2161 if (!enc->encodable(c)) {
2162 docstring const glyph(1, c);
2163 LYXERR0("Uncodable character '"
2165 << "' in user preamble!");
2166 uncodable_glyphs += glyph;
2167 if (features.runparams().dryrun) {
2168 user_preamble << "<" << _("LyX Warning: ")
2169 << _("uncodable character") << " '";
2170 user_preamble.put(c);
2171 user_preamble << "'>";
2174 user_preamble.put(c);
2177 user_preamble << preamble;
2179 // On BUFFER_VIEW|UPDATE, warn user if we found uncodable glyphs
2180 if (!features.runparams().dryrun && !uncodable_glyphs.empty()) {
2181 frontend::Alert::warning(
2182 _("Uncodable character in user preamble"),
2184 _("The user preamble of your document contains glyphs "
2185 "that are unknown in the current document encoding "
2186 "(namely %1$s).\nThese glyphs are omitted "
2187 " from the output, which may result in "
2188 "incomplete output."
2189 "\n\nPlease select an appropriate "
2190 "document encoding\n"
2191 "(such as utf8) or change the "
2192 "preamble code accordingly."),
2195 atlyxpreamble << user_preamble.str() << '\n';
2198 // footmisc must be loaded after setspace
2199 // Load it here to avoid clashes with footmisc loaded in the user
2200 // preamble. For that reason we also pass the options via
2201 // \PassOptionsToPackage in getPreamble() and not here.
2202 if (features.mustProvide("footmisc"))
2203 atlyxpreamble << "\\usepackage{footmisc}\n";
2205 // subfig loads internally the LaTeX package "caption". As
2206 // caption is a very popular package, users will load it in
2207 // the preamble. Therefore we must load subfig behind the
2208 // user-defined preamble and check if the caption package was
2209 // loaded or not. For the case that caption is loaded before
2210 // subfig, there is the subfig option "caption=false". This
2211 // option also works when a koma-script class is used and
2212 // koma's own caption commands are used instead of caption. We
2213 // use \PassOptionsToPackage here because the user could have
2214 // already loaded subfig in the preamble.
2215 if (features.mustProvide("subfig"))
2216 atlyxpreamble << "\\@ifundefined{showcaptionsetup}{}{%\n"
2217 " \\PassOptionsToPackage{caption=false}{subfig}}\n"
2218 "\\usepackage{subfig}\n";
2220 // Itemize bullet settings need to be last in case the user
2221 // defines their own bullets that use a package included
2222 // in the user-defined preamble -- ARRae
2223 // Actually it has to be done much later than that
2224 // since some packages like frenchb make modifications
2225 // at \begin{document} time -- JMarc
2226 docstring bullets_def;
2227 for (int i = 0; i < 4; ++i) {
2228 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
2229 if (bullets_def.empty())
2230 bullets_def += "\\AtBeginDocument{\n";
2231 bullets_def += " \\def\\labelitemi";
2233 // `i' is one less than the item to modify
2240 bullets_def += "ii";
2246 bullets_def += '{' +
2247 user_defined_bullet(i).getText()
2252 if (!bullets_def.empty())
2253 atlyxpreamble << bullets_def << "}\n\n";
2255 if (!atlyxpreamble.empty())
2256 os << "\n\\makeatletter\n"
2257 << atlyxpreamble.release()
2258 << "\\makeatother\n\n";
2260 // We try to load babel late, in case it interferes with other packages.
2261 // Jurabib, hyperref, varioref, bicaption, menukeys and listings (bug 8995)
2262 // have to be called after babel, though.
2263 if (use_babel && !features.isRequired("jurabib")
2264 && !features.isRequired("hyperref")
2265 && !features.isRequired("varioref")
2266 && !features.isRequired("japanese")) {
2267 os << features.getBabelPresettings();
2269 os << from_utf8(babelCall(language_options.str(),
2270 features.needBabelLangOptions())) + '\n';
2271 os << features.getBabelPostsettings();
2273 if (features.isRequired("bicaption"))
2274 os << "\\usepackage{bicaption}\n";
2275 if (!listings_params.empty()
2276 || features.mustProvide("listings")
2277 || features.mustProvide("minted")) {
2279 os << "\\usepackage{minted}\n";
2281 os << "\\usepackage{listings}\n";
2283 string lst_params = listings_params;
2284 // If minted, do not output the language option (bug 11203)
2285 if (use_minted && contains(lst_params, "language=")) {
2286 vector<string> opts =
2287 getVectorFromString(lst_params, ",", false);
2288 for (size_t i = 0; i < opts.size(); ++i) {
2289 if (prefixIs(opts[i], "language="))
2290 opts.erase(opts.begin() + i--);
2292 lst_params = getStringFromVector(opts, ",");
2294 if (!lst_params.empty()) {
2296 os << "\\setminted{";
2299 // do not test validity because listings_params is
2300 // supposed to be valid
2302 InsetListingsParams(lst_params).separatedParams(true);
2303 os << from_utf8(par);
2307 // xunicode only needs to be loaded if tipa is used
2308 // (the rest is obsoleted by the new TU encoding).
2309 // It needs to be loaded at least after amsmath, amssymb,
2310 // esint and the other packages that provide special glyphs
2311 if (features.mustProvide("tipa") && useNonTeXFonts
2312 && !features.isProvided("xunicode")) {
2313 // The package officially only supports XeTeX, but also works
2314 // with LuaTeX. Thus we work around its XeTeX test.
2315 if (features.runparams().flavor != OutputParams::XETEX) {
2316 os << "% Pretend to xunicode that we are XeTeX\n"
2317 << "\\def\\XeTeXpicfile{}\n";
2319 os << "\\usepackage{xunicode}\n";
2322 // covington must be loaded after beamerarticle
2323 if (features.isRequired("covington"))
2324 os << "\\usepackage{covington}\n";
2326 // Polyglossia must be loaded last ...
2327 if (use_polyglossia) {
2329 os << "\\usepackage{polyglossia}\n";
2330 // set the main language
2331 os << "\\setdefaultlanguage";
2332 if (!language->polyglossiaOpts().empty())
2333 os << "[" << from_ascii(language->polyglossiaOpts()) << "]";
2334 os << "{" << from_ascii(language->polyglossia()) << "}\n";
2335 // now setup the other languages
2336 set<string> const polylangs =
2337 features.getPolyglossiaLanguages();
2338 for (set<string>::const_iterator mit = polylangs.begin();
2339 mit != polylangs.end() ; ++mit) {
2340 // We do not output the options here; they are output in
2341 // the language switch commands. This is safer if multiple
2342 // varieties are used.
2343 if (*mit == language->polyglossia())
2345 os << "\\setotherlanguage";
2346 os << "{" << from_ascii(*mit) << "}\n";
2350 // ... but before biblatex (see #7065)
2351 if (features.mustProvide("biblatex")
2352 && !features.isProvided("biblatex-natbib")
2353 && !features.isProvided("natbib-internal")
2354 && !features.isProvided("natbib")
2355 && !features.isProvided("jurabib")) {
2358 os << "\\usepackage";
2359 if (!biblatex_bibstyle.empty()
2360 && (biblatex_bibstyle == biblatex_citestyle)) {
2361 opts = "style=" + biblatex_bibstyle;
2364 if (!biblatex_bibstyle.empty()) {
2365 opts = "bibstyle=" + biblatex_bibstyle;
2368 if (!biblatex_citestyle.empty()) {
2369 opts += delim + "citestyle=" + biblatex_citestyle;
2373 if (!multibib.empty() && multibib != "child") {
2374 opts += delim + "refsection=" + multibib;
2377 if (bibtexCommand() == "bibtex8"
2378 || prefixIs(bibtexCommand(), "bibtex8 ")) {
2379 opts += delim + "backend=bibtex8";
2381 } else if (bibtexCommand() == "bibtex"
2382 || prefixIs(bibtexCommand(), "bibtex ")) {
2383 opts += delim + "backend=bibtex";
2386 if (!bib_encoding.empty() && encodings.fromLyXName(bib_encoding)) {
2387 opts += delim + "bibencoding="
2388 + encodings.fromLyXName(bib_encoding)->latexName();
2391 if (!biblio_opts.empty())
2392 opts += delim + biblio_opts;
2394 os << "[" << opts << "]";
2395 os << "{biblatex}\n";
2399 // Load custom language package here
2400 if (features.langPackage() == LaTeXFeatures::LANG_PACK_CUSTOM) {
2401 if (lang_package == "default")
2402 os << from_utf8(lyxrc.language_custom_package);
2404 os << from_utf8(lang_package);
2408 // Since menukeys uses catoptions, which does some heavy changes on key-value options,
2409 // it is recommended to load menukeys as the last package (even after hyperref)
2410 if (features.isRequired("menukeys"))
2411 os << "\\usepackage{menukeys}\n";
2413 docstring const i18npreamble =
2414 features.getTClassI18nPreamble(use_babel, use_polyglossia,
2416 if (!i18npreamble.empty())
2417 os << i18npreamble + '\n';
2423 void BufferParams::useClassDefaults()
2425 DocumentClass const & tclass = documentClass();
2427 sides = tclass.sides();
2428 columns = tclass.columns();
2429 pagestyle = tclass.pagestyle();
2430 use_default_options = true;
2431 // Only if class has a ToC hierarchy
2432 if (tclass.hasTocLevels()) {
2433 secnumdepth = tclass.secnumdepth();
2434 tocdepth = tclass.tocdepth();
2439 bool BufferParams::hasClassDefaults() const
2441 DocumentClass const & tclass = documentClass();
2443 return sides == tclass.sides()
2444 && columns == tclass.columns()
2445 && pagestyle == tclass.pagestyle()
2446 && use_default_options
2447 && secnumdepth == tclass.secnumdepth()
2448 && tocdepth == tclass.tocdepth();
2452 DocumentClass const & BufferParams::documentClass() const
2458 DocumentClassConstPtr BufferParams::documentClassPtr() const
2464 void BufferParams::setDocumentClass(DocumentClassConstPtr tc)
2466 // evil, but this function is evil
2467 doc_class_ = const_pointer_cast<DocumentClass>(tc);
2468 invalidateConverterCache();
2472 bool BufferParams::setBaseClass(string const & classname, string const & path)
2474 LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
2475 LayoutFileList & bcl = LayoutFileList::get();
2476 if (!bcl.haveClass(classname)) {
2478 bformat(_("The layout file:\n"
2480 "could not be found. A default textclass with default\n"
2481 "layouts will be used. LyX will not be able to produce\n"
2483 from_utf8(classname));
2484 frontend::Alert::error(_("Document class not found"), s);
2485 bcl.addEmptyClass(classname);
2488 bool const success = bcl[classname].load(path);
2491 bformat(_("Due to some error in it, the layout file:\n"
2493 "could not be loaded. A default textclass with default\n"
2494 "layouts will be used. LyX will not be able to produce\n"
2496 from_utf8(classname));
2497 frontend::Alert::error(_("Could not load class"), s);
2498 bcl.addEmptyClass(classname);
2501 pimpl_->baseClass_ = classname;
2502 layout_modules_.adaptToBaseClass(baseClass(), removed_modules_);
2507 LayoutFile const * BufferParams::baseClass() const
2509 if (LayoutFileList::get().haveClass(pimpl_->baseClass_))
2510 return &(LayoutFileList::get()[pimpl_->baseClass_]);
2516 LayoutFileIndex const & BufferParams::baseClassID() const
2518 return pimpl_->baseClass_;
2522 void BufferParams::makeDocumentClass(bool const clone)
2527 invalidateConverterCache();
2528 LayoutModuleList mods;
2529 LayoutModuleList::iterator it = layout_modules_.begin();
2530 LayoutModuleList::iterator en = layout_modules_.end();
2531 for (; it != en; ++it)
2532 mods.push_back(*it);
2534 doc_class_ = getDocumentClass(*baseClass(), mods, cite_engine_, clone);
2536 TextClass::ReturnValues success = TextClass::OK;
2537 if (!forced_local_layout_.empty())
2538 success = doc_class_->read(to_utf8(forced_local_layout_),
2540 if (!local_layout_.empty() &&
2541 (success == TextClass::OK || success == TextClass::OK_OLDFORMAT))
2542 success = doc_class_->read(to_utf8(local_layout_), TextClass::MODULE);
2543 if (success != TextClass::OK && success != TextClass::OK_OLDFORMAT) {
2544 docstring const msg = _("Error reading internal layout information");
2545 frontend::Alert::warning(_("Read Error"), msg);
2550 bool BufferParams::layoutModuleCanBeAdded(string const & modName) const
2552 return layout_modules_.moduleCanBeAdded(modName, baseClass());
2556 docstring BufferParams::getLocalLayout(bool forced) const
2559 return from_utf8(doc_class_->forcedLayouts());
2561 return local_layout_;
2565 void BufferParams::setLocalLayout(docstring const & layout, bool forced)
2568 forced_local_layout_ = layout;
2570 local_layout_ = layout;
2574 bool BufferParams::addLayoutModule(string const & modName)
2576 LayoutModuleList::const_iterator it = layout_modules_.begin();
2577 LayoutModuleList::const_iterator end = layout_modules_.end();
2578 for (; it != end; ++it)
2581 layout_modules_.push_back(modName);
2586 string BufferParams::bufferFormat() const
2588 return documentClass().outputFormat();
2592 bool BufferParams::isExportable(string const & format, bool need_viewable) const
2594 FormatList const & formats = exportableFormats(need_viewable);
2595 FormatList::const_iterator fit = formats.begin();
2596 FormatList::const_iterator end = formats.end();
2597 for (; fit != end ; ++fit) {
2598 if ((*fit)->name() == format)
2605 FormatList const & BufferParams::exportableFormats(bool only_viewable) const
2607 FormatList & cached = only_viewable ?
2608 pimpl_->viewableFormatList : pimpl_->exportableFormatList;
2609 bool & valid = only_viewable ?
2610 pimpl_->isViewCacheValid : pimpl_->isExportCacheValid;
2614 vector<string> const backs = backends();
2615 set<string> excludes;
2616 if (useNonTeXFonts) {
2617 excludes.insert("latex");
2618 excludes.insert("pdflatex");
2621 theConverters().getReachable(backs[0], only_viewable, true, excludes);
2622 for (vector<string>::const_iterator it = backs.begin() + 1;
2623 it != backs.end(); ++it) {
2624 FormatList r = theConverters().getReachable(*it, only_viewable,
2626 result.insert(result.end(), r.begin(), r.end());
2628 sort(result.begin(), result.end(), Format::formatSorter);
2635 vector<string> BufferParams::backends() const
2638 string const buffmt = bufferFormat();
2640 // FIXME: Don't hardcode format names here, but use a flag
2641 if (buffmt == "latex") {
2642 if (encoding().package() == Encoding::japanese)
2643 v.push_back("platex");
2645 if (!useNonTeXFonts) {
2646 v.push_back("pdflatex");
2647 v.push_back("latex");
2649 v.push_back("xetex");
2650 v.push_back("luatex");
2651 v.push_back("dviluatex");
2654 string rbuffmt = buffmt;
2655 // If we use an OutputFormat in Japanese docs,
2656 // we need special format in order to get the path
2657 // via pLaTeX (#8823)
2658 if (documentClass().hasOutputFormat()
2659 && encoding().package() == Encoding::japanese)
2661 v.push_back(rbuffmt);
2664 v.push_back("xhtml");
2665 v.push_back("text");
2671 OutputParams::FLAVOR BufferParams::getOutputFlavor(string const & format) const
2673 string const dformat = (format.empty() || format == "default") ?
2674 getDefaultOutputFormat() : format;
2675 DefaultFlavorCache::const_iterator it =
2676 default_flavors_.find(dformat);
2678 if (it != default_flavors_.end())
2681 OutputParams::FLAVOR result = OutputParams::LATEX;
2683 // FIXME It'd be better not to hardcode this, but to do
2684 // something with formats.
2685 if (dformat == "xhtml")
2686 result = OutputParams::HTML;
2687 else if (dformat == "text")
2688 result = OutputParams::TEXT;
2689 else if (dformat == "lyx")
2690 result = OutputParams::LYX;
2691 else if (dformat == "pdflatex")
2692 result = OutputParams::PDFLATEX;
2693 else if (dformat == "xetex")
2694 result = OutputParams::XETEX;
2695 else if (dformat == "luatex")
2696 result = OutputParams::LUATEX;
2697 else if (dformat == "dviluatex")
2698 result = OutputParams::DVILUATEX;
2700 // Try to determine flavor of default output format
2701 vector<string> backs = backends();
2702 if (find(backs.begin(), backs.end(), dformat) == backs.end()) {
2703 // Get shortest path to format
2704 Graph::EdgePath path;
2705 for (auto const & bvar : backs) {
2706 Graph::EdgePath p = theConverters().getPath(bvar, dformat);
2707 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2712 result = theConverters().getFlavor(path);
2715 // cache this flavor
2716 default_flavors_[dformat] = result;
2721 string BufferParams::getDefaultOutputFormat() const
2723 if (!default_output_format.empty()
2724 && default_output_format != "default")
2725 return default_output_format;
2727 FormatList const & formats = exportableFormats(true);
2728 if (formats.empty())
2730 // return the first we find
2731 return formats.front()->name();
2733 if (encoding().package() == Encoding::japanese)
2734 return lyxrc.default_platex_view_format;
2736 return lyxrc.default_otf_view_format;
2737 return lyxrc.default_view_format;
2740 Font const BufferParams::getFont() const
2742 FontInfo f = documentClass().defaultfont();
2743 if (fonts_default_family == "rmdefault")
2744 f.setFamily(ROMAN_FAMILY);
2745 else if (fonts_default_family == "sfdefault")
2746 f.setFamily(SANS_FAMILY);
2747 else if (fonts_default_family == "ttdefault")
2748 f.setFamily(TYPEWRITER_FAMILY);
2749 return Font(f, language);
2753 InsetQuotesParams::QuoteStyle BufferParams::getQuoteStyle(string const & qs) const
2755 return quotesstyletranslator().find(qs);
2759 bool BufferParams::isLatex() const
2761 return documentClass().outputType() == LATEX;
2765 bool BufferParams::isLiterate() const
2767 return documentClass().outputType() == LITERATE;
2771 bool BufferParams::isDocBook() const
2773 return documentClass().outputType() == DOCBOOK;
2777 void BufferParams::readPreamble(Lexer & lex)
2779 if (lex.getString() != "\\begin_preamble")
2780 lyxerr << "Error (BufferParams::readPreamble):"
2781 "consistency check failed." << endl;
2783 preamble = lex.getLongString(from_ascii("\\end_preamble"));
2787 void BufferParams::readLocalLayout(Lexer & lex, bool forced)
2789 string const expected = forced ? "\\begin_forced_local_layout" :
2790 "\\begin_local_layout";
2791 if (lex.getString() != expected)
2792 lyxerr << "Error (BufferParams::readLocalLayout):"
2793 "consistency check failed." << endl;
2796 forced_local_layout_ =
2797 lex.getLongString(from_ascii("\\end_forced_local_layout"));
2799 local_layout_ = lex.getLongString(from_ascii("\\end_local_layout"));
2803 bool BufferParams::setLanguage(string const & lang)
2805 Language const *new_language = languages.getLanguage(lang);
2806 if (!new_language) {
2807 // Language lang was not found
2810 language = new_language;
2815 void BufferParams::readLanguage(Lexer & lex)
2817 if (!lex.next()) return;
2819 string const tmptok = lex.getString();
2821 // check if tmptok is part of tex_babel in tex-defs.h
2822 if (!setLanguage(tmptok)) {
2823 // Language tmptok was not found
2824 language = default_language;
2825 lyxerr << "Warning: Setting language `"
2826 << tmptok << "' to `" << language->lang()
2832 void BufferParams::readGraphicsDriver(Lexer & lex)
2837 string const tmptok = lex.getString();
2838 // check if tmptok is part of tex_graphics in tex_defs.h
2841 string const test = tex_graphics[n++];
2843 if (test == tmptok) {
2844 graphics_driver = tmptok;
2849 "Warning: graphics driver `$$Token' not recognized!\n"
2850 " Setting graphics driver to `default'.\n");
2851 graphics_driver = "default";
2858 void BufferParams::readBullets(Lexer & lex)
2863 int const index = lex.getInteger();
2865 int temp_int = lex.getInteger();
2866 user_defined_bullet(index).setFont(temp_int);
2867 temp_bullet(index).setFont(temp_int);
2869 user_defined_bullet(index).setCharacter(temp_int);
2870 temp_bullet(index).setCharacter(temp_int);
2872 user_defined_bullet(index).setSize(temp_int);
2873 temp_bullet(index).setSize(temp_int);
2877 void BufferParams::readBulletsLaTeX(Lexer & lex)
2879 // The bullet class should be able to read this.
2882 int const index = lex.getInteger();
2884 docstring const temp_str = lex.getDocString();
2886 user_defined_bullet(index).setText(temp_str);
2887 temp_bullet(index).setText(temp_str);
2891 void BufferParams::readModules(Lexer & lex)
2893 if (!lex.eatLine()) {
2894 lyxerr << "Error (BufferParams::readModules):"
2895 "Unexpected end of input." << endl;
2899 string mod = lex.getString();
2900 if (mod == "\\end_modules")
2902 addLayoutModule(mod);
2908 void BufferParams::readRemovedModules(Lexer & lex)
2910 if (!lex.eatLine()) {
2911 lyxerr << "Error (BufferParams::readRemovedModules):"
2912 "Unexpected end of input." << endl;
2916 string mod = lex.getString();
2917 if (mod == "\\end_removed_modules")
2919 removed_modules_.push_back(mod);
2922 // now we want to remove any removed modules that were previously
2923 // added. normally, that will be because default modules were added in
2924 // setBaseClass(), which gets called when \textclass is read at the
2925 // start of the read.
2926 list<string>::const_iterator rit = removed_modules_.begin();
2927 list<string>::const_iterator const ren = removed_modules_.end();
2928 for (; rit != ren; ++rit) {
2929 LayoutModuleList::iterator const mit = layout_modules_.begin();
2930 LayoutModuleList::iterator const men = layout_modules_.end();
2931 LayoutModuleList::iterator found = find(mit, men, *rit);
2934 layout_modules_.erase(found);
2939 void BufferParams::readIncludeonly(Lexer & lex)
2941 if (!lex.eatLine()) {
2942 lyxerr << "Error (BufferParams::readIncludeonly):"
2943 "Unexpected end of input." << endl;
2947 string child = lex.getString();
2948 if (child == "\\end_includeonly")
2950 included_children_.push_back(child);
2956 string BufferParams::paperSizeName(PapersizePurpose purpose) const
2958 switch (papersize) {
2960 // could be anything, so don't guess
2962 case PAPER_CUSTOM: {
2963 if (purpose == XDVI && !paperwidth.empty() &&
2964 !paperheight.empty()) {
2965 // heightxwidth<unit>
2966 string first = paperwidth;
2967 string second = paperheight;
2968 if (orientation == ORIENTATION_LANDSCAPE)
2971 return first.erase(first.length() - 2)
2977 // dvips and dvipdfm do not know this
2978 if (purpose == DVIPS || purpose == DVIPDFM)
2982 if (purpose == DVIPS || purpose == DVIPDFM)
2986 if (purpose == DVIPS || purpose == DVIPDFM)
2996 if (purpose == DVIPS || purpose == DVIPDFM)
3000 if (purpose == DVIPS || purpose == DVIPDFM)
3004 if (purpose == DVIPS || purpose == DVIPDFM)
3008 if (purpose == DVIPS || purpose == DVIPDFM)
3012 if (purpose == DVIPS || purpose == DVIPDFM)
3016 // dvipdfm does not know this
3017 if (purpose == DVIPDFM)
3021 if (purpose == DVIPDFM)
3025 if (purpose == DVIPS || purpose == DVIPDFM)
3029 if (purpose == DVIPS || purpose == DVIPDFM)
3033 if (purpose == DVIPS || purpose == DVIPDFM)
3037 if (purpose == DVIPS || purpose == DVIPDFM)
3041 if (purpose == DVIPS || purpose == DVIPDFM)
3045 if (purpose == DVIPS || purpose == DVIPDFM)
3049 if (purpose == DVIPS || purpose == DVIPDFM)
3053 if (purpose == DVIPS || purpose == DVIPDFM)
3057 if (purpose == DVIPS || purpose == DVIPDFM)
3061 if (purpose == DVIPS || purpose == DVIPDFM)
3065 if (purpose == DVIPS || purpose == DVIPDFM)
3069 if (purpose == DVIPS || purpose == DVIPDFM)
3073 if (purpose == DVIPS || purpose == DVIPDFM)
3077 if (purpose == DVIPS || purpose == DVIPDFM)
3081 if (purpose == DVIPS || purpose == DVIPDFM)
3084 case PAPER_USEXECUTIVE:
3085 // dvipdfm does not know this
3086 if (purpose == DVIPDFM)
3091 case PAPER_USLETTER:
3093 if (purpose == XDVI)
3100 string const BufferParams::dvips_options() const
3104 // If the class loads the geometry package, we do not know which
3105 // paper size is used, since we do not set it (bug 7013).
3106 // Therefore we must not specify any argument here.
3107 // dvips gets the correct paper size via DVI specials in this case
3108 // (if the class uses the geometry package correctly).
3109 if (documentClass().provides("geometry"))
3113 && papersize == PAPER_CUSTOM
3114 && !lyxrc.print_paper_dimension_flag.empty()
3115 && !paperwidth.empty()
3116 && !paperheight.empty()) {
3117 // using a custom papersize
3118 result = lyxrc.print_paper_dimension_flag;
3119 result += ' ' + paperwidth;
3120 result += ',' + paperheight;
3122 string const paper_option = paperSizeName(DVIPS);
3123 if (!paper_option.empty() && (paper_option != "letter" ||
3124 orientation != ORIENTATION_LANDSCAPE)) {
3125 // dvips won't accept -t letter -t landscape.
3126 // In all other cases, include the paper size
3128 result = lyxrc.print_paper_flag;
3129 result += ' ' + paper_option;
3132 if (orientation == ORIENTATION_LANDSCAPE &&
3133 papersize != PAPER_CUSTOM)
3134 result += ' ' + lyxrc.print_landscape_flag;
3139 string const BufferParams::main_font_encoding() const
3141 if (font_encodings().empty()) {
3142 if (ascii_lowercase(language->fontenc(*this)) == "none")
3146 return font_encodings().back();
3150 vector<string> const BufferParams::font_encodings() const
3152 string doc_fontenc = (fontenc == "auto") ? string() : fontenc;
3154 vector<string> fontencs;
3156 // "default" means "no explicit font encoding"
3157 if (doc_fontenc != "default") {
3158 if (!doc_fontenc.empty())
3159 // If we have a custom setting, we use only that!
3160 return getVectorFromString(doc_fontenc);
3161 if (!language->fontenc(*this).empty()
3162 && ascii_lowercase(language->fontenc(*this)) != "none") {
3163 vector<string> fencs = getVectorFromString(language->fontenc(*this));
3164 for (auto & fe : fencs) {
3165 if (find(fontencs.begin(), fontencs.end(), fe) == fontencs.end())
3166 fontencs.push_back(fe);
3175 string BufferParams::babelCall(string const & lang_opts, bool const langoptions) const
3177 // suppress the babel call if there is no BabelName defined
3178 // for the document language in the lib/languages file and if no
3179 // other languages are used (lang_opts is then empty)
3180 if (lang_opts.empty())
3182 // either a specific language (AsBabelOptions setting in
3183 // lib/languages) or the prefs require the languages to
3184 // be submitted to babel itself (not the class).
3186 return "\\usepackage[" + lang_opts + "]{babel}";
3187 return "\\usepackage{babel}";
3191 docstring BufferParams::getGraphicsDriver(string const & package) const
3195 if (package == "geometry") {
3196 if (graphics_driver == "dvips"
3197 || graphics_driver == "dvipdfm"
3198 || graphics_driver == "pdftex"
3199 || graphics_driver == "vtex")
3200 result = from_ascii(graphics_driver);
3201 else if (graphics_driver == "dvipdfmx")
3202 result = from_ascii("dvipdfm");
3209 void BufferParams::writeEncodingPreamble(otexstream & os,
3210 LaTeXFeatures & features) const
3212 // XeTeX/LuaTeX: (see also #9740)
3213 // With Unicode fonts we use utf8-plain without encoding package.
3214 // With TeX fonts, we cannot use utf8-plain, but "inputenc" fails.
3215 // XeTeX must use ASCII encoding (see Buffer.cpp),
3216 // for LuaTeX, we load "luainputenc" (see below).
3217 if (useNonTeXFonts || features.runparams().flavor == OutputParams::XETEX)
3220 if (inputenc == "auto") {
3221 string const doc_encoding =
3222 language->encoding()->latexName();
3223 Encoding::Package const package =
3224 language->encoding()->package();
3226 // Create list of inputenc options:
3227 set<string> encoding_set;
3228 // luainputenc fails with more than one encoding
3229 if (!features.runparams().isFullUnicode()) // if we reach this point, this means LuaTeX with TeX fonts
3230 // list all input encodings used in the document
3231 encoding_set = features.getEncodingSet(doc_encoding);
3233 // If the "japanese" package (i.e. pLaTeX) is used,
3234 // inputenc must be omitted.
3235 // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
3236 if ((!encoding_set.empty() || package == Encoding::inputenc)
3237 && !features.isRequired("japanese")
3238 && !features.isProvided("inputenc")) {
3239 os << "\\usepackage[";
3240 set<string>::const_iterator it = encoding_set.begin();
3241 set<string>::const_iterator const end = encoding_set.end();
3243 os << from_ascii(*it);
3246 for (; it != end; ++it)
3247 os << ',' << from_ascii(*it);
3248 if (package == Encoding::inputenc) {
3249 if (!encoding_set.empty())
3251 os << from_ascii(doc_encoding);
3253 if (features.runparams().flavor == OutputParams::LUATEX
3254 || features.runparams().flavor == OutputParams::DVILUATEX)
3255 os << "]{luainputenc}\n";
3257 os << "]{inputenc}\n";
3259 } else if (inputenc != "default") {
3260 switch (encoding().package()) {
3261 case Encoding::none:
3263 case Encoding::japanese:
3264 if (encoding().iconvName() != "UTF-8")
3265 // don't default to [utf8]{inputenc} with TeXLive >= 18
3266 os << "\\ifdefined\\UseRawInputEncoding\n"
3267 << " \\UseRawInputEncoding\\fi\n";
3269 case Encoding::inputenc:
3270 // do not load inputenc if japanese is used
3271 // or if the class provides inputenc
3272 if (features.isRequired("japanese")
3273 || features.isProvided("inputenc"))
3275 os << "\\usepackage[" << from_ascii(encoding().latexName());
3276 if (features.runparams().flavor == OutputParams::LUATEX
3277 || features.runparams().flavor == OutputParams::DVILUATEX)
3278 os << "]{luainputenc}\n";
3280 os << "]{inputenc}\n";
3284 if (inputenc == "default" or features.isRequired("japanese")) {
3285 // don't default to [utf8]{inputenc} with TeXLive >= 18
3286 os << "\\ifdefined\\UseRawInputEncoding\n";
3287 os << " \\UseRawInputEncoding\\fi\n";
3292 string const BufferParams::parseFontName(string const & name) const
3294 string mangled = name;
3295 size_t const idx = mangled.find('[');
3296 if (idx == string::npos || idx == 0)
3299 return mangled.substr(0, idx - 1);
3303 string const BufferParams::loadFonts(LaTeXFeatures & features) const
3305 if (fontsRoman() == "default" && fontsSans() == "default"
3306 && fontsTypewriter() == "default"
3307 && (fontsMath() == "default" || fontsMath() == "auto"))
3313 /* Fontspec (XeTeX, LuaTeX): we provide GUI support for oldstyle
3314 * numbers (Numbers=OldStyle) and sf/tt scaling. The Ligatures=TeX/
3315 * Mapping=tex-text option assures TeX ligatures (such as "--")
3316 * are resolved. Note that tt does not use these ligatures.
3318 * -- add more GUI options?
3319 * -- add more fonts (fonts for other scripts)
3320 * -- if there's a way to find out if a font really supports
3321 * OldStyle, enable/disable the widget accordingly.
3323 if (useNonTeXFonts && features.isAvailable("fontspec")) {
3324 // "Mapping=tex-text" and "Ligatures=TeX" are equivalent.
3325 // However, until v.2 (2010/07/11) fontspec only knew
3326 // Mapping=tex-text (for XeTeX only); then "Ligatures=TeX"
3327 // was introduced for both XeTeX and LuaTeX (LuaTeX
3328 // didn't understand "Mapping=tex-text", while XeTeX
3329 // understood both. With most recent versions, both
3330 // variants are understood by both engines. However,
3331 // we want to provide support for at least TeXLive 2009
3332 // (for XeTeX; LuaTeX is only supported as of v.2)
3333 string const texmapping =
3334 (features.runparams().flavor == OutputParams::XETEX) ?
3335 "Mapping=tex-text" : "Ligatures=TeX";
3336 if (fontsRoman() != "default") {
3337 os << "\\setmainfont[" << texmapping;
3338 if (fonts_old_figures)
3339 os << ",Numbers=OldStyle";
3340 os << "]{" << parseFontName(fontsRoman()) << "}\n";
3342 if (fontsSans() != "default") {
3343 string const sans = parseFontName(fontsSans());
3344 if (fontsSansScale() != 100)
3345 os << "\\setsansfont[Scale="
3346 << float(fontsSansScale()) / 100
3347 << "," << texmapping << "]{"
3350 os << "\\setsansfont[" << texmapping << "]{"
3353 if (fontsTypewriter() != "default") {
3354 string const mono = parseFontName(fontsTypewriter());
3355 if (fontsTypewriterScale() != 100)
3356 os << "\\setmonofont[Scale="
3357 << float(fontsTypewriterScale()) / 100
3361 os << "\\setmonofont{"
3368 bool const ot1 = (main_font_encoding() == "default" || main_font_encoding() == "OT1");
3369 bool const dryrun = features.runparams().dryrun;
3370 bool const complete = (fontsSans() == "default" && fontsTypewriter() == "default");
3371 bool const nomath = (fontsMath() == "default");
3374 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsRoman())).getLaTeXCode(
3375 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3379 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsSans())).getLaTeXCode(
3380 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3381 nomath, fontsSansScale());
3383 // MONOSPACED/TYPEWRITER
3384 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsTypewriter())).getLaTeXCode(
3385 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3386 nomath, fontsTypewriterScale());
3389 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsMath())).getLaTeXCode(
3390 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3397 Encoding const & BufferParams::encoding() const
3399 // Main encoding for LaTeX output.
3401 // Exception: XeTeX with 8-bit TeX fonts requires ASCII (see #9740).
3402 // As the "flavor" is only known once export started, this
3403 // cannot be handled here. Instead, runparams.encoding is set
3404 // to ASCII in Buffer::makeLaTeXFile (for export)
3405 // and Buffer::writeLaTeXSource (for preview).
3407 return *(encodings.fromLyXName("utf8-plain"));
3408 if (inputenc == "auto" || inputenc == "default")
3409 return *language->encoding();
3410 Encoding const * const enc = encodings.fromLyXName(inputenc);
3413 LYXERR0("Unknown inputenc value `" << inputenc
3414 << "'. Using `auto' instead.");
3415 return *language->encoding();
3419 string const & BufferParams::defaultBiblioStyle() const
3421 if (!biblio_style.empty())
3422 return biblio_style;
3424 map<string, string> const & bs = documentClass().defaultBiblioStyle();
3425 auto cit = bs.find(theCiteEnginesList.getTypeAsString(citeEngineType()));
3426 if (cit != bs.end())
3429 return empty_string();
3433 bool const & BufferParams::fullAuthorList() const
3435 return documentClass().fullAuthorList();
3439 string BufferParams::getCiteAlias(string const & s) const
3441 vector<string> commands =
3442 documentClass().citeCommands(citeEngineType());
3443 // If it is a real command, don't treat it as an alias
3444 if (find(commands.begin(), commands.end(), s) != commands.end())
3446 map<string,string> aliases = documentClass().citeCommandAliases();
3447 if (aliases.find(s) != aliases.end())
3453 vector<string> BufferParams::citeCommands() const
3455 static CitationStyle const default_style;
3456 vector<string> commands =
3457 documentClass().citeCommands(citeEngineType());
3458 if (commands.empty())
3459 commands.push_back(default_style.name);
3464 vector<CitationStyle> BufferParams::citeStyles() const
3466 static CitationStyle const default_style;
3467 vector<CitationStyle> styles =
3468 documentClass().citeStyles(citeEngineType());
3470 styles.push_back(default_style);
3475 string const BufferParams::bibtexCommand() const
3477 // Return document-specific setting if available
3478 if (bibtex_command != "default")
3479 return bibtex_command;
3481 // If we have "default" in document settings, consult the prefs
3482 // 1. Japanese (uses a specific processor)
3483 if (encoding().package() == Encoding::japanese) {
3484 if (lyxrc.jbibtex_command != "automatic")
3485 // Return the specified program, if "automatic" is not set
3486 return lyxrc.jbibtex_command;
3487 else if (!useBiblatex()) {
3488 // With classic BibTeX, return pbibtex, jbibtex, bibtex
3489 if (lyxrc.jbibtex_alternatives.find("pbibtex") != lyxrc.jbibtex_alternatives.end())
3491 if (lyxrc.jbibtex_alternatives.find("jbibtex") != lyxrc.jbibtex_alternatives.end())
3496 // 2. All other languages
3497 else if (lyxrc.bibtex_command != "automatic")
3498 // Return the specified program, if "automatic" is not set
3499 return lyxrc.bibtex_command;
3501 // 3. Automatic: find the most suitable for the current cite framework
3502 if (useBiblatex()) {
3503 // For Biblatex, we prefer biber (also for Japanese)
3504 // and fall back to bibtex8 and, as last resort, bibtex
3505 if (lyxrc.bibtex_alternatives.find("biber") != lyxrc.bibtex_alternatives.end())
3507 else if (lyxrc.bibtex_alternatives.find("bibtex8") != lyxrc.bibtex_alternatives.end())
3514 bool BufferParams::useBiblatex() const
3516 return theCiteEnginesList[citeEngine()]->getCiteFramework() == "biblatex";
3520 void BufferParams::invalidateConverterCache() const
3522 pimpl_->isExportCacheValid = false;
3523 pimpl_->isViewCacheValid = false;
3527 // We shouldn't need to reset the params here, since anything
3528 // we need will be recopied.
3529 void BufferParams::copyForAdvFR(const BufferParams & bp)
3531 string const & lang = bp.language->lang();
3533 layout_modules_ = bp.layout_modules_;
3534 string const & doc_class = bp.documentClass().name();
3535 setBaseClass(doc_class);