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
1751 && (encoding().package() == Encoding::CJK || features.mustProvide("CJK"))) {
1752 if (encoding().iconvName() == "UTF-8"
1753 && LaTeXFeatures::isAvailable("CJKutf8"))
1754 os << "\\usepackage{CJKutf8}\n";
1756 os << "\\usepackage[encapsulated]{CJK}\n";
1759 // font selection must be done before loading fontenc.sty
1760 string const fonts = loadFonts(features);
1762 os << from_utf8(fonts);
1764 if (fonts_default_family != "default")
1765 os << "\\renewcommand{\\familydefault}{\\"
1766 << from_ascii(fonts_default_family) << "}\n";
1768 // set font encoding
1769 // XeTeX and LuaTeX (with OS fonts) do not need fontenc
1770 if (!useNonTeXFonts && !features.isProvided("fontenc")
1771 && main_font_encoding() != "default") {
1772 // get main font encodings
1773 vector<string> fontencs = font_encodings();
1774 // get font encodings of secondary languages
1775 features.getFontEncodings(fontencs);
1776 if (!fontencs.empty()) {
1777 os << "\\usepackage["
1778 << from_ascii(getStringFromVector(fontencs))
1783 // handle inputenc etc.
1784 writeEncodingPreamble(os, features);
1787 if (!features.runparams().includeall && !included_children_.empty()) {
1788 os << "\\includeonly{";
1789 list<string>::const_iterator it = included_children_.begin();
1790 list<string>::const_iterator en = included_children_.end();
1792 for (; it != en; ++it) {
1793 string incfile = *it;
1794 FileName inc = makeAbsPath(incfile, filepath.absFileName());
1795 string mangled = DocFileName(changeExtension(inc.absFileName(), ".tex")).
1797 if (!features.runparams().nice)
1799 // \includeonly doesn't want an extension
1800 incfile = changeExtension(incfile, string());
1801 incfile = support::latex_path(incfile);
1802 if (!incfile.empty()) {
1805 os << from_utf8(incfile);
1812 if (!features.isProvided("geometry")
1813 && (use_geometry || nonstandard_papersize)) {
1814 odocstringstream ods;
1815 if (!getGraphicsDriver("geometry").empty())
1816 ods << getGraphicsDriver("geometry");
1817 if (orientation == ORIENTATION_LANDSCAPE)
1818 ods << ",landscape";
1819 switch (papersize) {
1821 if (!paperwidth.empty())
1822 ods << ",paperwidth="
1823 << from_ascii(paperwidth);
1824 if (!paperheight.empty())
1825 ods << ",paperheight="
1826 << from_ascii(paperheight);
1828 case PAPER_USLETTER:
1829 ods << ",letterpaper";
1832 ods << ",legalpaper";
1834 case PAPER_USEXECUTIVE:
1835 ods << ",executivepaper";
1924 docstring const g_options = trim(ods.str(), ",");
1925 os << "\\usepackage";
1926 if (!g_options.empty())
1927 os << '[' << g_options << ']';
1928 os << "{geometry}\n";
1929 // output this only if use_geometry is true
1931 os << "\\geometry{verbose";
1932 if (!topmargin.empty())
1933 os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1934 if (!bottommargin.empty())
1935 os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1936 if (!leftmargin.empty())
1937 os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1938 if (!rightmargin.empty())
1939 os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1940 if (!headheight.empty())
1941 os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1942 if (!headsep.empty())
1943 os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1944 if (!footskip.empty())
1945 os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1946 if (!columnsep.empty())
1947 os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
1950 } else if (orientation == ORIENTATION_LANDSCAPE
1951 || papersize != PAPER_DEFAULT) {
1952 features.require("papersize");
1955 if (tokenPos(tclass.opt_pagestyle(), '|', pagestyle) >= 0) {
1956 if (pagestyle == "fancy")
1957 os << "\\usepackage{fancyhdr}\n";
1958 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1961 // only output when the background color is not default
1962 if (isbackgroundcolor == true) {
1963 // only require color here, the background color will be defined
1964 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1966 features.require("color");
1967 features.require("pagecolor");
1970 // only output when the font color is not default
1971 if (isfontcolor == true) {
1972 // only require color here, the font color will be defined
1973 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1975 features.require("color");
1976 features.require("fontcolor");
1979 // Only if class has a ToC hierarchy
1980 if (tclass.hasTocLevels()) {
1981 if (secnumdepth != tclass.secnumdepth()) {
1982 os << "\\setcounter{secnumdepth}{"
1986 if (tocdepth != tclass.tocdepth()) {
1987 os << "\\setcounter{tocdepth}{"
1993 if (paragraph_separation) {
1994 // when skip separation
1995 switch (getDefSkip().kind()) {
1996 case VSpace::SMALLSKIP:
1997 os << "\\setlength{\\parskip}{\\smallskipamount}\n";
1999 case VSpace::MEDSKIP:
2000 os << "\\setlength{\\parskip}{\\medskipamount}\n";
2002 case VSpace::BIGSKIP:
2003 os << "\\setlength{\\parskip}{\\bigskipamount}\n";
2005 case VSpace::LENGTH:
2006 os << "\\setlength{\\parskip}{"
2007 << from_utf8(getDefSkip().length().asLatexString())
2010 default: // should never happen // Then delete it.
2011 os << "\\setlength{\\parskip}{\\medskipamount}\n";
2014 os << "\\setlength{\\parindent}{0pt}\n";
2016 // when separation by indentation
2017 // only output something when a width is given
2018 if (!getParIndent().empty()) {
2019 os << "\\setlength{\\parindent}{"
2020 << from_utf8(getParIndent().asLatexString())
2025 if (is_math_indent) {
2026 // when formula indentation
2027 // only output something when it is not the default
2028 if (!getMathIndent().empty()) {
2029 os << "\\setlength{\\mathindent}{"
2030 << from_utf8(getMathIndent().asString())
2035 // Now insert the LyX specific LaTeX commands...
2036 features.resolveAlternatives();
2037 features.expandMultiples();
2040 if (!output_sync_macro.empty())
2041 os << from_utf8(output_sync_macro) +"\n";
2042 else if (features.runparams().flavor == OutputParams::LATEX)
2043 os << "\\usepackage[active]{srcltx}\n";
2044 else if (features.runparams().flavor == OutputParams::PDFLATEX)
2045 os << "\\synctex=-1\n";
2048 // The package options (via \PassOptionsToPackage)
2049 os << from_ascii(features.getPackageOptions());
2051 // due to interferences with babel and hyperref, the color package has to
2052 // be loaded (when it is not already loaded) before babel when hyperref
2053 // is used with the colorlinks option, see
2054 // http://www.lyx.org/trac/ticket/5291
2055 // we decided therefore to load color always before babel, see
2056 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
2057 os << from_ascii(features.getColorOptions());
2059 // If we use hyperref, jurabib, japanese or varioref,
2060 // we have to call babel before
2062 && (features.isRequired("jurabib")
2063 || features.isRequired("hyperref")
2064 || features.isRequired("varioref")
2065 || features.isRequired("japanese"))) {
2066 os << features.getBabelPresettings();
2068 os << from_utf8(babelCall(language_options.str(),
2069 features.needBabelLangOptions())) + '\n';
2070 os << features.getBabelPostsettings();
2073 // The optional packages;
2074 os << from_ascii(features.getPackages());
2076 // Additional Indices
2077 if (features.isRequired("splitidx")) {
2078 IndicesList::const_iterator iit = indiceslist().begin();
2079 IndicesList::const_iterator iend = indiceslist().end();
2080 for (; iit != iend; ++iit) {
2081 os << "\\newindex{";
2082 os << escape(iit->shortcut());
2088 os << from_utf8(spacing().writePreamble(features.isProvided("SetSpace")));
2091 // * Hyperref manual: "Make sure it comes last of your loaded
2092 // packages, to give it a fighting chance of not being over-written,
2093 // since its job is to redefine many LaTeX commands."
2094 // * Email from Heiko Oberdiek: "It is usually better to load babel
2095 // before hyperref. Then hyperref has a chance to detect babel.
2096 // * Has to be loaded before the "LyX specific LaTeX commands" to
2097 // avoid errors with algorithm floats.
2098 // use hyperref explicitly if it is required
2099 if (features.isRequired("hyperref")) {
2100 OutputParams tmp_params = features.runparams();
2101 pdfoptions().writeLaTeX(tmp_params, os,
2102 features.isProvided("hyperref"));
2103 // correctly break URLs with hyperref and dvi/ps output
2104 if (features.runparams().hyperref_driver == "dvips"
2105 && features.isAvailable("breakurl"))
2106 os << "\\usepackage{breakurl}\n";
2107 } else if (features.isRequired("nameref"))
2108 // hyperref loads this automatically
2109 os << "\\usepackage{nameref}\n";
2111 // bibtopic needs to be loaded after hyperref.
2112 // the dot provides the aux file naming which LyX can detect.
2113 if (features.mustProvide("bibtopic"))
2114 os << "\\usepackage[dot]{bibtopic}\n";
2116 // Will be surrounded by \makeatletter and \makeatother when not empty
2117 otexstringstream atlyxpreamble;
2119 // Some macros LyX will need
2121 TexString tmppreamble = features.getMacros();
2122 if (!tmppreamble.str.empty())
2123 atlyxpreamble << "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2124 "LyX specific LaTeX commands.\n"
2125 << move(tmppreamble)
2128 // the text class specific preamble
2130 docstring tmppreamble = features.getTClassPreamble();
2131 if (!tmppreamble.empty())
2132 atlyxpreamble << "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2133 "Textclass specific LaTeX commands.\n"
2137 // suppress date if selected
2138 // use \@ifundefined because we cannot be sure that every document class
2139 // has a \date command
2141 atlyxpreamble << "\\@ifundefined{date}{}{\\date{}}\n";
2143 /* the user-defined preamble */
2144 if (!containsOnly(preamble, " \n\t")) {
2146 atlyxpreamble << "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2147 "User specified LaTeX commands.\n";
2149 // Check if the user preamble contains uncodable glyphs
2150 odocstringstream user_preamble;
2151 docstring uncodable_glyphs;
2152 Encoding const * const enc = features.runparams().encoding;
2154 for (size_t n = 0; n < preamble.size(); ++n) {
2155 char_type c = preamble[n];
2156 if (!enc->encodable(c)) {
2157 docstring const glyph(1, c);
2158 LYXERR0("Uncodable character '"
2160 << "' in user preamble!");
2161 uncodable_glyphs += glyph;
2162 if (features.runparams().dryrun) {
2163 user_preamble << "<" << _("LyX Warning: ")
2164 << _("uncodable character") << " '";
2165 user_preamble.put(c);
2166 user_preamble << "'>";
2169 user_preamble.put(c);
2172 user_preamble << preamble;
2174 // On BUFFER_VIEW|UPDATE, warn user if we found uncodable glyphs
2175 if (!features.runparams().dryrun && !uncodable_glyphs.empty()) {
2176 frontend::Alert::warning(
2177 _("Uncodable character in user preamble"),
2179 _("The user preamble of your document contains glyphs "
2180 "that are unknown in the current document encoding "
2181 "(namely %1$s).\nThese glyphs are omitted "
2182 " from the output, which may result in "
2183 "incomplete output."
2184 "\n\nPlease select an appropriate "
2185 "document encoding\n"
2186 "(such as utf8) or change the "
2187 "preamble code accordingly."),
2190 atlyxpreamble << user_preamble.str() << '\n';
2193 // footmisc must be loaded after setspace
2194 // Load it here to avoid clashes with footmisc loaded in the user
2195 // preamble. For that reason we also pass the options via
2196 // \PassOptionsToPackage in getPreamble() and not here.
2197 if (features.mustProvide("footmisc"))
2198 atlyxpreamble << "\\usepackage{footmisc}\n";
2200 // subfig loads internally the LaTeX package "caption". As
2201 // caption is a very popular package, users will load it in
2202 // the preamble. Therefore we must load subfig behind the
2203 // user-defined preamble and check if the caption package was
2204 // loaded or not. For the case that caption is loaded before
2205 // subfig, there is the subfig option "caption=false". This
2206 // option also works when a koma-script class is used and
2207 // koma's own caption commands are used instead of caption. We
2208 // use \PassOptionsToPackage here because the user could have
2209 // already loaded subfig in the preamble.
2210 if (features.mustProvide("subfig"))
2211 atlyxpreamble << "\\@ifundefined{showcaptionsetup}{}{%\n"
2212 " \\PassOptionsToPackage{caption=false}{subfig}}\n"
2213 "\\usepackage{subfig}\n";
2215 // Itemize bullet settings need to be last in case the user
2216 // defines their own bullets that use a package included
2217 // in the user-defined preamble -- ARRae
2218 // Actually it has to be done much later than that
2219 // since some packages like frenchb make modifications
2220 // at \begin{document} time -- JMarc
2221 docstring bullets_def;
2222 for (int i = 0; i < 4; ++i) {
2223 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
2224 if (bullets_def.empty())
2225 bullets_def += "\\AtBeginDocument{\n";
2226 bullets_def += " \\def\\labelitemi";
2228 // `i' is one less than the item to modify
2235 bullets_def += "ii";
2241 bullets_def += '{' +
2242 user_defined_bullet(i).getText()
2247 if (!bullets_def.empty())
2248 atlyxpreamble << bullets_def << "}\n\n";
2250 if (!atlyxpreamble.empty())
2251 os << "\n\\makeatletter\n"
2252 << atlyxpreamble.release()
2253 << "\\makeatother\n\n";
2255 // We try to load babel late, in case it interferes with other packages.
2256 // Jurabib, hyperref, varioref, bicaption, menukeys and listings (bug 8995)
2257 // have to be called after babel, though.
2258 if (use_babel && !features.isRequired("jurabib")
2259 && !features.isRequired("hyperref")
2260 && !features.isRequired("varioref")
2261 && !features.isRequired("japanese")) {
2262 os << features.getBabelPresettings();
2264 os << from_utf8(babelCall(language_options.str(),
2265 features.needBabelLangOptions())) + '\n';
2266 os << features.getBabelPostsettings();
2268 if (features.isRequired("bicaption"))
2269 os << "\\usepackage{bicaption}\n";
2270 if (!listings_params.empty()
2271 || features.mustProvide("listings")
2272 || features.mustProvide("minted")) {
2274 os << "\\usepackage{minted}\n";
2276 os << "\\usepackage{listings}\n";
2278 string lst_params = listings_params;
2279 // If minted, do not output the language option (bug 11203)
2280 if (use_minted && contains(lst_params, "language=")) {
2281 vector<string> opts =
2282 getVectorFromString(lst_params, ",", false);
2283 for (size_t i = 0; i < opts.size(); ++i) {
2284 if (prefixIs(opts[i], "language="))
2285 opts.erase(opts.begin() + i--);
2287 lst_params = getStringFromVector(opts, ",");
2289 if (!lst_params.empty()) {
2291 os << "\\setminted{";
2294 // do not test validity because listings_params is
2295 // supposed to be valid
2297 InsetListingsParams(lst_params).separatedParams(true);
2298 os << from_utf8(par);
2302 // xunicode only needs to be loaded if tipa is used
2303 // (the rest is obsoleted by the new TU encoding).
2304 // It needs to be loaded at least after amsmath, amssymb,
2305 // esint and the other packages that provide special glyphs
2306 if (features.mustProvide("tipa") && useNonTeXFonts
2307 && !features.isProvided("xunicode")) {
2308 // The package officially only supports XeTeX, but also works
2309 // with LuaTeX. Thus we work around its XeTeX test.
2310 if (features.runparams().flavor != OutputParams::XETEX) {
2311 os << "% Pretend to xunicode that we are XeTeX\n"
2312 << "\\def\\XeTeXpicfile{}\n";
2314 os << "\\usepackage{xunicode}\n";
2317 // covington must be loaded after beamerarticle
2318 if (features.isRequired("covington"))
2319 os << "\\usepackage{covington}\n";
2321 // Polyglossia must be loaded last ...
2322 if (use_polyglossia) {
2324 os << "\\usepackage{polyglossia}\n";
2325 // set the main language
2326 os << "\\setdefaultlanguage";
2327 if (!language->polyglossiaOpts().empty())
2328 os << "[" << from_ascii(language->polyglossiaOpts()) << "]";
2329 os << "{" << from_ascii(language->polyglossia()) << "}\n";
2330 // now setup the other languages
2331 set<string> const polylangs =
2332 features.getPolyglossiaLanguages();
2333 for (set<string>::const_iterator mit = polylangs.begin();
2334 mit != polylangs.end() ; ++mit) {
2335 // We do not output the options here; they are output in
2336 // the language switch commands. This is safer if multiple
2337 // varieties are used.
2338 if (*mit == language->polyglossia())
2340 os << "\\setotherlanguage";
2341 os << "{" << from_ascii(*mit) << "}\n";
2345 // ... but before biblatex (see #7065)
2346 if (features.mustProvide("biblatex")
2347 && !features.isProvided("biblatex-natbib")
2348 && !features.isProvided("natbib-internal")
2349 && !features.isProvided("natbib")
2350 && !features.isProvided("jurabib")) {
2353 os << "\\usepackage";
2354 if (!biblatex_bibstyle.empty()
2355 && (biblatex_bibstyle == biblatex_citestyle)) {
2356 opts = "style=" + biblatex_bibstyle;
2359 if (!biblatex_bibstyle.empty()) {
2360 opts = "bibstyle=" + biblatex_bibstyle;
2363 if (!biblatex_citestyle.empty()) {
2364 opts += delim + "citestyle=" + biblatex_citestyle;
2368 if (!multibib.empty() && multibib != "child") {
2369 opts += delim + "refsection=" + multibib;
2372 if (bibtexCommand() == "bibtex8"
2373 || prefixIs(bibtexCommand(), "bibtex8 ")) {
2374 opts += delim + "backend=bibtex8";
2376 } else if (bibtexCommand() == "bibtex"
2377 || prefixIs(bibtexCommand(), "bibtex ")) {
2378 opts += delim + "backend=bibtex";
2381 if (!bib_encoding.empty() && encodings.fromLyXName(bib_encoding)) {
2382 opts += delim + "bibencoding="
2383 + encodings.fromLyXName(bib_encoding)->latexName();
2386 if (!biblio_opts.empty())
2387 opts += delim + biblio_opts;
2389 os << "[" << opts << "]";
2390 os << "{biblatex}\n";
2394 // Load custom language package here
2395 if (features.langPackage() == LaTeXFeatures::LANG_PACK_CUSTOM) {
2396 if (lang_package == "default")
2397 os << from_utf8(lyxrc.language_custom_package);
2399 os << from_utf8(lang_package);
2403 // Since menukeys uses catoptions, which does some heavy changes on key-value options,
2404 // it is recommended to load menukeys as the last package (even after hyperref)
2405 if (features.isRequired("menukeys"))
2406 os << "\\usepackage{menukeys}\n";
2408 docstring const i18npreamble =
2409 features.getTClassI18nPreamble(use_babel, use_polyglossia,
2411 if (!i18npreamble.empty())
2412 os << i18npreamble + '\n';
2418 void BufferParams::useClassDefaults()
2420 DocumentClass const & tclass = documentClass();
2422 sides = tclass.sides();
2423 columns = tclass.columns();
2424 pagestyle = tclass.pagestyle();
2425 use_default_options = true;
2426 // Only if class has a ToC hierarchy
2427 if (tclass.hasTocLevels()) {
2428 secnumdepth = tclass.secnumdepth();
2429 tocdepth = tclass.tocdepth();
2434 bool BufferParams::hasClassDefaults() const
2436 DocumentClass const & tclass = documentClass();
2438 return sides == tclass.sides()
2439 && columns == tclass.columns()
2440 && pagestyle == tclass.pagestyle()
2441 && use_default_options
2442 && secnumdepth == tclass.secnumdepth()
2443 && tocdepth == tclass.tocdepth();
2447 DocumentClass const & BufferParams::documentClass() const
2453 DocumentClassConstPtr BufferParams::documentClassPtr() const
2459 void BufferParams::setDocumentClass(DocumentClassConstPtr tc)
2461 // evil, but this function is evil
2462 doc_class_ = const_pointer_cast<DocumentClass>(tc);
2463 invalidateConverterCache();
2467 bool BufferParams::setBaseClass(string const & classname, string const & path)
2469 LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
2470 LayoutFileList & bcl = LayoutFileList::get();
2471 if (!bcl.haveClass(classname)) {
2473 bformat(_("The layout file:\n"
2475 "could not be found. A default textclass with default\n"
2476 "layouts will be used. LyX will not be able to produce\n"
2478 from_utf8(classname));
2479 frontend::Alert::error(_("Document class not found"), s);
2480 bcl.addEmptyClass(classname);
2483 bool const success = bcl[classname].load(path);
2486 bformat(_("Due to some error in it, the layout file:\n"
2488 "could not be loaded. A default textclass with default\n"
2489 "layouts will be used. LyX will not be able to produce\n"
2491 from_utf8(classname));
2492 frontend::Alert::error(_("Could not load class"), s);
2493 bcl.addEmptyClass(classname);
2496 pimpl_->baseClass_ = classname;
2497 layout_modules_.adaptToBaseClass(baseClass(), removed_modules_);
2502 LayoutFile const * BufferParams::baseClass() const
2504 if (LayoutFileList::get().haveClass(pimpl_->baseClass_))
2505 return &(LayoutFileList::get()[pimpl_->baseClass_]);
2511 LayoutFileIndex const & BufferParams::baseClassID() const
2513 return pimpl_->baseClass_;
2517 void BufferParams::makeDocumentClass(bool const clone)
2522 invalidateConverterCache();
2523 LayoutModuleList mods;
2524 LayoutModuleList::iterator it = layout_modules_.begin();
2525 LayoutModuleList::iterator en = layout_modules_.end();
2526 for (; it != en; ++it)
2527 mods.push_back(*it);
2529 doc_class_ = getDocumentClass(*baseClass(), mods, cite_engine_, clone);
2531 TextClass::ReturnValues success = TextClass::OK;
2532 if (!forced_local_layout_.empty())
2533 success = doc_class_->read(to_utf8(forced_local_layout_),
2535 if (!local_layout_.empty() &&
2536 (success == TextClass::OK || success == TextClass::OK_OLDFORMAT))
2537 success = doc_class_->read(to_utf8(local_layout_), TextClass::MODULE);
2538 if (success != TextClass::OK && success != TextClass::OK_OLDFORMAT) {
2539 docstring const msg = _("Error reading internal layout information");
2540 frontend::Alert::warning(_("Read Error"), msg);
2545 bool BufferParams::layoutModuleCanBeAdded(string const & modName) const
2547 return layout_modules_.moduleCanBeAdded(modName, baseClass());
2551 docstring BufferParams::getLocalLayout(bool forced) const
2554 return from_utf8(doc_class_->forcedLayouts());
2556 return local_layout_;
2560 void BufferParams::setLocalLayout(docstring const & layout, bool forced)
2563 forced_local_layout_ = layout;
2565 local_layout_ = layout;
2569 bool BufferParams::addLayoutModule(string const & modName)
2571 LayoutModuleList::const_iterator it = layout_modules_.begin();
2572 LayoutModuleList::const_iterator end = layout_modules_.end();
2573 for (; it != end; ++it)
2576 layout_modules_.push_back(modName);
2581 string BufferParams::bufferFormat() const
2583 return documentClass().outputFormat();
2587 bool BufferParams::isExportable(string const & format, bool need_viewable) const
2589 FormatList const & formats = exportableFormats(need_viewable);
2590 FormatList::const_iterator fit = formats.begin();
2591 FormatList::const_iterator end = formats.end();
2592 for (; fit != end ; ++fit) {
2593 if ((*fit)->name() == format)
2600 FormatList const & BufferParams::exportableFormats(bool only_viewable) const
2602 FormatList & cached = only_viewable ?
2603 pimpl_->viewableFormatList : pimpl_->exportableFormatList;
2604 bool & valid = only_viewable ?
2605 pimpl_->isViewCacheValid : pimpl_->isExportCacheValid;
2609 vector<string> const backs = backends();
2610 set<string> excludes;
2611 if (useNonTeXFonts) {
2612 excludes.insert("latex");
2613 excludes.insert("pdflatex");
2616 theConverters().getReachable(backs[0], only_viewable, true, excludes);
2617 for (vector<string>::const_iterator it = backs.begin() + 1;
2618 it != backs.end(); ++it) {
2619 FormatList r = theConverters().getReachable(*it, only_viewable,
2621 result.insert(result.end(), r.begin(), r.end());
2623 sort(result.begin(), result.end(), Format::formatSorter);
2630 vector<string> BufferParams::backends() const
2633 string const buffmt = bufferFormat();
2635 // FIXME: Don't hardcode format names here, but use a flag
2636 if (buffmt == "latex") {
2637 if (encoding().package() == Encoding::japanese)
2638 v.push_back("platex");
2640 if (!useNonTeXFonts) {
2641 v.push_back("pdflatex");
2642 v.push_back("latex");
2644 v.push_back("xetex");
2645 v.push_back("luatex");
2646 v.push_back("dviluatex");
2649 string rbuffmt = buffmt;
2650 // If we use an OutputFormat in Japanese docs,
2651 // we need special format in order to get the path
2652 // via pLaTeX (#8823)
2653 if (documentClass().hasOutputFormat()
2654 && encoding().package() == Encoding::japanese)
2656 v.push_back(rbuffmt);
2659 v.push_back("xhtml");
2660 v.push_back("text");
2666 OutputParams::FLAVOR BufferParams::getOutputFlavor(string const & format) const
2668 string const dformat = (format.empty() || format == "default") ?
2669 getDefaultOutputFormat() : format;
2670 DefaultFlavorCache::const_iterator it =
2671 default_flavors_.find(dformat);
2673 if (it != default_flavors_.end())
2676 OutputParams::FLAVOR result = OutputParams::LATEX;
2678 // FIXME It'd be better not to hardcode this, but to do
2679 // something with formats.
2680 if (dformat == "xhtml")
2681 result = OutputParams::HTML;
2682 else if (dformat == "text")
2683 result = OutputParams::TEXT;
2684 else if (dformat == "lyx")
2685 result = OutputParams::LYX;
2686 else if (dformat == "pdflatex")
2687 result = OutputParams::PDFLATEX;
2688 else if (dformat == "xetex")
2689 result = OutputParams::XETEX;
2690 else if (dformat == "luatex")
2691 result = OutputParams::LUATEX;
2692 else if (dformat == "dviluatex")
2693 result = OutputParams::DVILUATEX;
2695 // Try to determine flavor of default output format
2696 vector<string> backs = backends();
2697 if (find(backs.begin(), backs.end(), dformat) == backs.end()) {
2698 // Get shortest path to format
2699 Graph::EdgePath path;
2700 for (auto const & bvar : backs) {
2701 Graph::EdgePath p = theConverters().getPath(bvar, dformat);
2702 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2707 result = theConverters().getFlavor(path);
2710 // cache this flavor
2711 default_flavors_[dformat] = result;
2716 string BufferParams::getDefaultOutputFormat() const
2718 if (!default_output_format.empty()
2719 && default_output_format != "default")
2720 return default_output_format;
2722 FormatList const & formats = exportableFormats(true);
2723 if (formats.empty())
2725 // return the first we find
2726 return formats.front()->name();
2728 if (encoding().package() == Encoding::japanese)
2729 return lyxrc.default_platex_view_format;
2731 return lyxrc.default_otf_view_format;
2732 return lyxrc.default_view_format;
2735 Font const BufferParams::getFont() const
2737 FontInfo f = documentClass().defaultfont();
2738 if (fonts_default_family == "rmdefault")
2739 f.setFamily(ROMAN_FAMILY);
2740 else if (fonts_default_family == "sfdefault")
2741 f.setFamily(SANS_FAMILY);
2742 else if (fonts_default_family == "ttdefault")
2743 f.setFamily(TYPEWRITER_FAMILY);
2744 return Font(f, language);
2748 InsetQuotesParams::QuoteStyle BufferParams::getQuoteStyle(string const & qs) const
2750 return quotesstyletranslator().find(qs);
2754 bool BufferParams::isLatex() const
2756 return documentClass().outputType() == LATEX;
2760 bool BufferParams::isLiterate() const
2762 return documentClass().outputType() == LITERATE;
2766 bool BufferParams::isDocBook() const
2768 return documentClass().outputType() == DOCBOOK;
2772 void BufferParams::readPreamble(Lexer & lex)
2774 if (lex.getString() != "\\begin_preamble")
2775 lyxerr << "Error (BufferParams::readPreamble):"
2776 "consistency check failed." << endl;
2778 preamble = lex.getLongString(from_ascii("\\end_preamble"));
2782 void BufferParams::readLocalLayout(Lexer & lex, bool forced)
2784 string const expected = forced ? "\\begin_forced_local_layout" :
2785 "\\begin_local_layout";
2786 if (lex.getString() != expected)
2787 lyxerr << "Error (BufferParams::readLocalLayout):"
2788 "consistency check failed." << endl;
2791 forced_local_layout_ =
2792 lex.getLongString(from_ascii("\\end_forced_local_layout"));
2794 local_layout_ = lex.getLongString(from_ascii("\\end_local_layout"));
2798 bool BufferParams::setLanguage(string const & lang)
2800 Language const *new_language = languages.getLanguage(lang);
2801 if (!new_language) {
2802 // Language lang was not found
2805 language = new_language;
2810 void BufferParams::readLanguage(Lexer & lex)
2812 if (!lex.next()) return;
2814 string const tmptok = lex.getString();
2816 // check if tmptok is part of tex_babel in tex-defs.h
2817 if (!setLanguage(tmptok)) {
2818 // Language tmptok was not found
2819 language = default_language;
2820 lyxerr << "Warning: Setting language `"
2821 << tmptok << "' to `" << language->lang()
2827 void BufferParams::readGraphicsDriver(Lexer & lex)
2832 string const tmptok = lex.getString();
2833 // check if tmptok is part of tex_graphics in tex_defs.h
2836 string const test = tex_graphics[n++];
2838 if (test == tmptok) {
2839 graphics_driver = tmptok;
2844 "Warning: graphics driver `$$Token' not recognized!\n"
2845 " Setting graphics driver to `default'.\n");
2846 graphics_driver = "default";
2853 void BufferParams::readBullets(Lexer & lex)
2858 int const index = lex.getInteger();
2860 int temp_int = lex.getInteger();
2861 user_defined_bullet(index).setFont(temp_int);
2862 temp_bullet(index).setFont(temp_int);
2864 user_defined_bullet(index).setCharacter(temp_int);
2865 temp_bullet(index).setCharacter(temp_int);
2867 user_defined_bullet(index).setSize(temp_int);
2868 temp_bullet(index).setSize(temp_int);
2872 void BufferParams::readBulletsLaTeX(Lexer & lex)
2874 // The bullet class should be able to read this.
2877 int const index = lex.getInteger();
2879 docstring const temp_str = lex.getDocString();
2881 user_defined_bullet(index).setText(temp_str);
2882 temp_bullet(index).setText(temp_str);
2886 void BufferParams::readModules(Lexer & lex)
2888 if (!lex.eatLine()) {
2889 lyxerr << "Error (BufferParams::readModules):"
2890 "Unexpected end of input." << endl;
2894 string mod = lex.getString();
2895 if (mod == "\\end_modules")
2897 addLayoutModule(mod);
2903 void BufferParams::readRemovedModules(Lexer & lex)
2905 if (!lex.eatLine()) {
2906 lyxerr << "Error (BufferParams::readRemovedModules):"
2907 "Unexpected end of input." << endl;
2911 string mod = lex.getString();
2912 if (mod == "\\end_removed_modules")
2914 removed_modules_.push_back(mod);
2917 // now we want to remove any removed modules that were previously
2918 // added. normally, that will be because default modules were added in
2919 // setBaseClass(), which gets called when \textclass is read at the
2920 // start of the read.
2921 list<string>::const_iterator rit = removed_modules_.begin();
2922 list<string>::const_iterator const ren = removed_modules_.end();
2923 for (; rit != ren; ++rit) {
2924 LayoutModuleList::iterator const mit = layout_modules_.begin();
2925 LayoutModuleList::iterator const men = layout_modules_.end();
2926 LayoutModuleList::iterator found = find(mit, men, *rit);
2929 layout_modules_.erase(found);
2934 void BufferParams::readIncludeonly(Lexer & lex)
2936 if (!lex.eatLine()) {
2937 lyxerr << "Error (BufferParams::readIncludeonly):"
2938 "Unexpected end of input." << endl;
2942 string child = lex.getString();
2943 if (child == "\\end_includeonly")
2945 included_children_.push_back(child);
2951 string BufferParams::paperSizeName(PapersizePurpose purpose) const
2953 switch (papersize) {
2955 // could be anything, so don't guess
2957 case PAPER_CUSTOM: {
2958 if (purpose == XDVI && !paperwidth.empty() &&
2959 !paperheight.empty()) {
2960 // heightxwidth<unit>
2961 string first = paperwidth;
2962 string second = paperheight;
2963 if (orientation == ORIENTATION_LANDSCAPE)
2966 return first.erase(first.length() - 2)
2972 // dvips and dvipdfm do not know this
2973 if (purpose == DVIPS || purpose == DVIPDFM)
2977 if (purpose == DVIPS || purpose == DVIPDFM)
2981 if (purpose == DVIPS || purpose == DVIPDFM)
2991 if (purpose == DVIPS || purpose == DVIPDFM)
2995 if (purpose == DVIPS || purpose == DVIPDFM)
2999 if (purpose == DVIPS || purpose == DVIPDFM)
3003 if (purpose == DVIPS || purpose == DVIPDFM)
3007 if (purpose == DVIPS || purpose == DVIPDFM)
3011 // dvipdfm does not know this
3012 if (purpose == DVIPDFM)
3016 if (purpose == DVIPDFM)
3020 if (purpose == DVIPS || purpose == DVIPDFM)
3024 if (purpose == DVIPS || purpose == DVIPDFM)
3028 if (purpose == DVIPS || purpose == DVIPDFM)
3032 if (purpose == DVIPS || purpose == DVIPDFM)
3036 if (purpose == DVIPS || purpose == DVIPDFM)
3040 if (purpose == DVIPS || purpose == DVIPDFM)
3044 if (purpose == DVIPS || purpose == DVIPDFM)
3048 if (purpose == DVIPS || purpose == DVIPDFM)
3052 if (purpose == DVIPS || purpose == DVIPDFM)
3056 if (purpose == DVIPS || purpose == DVIPDFM)
3060 if (purpose == DVIPS || purpose == DVIPDFM)
3064 if (purpose == DVIPS || purpose == DVIPDFM)
3068 if (purpose == DVIPS || purpose == DVIPDFM)
3072 if (purpose == DVIPS || purpose == DVIPDFM)
3076 if (purpose == DVIPS || purpose == DVIPDFM)
3079 case PAPER_USEXECUTIVE:
3080 // dvipdfm does not know this
3081 if (purpose == DVIPDFM)
3086 case PAPER_USLETTER:
3088 if (purpose == XDVI)
3095 string const BufferParams::dvips_options() const
3099 // If the class loads the geometry package, we do not know which
3100 // paper size is used, since we do not set it (bug 7013).
3101 // Therefore we must not specify any argument here.
3102 // dvips gets the correct paper size via DVI specials in this case
3103 // (if the class uses the geometry package correctly).
3104 if (documentClass().provides("geometry"))
3108 && papersize == PAPER_CUSTOM
3109 && !lyxrc.print_paper_dimension_flag.empty()
3110 && !paperwidth.empty()
3111 && !paperheight.empty()) {
3112 // using a custom papersize
3113 result = lyxrc.print_paper_dimension_flag;
3114 result += ' ' + paperwidth;
3115 result += ',' + paperheight;
3117 string const paper_option = paperSizeName(DVIPS);
3118 if (!paper_option.empty() && (paper_option != "letter" ||
3119 orientation != ORIENTATION_LANDSCAPE)) {
3120 // dvips won't accept -t letter -t landscape.
3121 // In all other cases, include the paper size
3123 result = lyxrc.print_paper_flag;
3124 result += ' ' + paper_option;
3127 if (orientation == ORIENTATION_LANDSCAPE &&
3128 papersize != PAPER_CUSTOM)
3129 result += ' ' + lyxrc.print_landscape_flag;
3134 string const BufferParams::main_font_encoding() const
3136 if (font_encodings().empty()) {
3137 if (ascii_lowercase(language->fontenc(*this)) == "none")
3141 return font_encodings().back();
3145 vector<string> const BufferParams::font_encodings() const
3147 string doc_fontenc = (fontenc == "auto") ? string() : fontenc;
3149 vector<string> fontencs;
3151 // "default" means "no explicit font encoding"
3152 if (doc_fontenc != "default") {
3153 if (!doc_fontenc.empty())
3154 // If we have a custom setting, we use only that!
3155 return getVectorFromString(doc_fontenc);
3156 if (!language->fontenc(*this).empty()
3157 && ascii_lowercase(language->fontenc(*this)) != "none") {
3158 vector<string> fencs = getVectorFromString(language->fontenc(*this));
3159 for (auto & fe : fencs) {
3160 if (find(fontencs.begin(), fontencs.end(), fe) == fontencs.end())
3161 fontencs.push_back(fe);
3170 string BufferParams::babelCall(string const & lang_opts, bool const langoptions) const
3172 // suppress the babel call if there is no BabelName defined
3173 // for the document language in the lib/languages file and if no
3174 // other languages are used (lang_opts is then empty)
3175 if (lang_opts.empty())
3177 // either a specific language (AsBabelOptions setting in
3178 // lib/languages) or the prefs require the languages to
3179 // be submitted to babel itself (not the class).
3181 return "\\usepackage[" + lang_opts + "]{babel}";
3182 return "\\usepackage{babel}";
3186 docstring BufferParams::getGraphicsDriver(string const & package) const
3190 if (package == "geometry") {
3191 if (graphics_driver == "dvips"
3192 || graphics_driver == "dvipdfm"
3193 || graphics_driver == "pdftex"
3194 || graphics_driver == "vtex")
3195 result = from_ascii(graphics_driver);
3196 else if (graphics_driver == "dvipdfmx")
3197 result = from_ascii("dvipdfm");
3204 void BufferParams::writeEncodingPreamble(otexstream & os,
3205 LaTeXFeatures & features) const
3207 // XeTeX/LuaTeX: (see also #9740)
3208 // With Unicode fonts we use utf8-plain without encoding package.
3209 // With TeX fonts, we cannot use utf8-plain, but "inputenc" fails.
3210 // XeTeX must use ASCII encoding (see Buffer.cpp),
3211 // for LuaTeX, we load "luainputenc" (see below).
3212 if (useNonTeXFonts || features.runparams().flavor == OutputParams::XETEX)
3215 if (inputenc == "auto") {
3216 string const doc_encoding =
3217 language->encoding()->latexName();
3218 Encoding::Package const package =
3219 language->encoding()->package();
3221 // Create list of inputenc options:
3222 set<string> encoding_set;
3223 // luainputenc fails with more than one encoding
3224 if (!features.runparams().isFullUnicode()) // if we reach this point, this means LuaTeX with TeX fonts
3225 // list all input encodings used in the document
3226 encoding_set = features.getEncodingSet(doc_encoding);
3228 // If the "japanese" package (i.e. pLaTeX) is used,
3229 // inputenc must be omitted.
3230 // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
3231 if ((!encoding_set.empty() || package == Encoding::inputenc)
3232 && !features.isRequired("japanese")
3233 && !features.isProvided("inputenc")) {
3234 os << "\\usepackage[";
3235 set<string>::const_iterator it = encoding_set.begin();
3236 set<string>::const_iterator const end = encoding_set.end();
3238 os << from_ascii(*it);
3241 for (; it != end; ++it)
3242 os << ',' << from_ascii(*it);
3243 if (package == Encoding::inputenc) {
3244 if (!encoding_set.empty())
3246 os << from_ascii(doc_encoding);
3248 if (features.runparams().flavor == OutputParams::LUATEX
3249 || features.runparams().flavor == OutputParams::DVILUATEX)
3250 os << "]{luainputenc}\n";
3252 os << "]{inputenc}\n";
3254 } else if (inputenc != "default") {
3255 switch (encoding().package()) {
3256 case Encoding::none:
3258 case Encoding::japanese:
3260 case Encoding::inputenc:
3261 // do not load inputenc if japanese is used
3262 // or if the class provides inputenc
3263 if (features.isRequired("japanese")
3264 || features.isProvided("inputenc"))
3266 os << "\\usepackage[" << from_ascii(encoding().latexName());
3267 if (features.runparams().flavor == OutputParams::LUATEX
3268 || features.runparams().flavor == OutputParams::DVILUATEX)
3269 os << "]{luainputenc}\n";
3271 os << "]{inputenc}\n";
3278 string const BufferParams::parseFontName(string const & name) const
3280 string mangled = name;
3281 size_t const idx = mangled.find('[');
3282 if (idx == string::npos || idx == 0)
3285 return mangled.substr(0, idx - 1);
3289 string const BufferParams::loadFonts(LaTeXFeatures & features) const
3291 if (fontsRoman() == "default" && fontsSans() == "default"
3292 && fontsTypewriter() == "default"
3293 && (fontsMath() == "default" || fontsMath() == "auto"))
3299 /* Fontspec (XeTeX, LuaTeX): we provide GUI support for oldstyle
3300 * numbers (Numbers=OldStyle) and sf/tt scaling. The Ligatures=TeX/
3301 * Mapping=tex-text option assures TeX ligatures (such as "--")
3302 * are resolved. Note that tt does not use these ligatures.
3304 * -- add more GUI options?
3305 * -- add more fonts (fonts for other scripts)
3306 * -- if there's a way to find out if a font really supports
3307 * OldStyle, enable/disable the widget accordingly.
3309 if (useNonTeXFonts && features.isAvailable("fontspec")) {
3310 // "Mapping=tex-text" and "Ligatures=TeX" are equivalent.
3311 // However, until v.2 (2010/07/11) fontspec only knew
3312 // Mapping=tex-text (for XeTeX only); then "Ligatures=TeX"
3313 // was introduced for both XeTeX and LuaTeX (LuaTeX
3314 // didn't understand "Mapping=tex-text", while XeTeX
3315 // understood both. With most recent versions, both
3316 // variants are understood by both engines. However,
3317 // we want to provide support for at least TeXLive 2009
3318 // (for XeTeX; LuaTeX is only supported as of v.2)
3319 string const texmapping =
3320 (features.runparams().flavor == OutputParams::XETEX) ?
3321 "Mapping=tex-text" : "Ligatures=TeX";
3322 if (fontsRoman() != "default") {
3323 os << "\\setmainfont[" << texmapping;
3324 if (fonts_old_figures)
3325 os << ",Numbers=OldStyle";
3326 os << "]{" << parseFontName(fontsRoman()) << "}\n";
3328 if (fontsSans() != "default") {
3329 string const sans = parseFontName(fontsSans());
3330 if (fontsSansScale() != 100)
3331 os << "\\setsansfont[Scale="
3332 << float(fontsSansScale()) / 100
3333 << "," << texmapping << "]{"
3336 os << "\\setsansfont[" << texmapping << "]{"
3339 if (fontsTypewriter() != "default") {
3340 string const mono = parseFontName(fontsTypewriter());
3341 if (fontsTypewriterScale() != 100)
3342 os << "\\setmonofont[Scale="
3343 << float(fontsTypewriterScale()) / 100
3347 os << "\\setmonofont{"
3354 bool const ot1 = (main_font_encoding() == "default" || main_font_encoding() == "OT1");
3355 bool const dryrun = features.runparams().dryrun;
3356 bool const complete = (fontsSans() == "default" && fontsTypewriter() == "default");
3357 bool const nomath = (fontsMath() == "default");
3360 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsRoman())).getLaTeXCode(
3361 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3365 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsSans())).getLaTeXCode(
3366 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3367 nomath, fontsSansScale());
3369 // MONOSPACED/TYPEWRITER
3370 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsTypewriter())).getLaTeXCode(
3371 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3372 nomath, fontsTypewriterScale());
3375 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsMath())).getLaTeXCode(
3376 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3383 Encoding const & BufferParams::encoding() const
3385 // Main encoding for LaTeX output.
3387 // Exception: XeTeX with 8-bit TeX fonts requires ASCII (see #9740).
3388 // As the "flavor" is only known once export started, this
3389 // cannot be handled here. Instead, runparams.encoding is set
3390 // to ASCII in Buffer::makeLaTeXFile (for export)
3391 // and Buffer::writeLaTeXSource (for preview).
3393 return *(encodings.fromLyXName("utf8-plain"));
3394 if (inputenc == "auto" || inputenc == "default")
3395 return *language->encoding();
3396 Encoding const * const enc = encodings.fromLyXName(inputenc);
3399 LYXERR0("Unknown inputenc value `" << inputenc
3400 << "'. Using `auto' instead.");
3401 return *language->encoding();
3405 string const & BufferParams::defaultBiblioStyle() const
3407 if (!biblio_style.empty())
3408 return biblio_style;
3410 map<string, string> const & bs = documentClass().defaultBiblioStyle();
3411 auto cit = bs.find(theCiteEnginesList.getTypeAsString(citeEngineType()));
3412 if (cit != bs.end())
3415 return empty_string();
3419 bool const & BufferParams::fullAuthorList() const
3421 return documentClass().fullAuthorList();
3425 string BufferParams::getCiteAlias(string const & s) const
3427 vector<string> commands =
3428 documentClass().citeCommands(citeEngineType());
3429 // If it is a real command, don't treat it as an alias
3430 if (find(commands.begin(), commands.end(), s) != commands.end())
3432 map<string,string> aliases = documentClass().citeCommandAliases();
3433 if (aliases.find(s) != aliases.end())
3439 vector<string> BufferParams::citeCommands() const
3441 static CitationStyle const default_style;
3442 vector<string> commands =
3443 documentClass().citeCommands(citeEngineType());
3444 if (commands.empty())
3445 commands.push_back(default_style.name);
3450 vector<CitationStyle> BufferParams::citeStyles() const
3452 static CitationStyle const default_style;
3453 vector<CitationStyle> styles =
3454 documentClass().citeStyles(citeEngineType());
3456 styles.push_back(default_style);
3461 string const BufferParams::bibtexCommand() const
3463 // Return document-specific setting if available
3464 if (bibtex_command != "default")
3465 return bibtex_command;
3467 // If we have "default" in document settings, consult the prefs
3468 // 1. Japanese (uses a specific processor)
3469 if (encoding().package() == Encoding::japanese) {
3470 if (lyxrc.jbibtex_command != "automatic")
3471 // Return the specified program, if "automatic" is not set
3472 return lyxrc.jbibtex_command;
3473 else if (!useBiblatex()) {
3474 // With classic BibTeX, return pbibtex, jbibtex, bibtex
3475 if (lyxrc.jbibtex_alternatives.find("pbibtex") != lyxrc.jbibtex_alternatives.end())
3477 if (lyxrc.jbibtex_alternatives.find("jbibtex") != lyxrc.jbibtex_alternatives.end())
3482 // 2. All other languages
3483 else if (lyxrc.bibtex_command != "automatic")
3484 // Return the specified program, if "automatic" is not set
3485 return lyxrc.bibtex_command;
3487 // 3. Automatic: find the most suitable for the current cite framework
3488 if (useBiblatex()) {
3489 // For Biblatex, we prefer biber (also for Japanese)
3490 // and fall back to bibtex8 and, as last resort, bibtex
3491 if (lyxrc.bibtex_alternatives.find("biber") != lyxrc.bibtex_alternatives.end())
3493 else if (lyxrc.bibtex_alternatives.find("bibtex8") != lyxrc.bibtex_alternatives.end())
3500 bool BufferParams::useBiblatex() const
3502 return theCiteEnginesList[citeEngine()]->getCiteFramework() == "biblatex";
3506 void BufferParams::invalidateConverterCache() const
3508 pimpl_->isExportCacheValid = false;
3509 pimpl_->isViewCacheValid = false;
3513 // We shouldn't need to reset the params here, since anything
3514 // we need will be recopied.
3515 void BufferParams::copyForAdvFR(const BufferParams & bp)
3517 string const & lang = bp.language->lang();
3519 layout_modules_ = bp.layout_modules_;
3520 string const & doc_class = bp.documentClass().name();
3521 setBaseClass(doc_class);