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_.push_back("basic");
384 cite_engine_type_ = ENGINE_TYPE_DEFAULT;
386 paragraph_separation = ParagraphIndentSeparation;
387 is_math_indent = false;
388 quotes_style = InsetQuotesParams::EnglishQuotes;
389 dynamic_quotes = false;
390 fontsize = "default";
393 papersize = PAPER_DEFAULT;
394 orientation = ORIENTATION_PORTRAIT;
395 use_geometry = false;
396 biblio_style = "plain";
397 use_bibtopic = false;
400 save_transient_properties = true;
401 track_changes = false;
402 output_changes = false;
403 use_default_options = true;
404 maintain_unincluded_children = false;
407 language = default_language;
409 fonts_roman[0] = "default";
410 fonts_roman[1] = "default";
411 fonts_sans[0] = "default";
412 fonts_sans[1] = "default";
413 fonts_typewriter[0] = "default";
414 fonts_typewriter[1] = "default";
415 fonts_math[0] = "auto";
416 fonts_math[1] = "auto";
417 fonts_default_family = "default";
418 useNonTeXFonts = false;
419 use_microtype = false;
420 use_dash_ligatures = true;
421 fonts_expert_sc = false;
422 fonts_old_figures = false;
423 fonts_sans_scale[0] = 100;
424 fonts_sans_scale[1] = 100;
425 fonts_typewriter_scale[0] = 100;
426 fonts_typewriter_scale[1] = 100;
428 lang_package = "default";
429 graphics_driver = "default";
430 default_output_format = "default";
431 bibtex_command = "default";
432 index_command = "default";
435 listings_params = string();
436 pagestyle = "default";
437 suppress_date = false;
438 justification = true;
439 // no color is the default (white)
440 backgroundcolor = lyx::rgbFromHexName("#ffffff");
441 isbackgroundcolor = false;
442 // no color is the default (black)
443 fontcolor = lyx::rgbFromHexName("#000000");
445 // light gray is the default font color for greyed-out notes
446 notefontcolor = lyx::rgbFromHexName("#cccccc");
447 boxbgcolor = lyx::rgbFromHexName("#ff0000");
448 compressed = lyxrc.save_compressed;
449 for (int iter = 0; iter < 4; ++iter) {
450 user_defined_bullet(iter) = ITEMIZE_DEFAULTS[iter];
451 temp_bullet(iter) = ITEMIZE_DEFAULTS[iter];
454 indiceslist().addDefault(B_("Index"));
455 html_be_strict = false;
456 html_math_output = MathML;
457 html_math_img_scale = 1.0;
458 html_css_as_file = false;
459 display_pixel_ratio = 1.0;
464 // map current author
465 author_map_[pimpl_->authorlist.get(0).bufferId()] = 0;
469 docstring BufferParams::B_(string const & l10n) const
471 LASSERT(language, return from_utf8(l10n));
472 return getMessages(language->code()).get(l10n);
476 BufferParams::Package BufferParams::use_package(std::string const & p) const
478 PackageMap::const_iterator it = use_packages.find(p);
479 if (it == use_packages.end())
485 void BufferParams::use_package(std::string const & p, BufferParams::Package u)
491 map<string, string> const & BufferParams::auto_packages()
493 static map<string, string> packages;
494 if (packages.empty()) {
495 // We could have a race condition here that two threads
496 // discover an empty map at the same time and want to fill
497 // it, but that is no problem, since the same contents is
498 // filled in twice then. Having the locker inside the
499 // packages.empty() condition has the advantage that we
500 // don't need the mutex overhead for simple reading.
502 Mutex::Locker locker(&mutex);
503 // adding a package here implies a file format change!
504 packages["amsmath"] =
505 N_("The LaTeX package amsmath is only used if AMS formula types or symbols from the AMS math toolbars are inserted into formulas");
506 packages["amssymb"] =
507 N_("The LaTeX package amssymb is only used if symbols from the AMS math toolbars are inserted into formulas");
509 N_("The LaTeX package cancel is only used if \\cancel commands are used in formulas");
511 N_("The LaTeX package esint is only used if special integral symbols are inserted into formulas");
512 packages["mathdots"] =
513 N_("The LaTeX package mathdots is only used if the command \\iddots is inserted into formulas");
514 packages["mathtools"] =
515 N_("The LaTeX package mathtools is only used if some mathematical relations are inserted into formulas");
517 N_("The LaTeX package mhchem is only used if either the command \\ce or \\cf is inserted into formulas");
518 packages["stackrel"] =
519 N_("The LaTeX package stackrel is only used if the command \\stackrel with subscript is inserted into formulas");
520 packages["stmaryrd"] =
521 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");
522 packages["undertilde"] =
523 N_("The LaTeX package undertilde is only used if you use the math frame decoration 'utilde'");
529 bool BufferParams::useBibtopic() const
533 return (use_bibtopic || (!multibib.empty() && multibib != "child"));
537 AuthorList & BufferParams::authors()
539 return pimpl_->authorlist;
543 AuthorList const & BufferParams::authors() const
545 return pimpl_->authorlist;
549 void BufferParams::addAuthor(Author a)
551 author_map_[a.bufferId()] = pimpl_->authorlist.record(a);
555 BranchList & BufferParams::branchlist()
557 return pimpl_->branchlist;
561 BranchList const & BufferParams::branchlist() const
563 return pimpl_->branchlist;
567 IndicesList & BufferParams::indiceslist()
569 return pimpl_->indiceslist;
573 IndicesList const & BufferParams::indiceslist() const
575 return pimpl_->indiceslist;
579 Bullet & BufferParams::temp_bullet(lyx::size_type const index)
581 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
582 return pimpl_->temp_bullets[index];
586 Bullet const & BufferParams::temp_bullet(lyx::size_type const index) const
588 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
589 return pimpl_->temp_bullets[index];
593 Bullet & BufferParams::user_defined_bullet(lyx::size_type const index)
595 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
596 return pimpl_->user_defined_bullets[index];
600 Bullet const & BufferParams::user_defined_bullet(lyx::size_type const index) const
602 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
603 return pimpl_->user_defined_bullets[index];
607 Spacing & BufferParams::spacing()
609 return pimpl_->spacing;
613 Spacing const & BufferParams::spacing() const
615 return pimpl_->spacing;
619 PDFOptions & BufferParams::pdfoptions()
621 return pimpl_->pdfoptions;
625 PDFOptions const & BufferParams::pdfoptions() const
627 return pimpl_->pdfoptions;
631 Length const & BufferParams::getMathIndent() const
633 return pimpl_->mathindent;
637 void BufferParams::setMathIndent(Length const & indent)
639 pimpl_->mathindent = indent;
643 Length const & BufferParams::getParIndent() const
645 return pimpl_->parindent;
649 void BufferParams::setParIndent(Length const & indent)
651 pimpl_->parindent = indent;
655 VSpace const & BufferParams::getDefSkip() const
657 return pimpl_->defskip;
661 void BufferParams::setDefSkip(VSpace const & vs)
663 // DEFSKIP will cause an infinite loop
664 LASSERT(vs.kind() != VSpace::DEFSKIP, return);
665 pimpl_->defskip = vs;
669 string BufferParams::readToken(Lexer & lex, string const & token,
670 FileName const & filepath)
674 if (token == "\\textclass") {
676 string const classname = lex.getString();
677 // if there exists a local layout file, ignore the system one
678 // NOTE: in this case, the textclass (.cls file) is assumed to
681 LayoutFileList & bcl = LayoutFileList::get();
682 if (!filepath.empty()) {
683 // If classname is an absolute path, the document is
684 // using a local layout file which could not be accessed
685 // by a relative path. In this case the path is correct
686 // even if the document was moved to a different
687 // location. However, we will have a problem if the
688 // document was generated on a different platform.
689 bool isabsolute = FileName::isAbsolute(classname);
690 string const classpath = onlyPath(classname);
691 string const path = isabsolute ? classpath
692 : FileName(addPath(filepath.absFileName(),
693 classpath)).realPath();
694 string const oldpath = isabsolute ? string()
695 : FileName(addPath(origin, classpath)).realPath();
696 tcp = bcl.addLocalLayout(onlyFileName(classname), path, oldpath);
698 // that returns non-empty if a "local" layout file is found.
700 result = to_utf8(makeRelPath(from_utf8(onlyPath(tcp)),
701 from_utf8(filepath.absFileName())));
704 setBaseClass(onlyFileName(tcp));
706 setBaseClass(onlyFileName(classname));
707 // We assume that a tex class exists for local or unknown
708 // layouts so this warning, will only be given for system layouts.
709 if (!baseClass()->isTeXClassAvailable()) {
710 docstring const desc =
711 translateIfPossible(from_utf8(baseClass()->description()));
712 docstring const prereqs =
713 from_utf8(baseClass()->prerequisites());
714 docstring const msg =
715 bformat(_("The selected document class\n"
717 "requires external files that are not available.\n"
718 "The document class can still be used, but the\n"
719 "document cannot be compiled until the following\n"
720 "prerequisites are installed:\n"
722 "See section 3.1.2.2 (Class Availability) of the\n"
723 "User's Guide for more information."), desc, prereqs);
724 frontend::Alert::warning(_("Document class not available"),
727 } else if (token == "\\save_transient_properties") {
728 lex >> save_transient_properties;
729 } else if (token == "\\origin") {
731 origin = lex.getString();
732 string const sysdirprefix = "/systemlyxdir/";
733 if (prefixIs(origin, sysdirprefix)) {
735 if (inSystemDir(filepath, docsys))
736 origin.replace(0, sysdirprefix.length() - 1, docsys);
738 origin.replace(0, sysdirprefix.length() - 1,
739 package().system_support().absFileName());
741 } else if (token == "\\begin_preamble") {
743 } else if (token == "\\begin_local_layout") {
744 readLocalLayout(lex, false);
745 } else if (token == "\\begin_forced_local_layout") {
746 readLocalLayout(lex, true);
747 } else if (token == "\\begin_modules") {
749 } else if (token == "\\begin_removed_modules") {
750 readRemovedModules(lex);
751 } else if (token == "\\begin_includeonly") {
752 readIncludeonly(lex);
753 } else if (token == "\\maintain_unincluded_children") {
754 lex >> maintain_unincluded_children;
755 } else if (token == "\\options") {
757 options = lex.getString();
758 } else if (token == "\\use_default_options") {
759 lex >> use_default_options;
760 } else if (token == "\\master") {
762 master = lex.getString();
763 if (!filepath.empty() && FileName::isAbsolute(origin)) {
764 bool const isabs = FileName::isAbsolute(master);
765 FileName const abspath(isabs ? master : origin + master);
766 bool const moved = filepath != FileName(origin);
767 if (moved && abspath.exists()) {
768 docstring const path = isabs
770 : from_utf8(abspath.realPath());
771 docstring const refpath =
772 from_utf8(filepath.absFileName());
773 master = to_utf8(makeRelPath(path, refpath));
776 } else if (token == "\\suppress_date") {
777 lex >> suppress_date;
778 } else if (token == "\\justification") {
779 lex >> justification;
780 } else if (token == "\\language") {
782 } else if (token == "\\language_package") {
784 lang_package = lex.getString();
785 } else if (token == "\\inputencoding") {
787 } else if (token == "\\graphics") {
788 readGraphicsDriver(lex);
789 } else if (token == "\\default_output_format") {
790 lex >> default_output_format;
791 } else if (token == "\\bibtex_command") {
793 bibtex_command = lex.getString();
794 } else if (token == "\\index_command") {
796 index_command = lex.getString();
797 } else if (token == "\\fontencoding") {
799 fontenc = lex.getString();
800 } else if (token == "\\font_roman") {
801 lex >> fonts_roman[0];
802 lex >> fonts_roman[1];
803 } else if (token == "\\font_sans") {
804 lex >> fonts_sans[0];
805 lex >> fonts_sans[1];
806 } else if (token == "\\font_typewriter") {
807 lex >> fonts_typewriter[0];
808 lex >> fonts_typewriter[1];
809 } else if (token == "\\font_math") {
810 lex >> fonts_math[0];
811 lex >> fonts_math[1];
812 } else if (token == "\\font_default_family") {
813 lex >> fonts_default_family;
814 } else if (token == "\\use_non_tex_fonts") {
815 lex >> useNonTeXFonts;
816 } else if (token == "\\font_sc") {
817 lex >> fonts_expert_sc;
818 } else if (token == "\\font_osf") {
819 lex >> fonts_old_figures;
820 } else if (token == "\\font_sf_scale") {
821 lex >> fonts_sans_scale[0];
822 lex >> fonts_sans_scale[1];
823 } else if (token == "\\font_tt_scale") {
824 lex >> fonts_typewriter_scale[0];
825 lex >> fonts_typewriter_scale[1];
826 } else if (token == "\\font_cjk") {
828 } else if (token == "\\use_microtype") {
829 lex >> use_microtype;
830 } else if (token == "\\use_dash_ligatures") {
831 lex >> use_dash_ligatures;
832 } else if (token == "\\paragraph_separation") {
835 paragraph_separation = parseptranslator().find(parsep);
836 } else if (token == "\\paragraph_indentation") {
838 string parindent = lex.getString();
839 if (parindent == "default")
840 pimpl_->parindent = Length();
842 pimpl_->parindent = Length(parindent);
843 } else if (token == "\\defskip") {
845 string const defskip = lex.getString();
846 pimpl_->defskip = VSpace(defskip);
847 if (pimpl_->defskip.kind() == VSpace::DEFSKIP)
849 pimpl_->defskip = VSpace(VSpace::MEDSKIP);
850 } else if (token == "\\is_math_indent") {
851 lex >> is_math_indent;
852 } else if (token == "\\math_indentation") {
854 pimpl_->mathindent = Length(lex.getString());
855 } else if (token == "\\quotes_style") {
858 quotes_style = quotesstyletranslator().find(qstyle);
859 } else if (token == "\\dynamic_quotes") {
860 lex >> dynamic_quotes;
861 } else if (token == "\\papersize") {
864 papersize = papersizetranslator().find(ppsize);
865 } else if (token == "\\use_geometry") {
867 } else if (token == "\\use_package") {
872 use_package(package, packagetranslator().find(use));
873 } else if (token == "\\cite_engine") {
875 vector<string> engine = getVectorFromString(lex.getString());
876 setCiteEngine(engine);
877 } else if (token == "\\cite_engine_type") {
880 cite_engine_type_ = theCiteEnginesList.getType(engine_type);
881 } else if (token == "\\biblio_style") {
883 biblio_style = lex.getString();
884 } else if (token == "\\biblio_options") {
886 biblio_opts = trim(lex.getString());
887 } else if (token == "\\biblatex_bibstyle") {
889 biblatex_bibstyle = trim(lex.getString());
890 } else if (token == "\\biblatex_citestyle") {
892 biblatex_citestyle = trim(lex.getString());
893 } else if (token == "\\use_bibtopic") {
895 } else if (token == "\\multibib") {
897 } else if (token == "\\use_indices") {
899 } else if (token == "\\tracking_changes") {
900 lex >> track_changes;
901 } else if (token == "\\output_changes") {
902 lex >> output_changes;
903 } else if (token == "\\branch") {
905 docstring branch = lex.getDocString();
906 branchlist().add(branch);
909 string const tok = lex.getString();
910 if (tok == "\\end_branch")
912 Branch * branch_ptr = branchlist().find(branch);
913 if (tok == "\\selected") {
916 branch_ptr->setSelected(lex.getInteger());
918 if (tok == "\\filename_suffix") {
921 branch_ptr->setFileNameSuffix(lex.getInteger());
923 if (tok == "\\color") {
925 string color = lex.getString();
927 branch_ptr->setColor(color);
928 // Update also the Color table:
930 color = lcolor.getX11Name(Color_background);
932 lcolor.setColor(to_utf8(branch), color);
935 } else if (token == "\\index") {
937 docstring index = lex.getDocString();
939 indiceslist().add(index);
942 string const tok = lex.getString();
943 if (tok == "\\end_index")
945 Index * index_ptr = indiceslist().find(index);
946 if (tok == "\\shortcut") {
948 shortcut = lex.getDocString();
950 index_ptr->setShortcut(shortcut);
952 if (tok == "\\color") {
954 string color = lex.getString();
956 index_ptr->setColor(color);
957 // Update also the Color table:
959 color = lcolor.getX11Name(Color_background);
961 if (!shortcut.empty())
962 lcolor.setColor(to_utf8(shortcut), color);
965 } else if (token == "\\author") {
967 istringstream ss(lex.getString());
971 } else if (token == "\\paperorientation") {
974 orientation = paperorientationtranslator().find(orient);
975 } else if (token == "\\backgroundcolor") {
977 backgroundcolor = lyx::rgbFromHexName(lex.getString());
978 isbackgroundcolor = true;
979 } else if (token == "\\fontcolor") {
981 fontcolor = lyx::rgbFromHexName(lex.getString());
983 } else if (token == "\\notefontcolor") {
985 string color = lex.getString();
986 notefontcolor = lyx::rgbFromHexName(color);
987 lcolor.setColor("notefontcolor", color);
988 } else if (token == "\\boxbgcolor") {
990 string color = lex.getString();
991 boxbgcolor = lyx::rgbFromHexName(color);
992 lcolor.setColor("boxbgcolor", color);
993 } else if (token == "\\paperwidth") {
995 } else if (token == "\\paperheight") {
997 } else if (token == "\\leftmargin") {
999 } else if (token == "\\topmargin") {
1001 } else if (token == "\\rightmargin") {
1003 } else if (token == "\\bottommargin") {
1004 lex >> bottommargin;
1005 } else if (token == "\\headheight") {
1007 } else if (token == "\\headsep") {
1009 } else if (token == "\\footskip") {
1011 } else if (token == "\\columnsep") {
1013 } else if (token == "\\paperfontsize") {
1015 } else if (token == "\\papercolumns") {
1017 } else if (token == "\\listings_params") {
1020 listings_params = InsetListingsParams(par).params();
1021 } else if (token == "\\papersides") {
1024 sides = sidestranslator().find(psides);
1025 } else if (token == "\\paperpagestyle") {
1027 } else if (token == "\\bullet") {
1029 } else if (token == "\\bulletLaTeX") {
1030 readBulletsLaTeX(lex);
1031 } else if (token == "\\secnumdepth") {
1033 } else if (token == "\\tocdepth") {
1035 } else if (token == "\\spacing") {
1039 if (nspacing == "other") {
1042 spacing().set(spacetranslator().find(nspacing), tmp_val);
1043 } else if (token == "\\float_placement") {
1044 lex >> float_placement;
1046 } else if (prefixIs(token, "\\pdf_") || token == "\\use_hyperref") {
1047 string toktmp = pdfoptions().readToken(lex, token);
1048 if (!toktmp.empty()) {
1049 lyxerr << "PDFOptions::readToken(): Unknown token: " <<
1053 } else if (token == "\\html_math_output") {
1056 html_math_output = static_cast<MathOutput>(temp);
1057 } else if (token == "\\html_be_strict") {
1058 lex >> html_be_strict;
1059 } else if (token == "\\html_css_as_file") {
1060 lex >> html_css_as_file;
1061 } else if (token == "\\html_math_img_scale") {
1062 lex >> html_math_img_scale;
1063 } else if (token == "\\html_latex_start") {
1065 html_latex_start = lex.getString();
1066 } else if (token == "\\html_latex_end") {
1068 html_latex_end = lex.getString();
1069 } else if (token == "\\output_sync") {
1071 } else if (token == "\\output_sync_macro") {
1072 lex >> output_sync_macro;
1073 } else if (token == "\\use_refstyle") {
1074 lex >> use_refstyle;
1076 lyxerr << "BufferParams::readToken(): Unknown token: " <<
1086 // Quote argument if it contains spaces
1087 string quoteIfNeeded(string const & str) {
1088 if (contains(str, ' '))
1089 return "\"" + str + "\"";
1095 void BufferParams::writeFile(ostream & os, Buffer const * buf) const
1097 // The top of the file is written by the buffer.
1098 // Prints out the buffer info into the .lyx file given by file
1100 os << "\\save_transient_properties "
1101 << convert<string>(save_transient_properties) << '\n';
1103 // the document directory (must end with a path separator)
1104 // realPath() is used to resolve symlinks, while addPath(..., "")
1105 // ensures a trailing path separator.
1107 string filepath = addPath(buf->fileName().onlyPath().realPath(), "");
1108 string const sysdir = inSystemDir(FileName(filepath), docsys) ? docsys
1109 : addPath(package().system_support().realPath(), "");
1110 string const relpath =
1111 to_utf8(makeRelPath(from_utf8(filepath), from_utf8(sysdir)));
1112 if (!prefixIs(relpath, "../") && !FileName::isAbsolute(relpath))
1113 filepath = addPath("/systemlyxdir", relpath);
1114 else if (!save_transient_properties || !lyxrc.save_origin)
1115 filepath = "unavailable";
1116 os << "\\origin " << quoteIfNeeded(filepath) << '\n';
1119 os << "\\textclass "
1120 << quoteIfNeeded(buf->includedFilePath(addName(buf->layoutPos(),
1121 baseClass()->name()), "layout"))
1124 // then the preamble
1125 if (!preamble.empty()) {
1126 // remove '\n' from the end of preamble
1127 docstring const tmppreamble = rtrim(preamble, "\n");
1128 os << "\\begin_preamble\n"
1129 << to_utf8(tmppreamble)
1130 << "\n\\end_preamble\n";
1134 if (!options.empty()) {
1135 os << "\\options " << options << '\n';
1138 // use the class options defined in the layout?
1139 os << "\\use_default_options "
1140 << convert<string>(use_default_options) << "\n";
1142 // the master document
1143 if (!master.empty()) {
1144 os << "\\master " << master << '\n';
1148 if (!removed_modules_.empty()) {
1149 os << "\\begin_removed_modules" << '\n';
1150 list<string>::const_iterator it = removed_modules_.begin();
1151 list<string>::const_iterator en = removed_modules_.end();
1152 for (; it != en; ++it)
1154 os << "\\end_removed_modules" << '\n';
1158 if (!layout_modules_.empty()) {
1159 os << "\\begin_modules" << '\n';
1160 LayoutModuleList::const_iterator it = layout_modules_.begin();
1161 LayoutModuleList::const_iterator en = layout_modules_.end();
1162 for (; it != en; ++it)
1164 os << "\\end_modules" << '\n';
1168 if (!included_children_.empty()) {
1169 os << "\\begin_includeonly" << '\n';
1170 list<string>::const_iterator it = included_children_.begin();
1171 list<string>::const_iterator en = included_children_.end();
1172 for (; it != en; ++it)
1174 os << "\\end_includeonly" << '\n';
1176 os << "\\maintain_unincluded_children "
1177 << convert<string>(maintain_unincluded_children) << '\n';
1179 // local layout information
1180 docstring const local_layout = getLocalLayout(false);
1181 if (!local_layout.empty()) {
1182 // remove '\n' from the end
1183 docstring const tmplocal = rtrim(local_layout, "\n");
1184 os << "\\begin_local_layout\n"
1185 << to_utf8(tmplocal)
1186 << "\n\\end_local_layout\n";
1188 docstring const forced_local_layout = getLocalLayout(true);
1189 if (!forced_local_layout.empty()) {
1190 // remove '\n' from the end
1191 docstring const tmplocal = rtrim(forced_local_layout, "\n");
1192 os << "\\begin_forced_local_layout\n"
1193 << to_utf8(tmplocal)
1194 << "\n\\end_forced_local_layout\n";
1197 // then the text parameters
1198 if (language != ignore_language)
1199 os << "\\language " << language->lang() << '\n';
1200 os << "\\language_package " << lang_package
1201 << "\n\\inputencoding " << inputenc
1202 << "\n\\fontencoding " << fontenc
1203 << "\n\\font_roman \"" << fonts_roman[0]
1204 << "\" \"" << fonts_roman[1] << '"'
1205 << "\n\\font_sans \"" << fonts_sans[0]
1206 << "\" \"" << fonts_sans[1] << '"'
1207 << "\n\\font_typewriter \"" << fonts_typewriter[0]
1208 << "\" \"" << fonts_typewriter[1] << '"'
1209 << "\n\\font_math \"" << fonts_math[0]
1210 << "\" \"" << fonts_math[1] << '"'
1211 << "\n\\font_default_family " << fonts_default_family
1212 << "\n\\use_non_tex_fonts " << convert<string>(useNonTeXFonts)
1213 << "\n\\font_sc " << convert<string>(fonts_expert_sc)
1214 << "\n\\font_osf " << convert<string>(fonts_old_figures)
1215 << "\n\\font_sf_scale " << fonts_sans_scale[0]
1216 << ' ' << fonts_sans_scale[1]
1217 << "\n\\font_tt_scale " << fonts_typewriter_scale[0]
1218 << ' ' << fonts_typewriter_scale[1]
1220 if (!fonts_cjk.empty()) {
1221 os << "\\font_cjk " << fonts_cjk << '\n';
1223 os << "\\use_microtype " << convert<string>(use_microtype) << '\n';
1224 os << "\\use_dash_ligatures " << convert<string>(use_dash_ligatures) << '\n';
1225 os << "\\graphics " << graphics_driver << '\n';
1226 os << "\\default_output_format " << default_output_format << '\n';
1227 os << "\\output_sync " << output_sync << '\n';
1228 if (!output_sync_macro.empty())
1229 os << "\\output_sync_macro \"" << output_sync_macro << "\"\n";
1230 os << "\\bibtex_command " << bibtex_command << '\n';
1231 os << "\\index_command " << index_command << '\n';
1233 if (!float_placement.empty()) {
1234 os << "\\float_placement " << float_placement << '\n';
1236 os << "\\paperfontsize " << fontsize << '\n';
1238 spacing().writeFile(os);
1239 pdfoptions().writeFile(os);
1241 os << "\\papersize " << string_papersize[papersize]
1242 << "\n\\use_geometry " << convert<string>(use_geometry);
1243 map<string, string> const & packages = auto_packages();
1244 for (map<string, string>::const_iterator it = packages.begin();
1245 it != packages.end(); ++it)
1246 os << "\n\\use_package " << it->first << ' '
1247 << use_package(it->first);
1249 os << "\n\\cite_engine ";
1251 if (!cite_engine_.empty()) {
1252 LayoutModuleList::const_iterator be = cite_engine_.begin();
1253 LayoutModuleList::const_iterator en = cite_engine_.end();
1254 for (LayoutModuleList::const_iterator it = be; it != en; ++it) {
1263 os << "\n\\cite_engine_type " << theCiteEnginesList.getTypeAsString(cite_engine_type_);
1265 if (!biblio_style.empty())
1266 os << "\n\\biblio_style " << biblio_style;
1267 if (!biblio_opts.empty())
1268 os << "\n\\biblio_options " << biblio_opts;
1269 if (!biblatex_bibstyle.empty())
1270 os << "\n\\biblatex_bibstyle " << biblatex_bibstyle;
1271 if (!biblatex_citestyle.empty())
1272 os << "\n\\biblatex_citestyle " << biblatex_citestyle;
1273 if (!multibib.empty())
1274 os << "\n\\multibib " << multibib;
1276 os << "\n\\use_bibtopic " << convert<string>(use_bibtopic)
1277 << "\n\\use_indices " << convert<string>(use_indices)
1278 << "\n\\paperorientation " << string_orientation[orientation]
1279 << "\n\\suppress_date " << convert<string>(suppress_date)
1280 << "\n\\justification " << convert<string>(justification)
1281 << "\n\\use_refstyle " << use_refstyle
1283 if (isbackgroundcolor == true)
1284 os << "\\backgroundcolor " << lyx::X11hexname(backgroundcolor) << '\n';
1285 if (isfontcolor == true)
1286 os << "\\fontcolor " << lyx::X11hexname(fontcolor) << '\n';
1287 if (notefontcolor != lyx::rgbFromHexName("#cccccc"))
1288 os << "\\notefontcolor " << lyx::X11hexname(notefontcolor) << '\n';
1289 if (boxbgcolor != lyx::rgbFromHexName("#ff0000"))
1290 os << "\\boxbgcolor " << lyx::X11hexname(boxbgcolor) << '\n';
1292 BranchList::const_iterator it = branchlist().begin();
1293 BranchList::const_iterator end = branchlist().end();
1294 for (; it != end; ++it) {
1295 os << "\\branch " << to_utf8(it->branch())
1296 << "\n\\selected " << it->isSelected()
1297 << "\n\\filename_suffix " << it->hasFileNameSuffix()
1298 << "\n\\color " << lyx::X11hexname(it->color())
1303 IndicesList::const_iterator iit = indiceslist().begin();
1304 IndicesList::const_iterator iend = indiceslist().end();
1305 for (; iit != iend; ++iit) {
1306 os << "\\index " << to_utf8(iit->index())
1307 << "\n\\shortcut " << to_utf8(iit->shortcut())
1308 << "\n\\color " << lyx::X11hexname(iit->color())
1313 if (!paperwidth.empty())
1314 os << "\\paperwidth "
1315 << VSpace(paperwidth).asLyXCommand() << '\n';
1316 if (!paperheight.empty())
1317 os << "\\paperheight "
1318 << VSpace(paperheight).asLyXCommand() << '\n';
1319 if (!leftmargin.empty())
1320 os << "\\leftmargin "
1321 << VSpace(leftmargin).asLyXCommand() << '\n';
1322 if (!topmargin.empty())
1323 os << "\\topmargin "
1324 << VSpace(topmargin).asLyXCommand() << '\n';
1325 if (!rightmargin.empty())
1326 os << "\\rightmargin "
1327 << VSpace(rightmargin).asLyXCommand() << '\n';
1328 if (!bottommargin.empty())
1329 os << "\\bottommargin "
1330 << VSpace(bottommargin).asLyXCommand() << '\n';
1331 if (!headheight.empty())
1332 os << "\\headheight "
1333 << VSpace(headheight).asLyXCommand() << '\n';
1334 if (!headsep.empty())
1336 << VSpace(headsep).asLyXCommand() << '\n';
1337 if (!footskip.empty())
1339 << VSpace(footskip).asLyXCommand() << '\n';
1340 if (!columnsep.empty())
1341 os << "\\columnsep "
1342 << VSpace(columnsep).asLyXCommand() << '\n';
1343 os << "\\secnumdepth " << secnumdepth
1344 << "\n\\tocdepth " << tocdepth
1345 << "\n\\paragraph_separation "
1346 << string_paragraph_separation[paragraph_separation];
1347 if (!paragraph_separation)
1348 os << "\n\\paragraph_indentation "
1349 << (getParIndent().empty() ? "default" : getParIndent().asString());
1351 os << "\n\\defskip " << getDefSkip().asLyXCommand();
1352 os << "\n\\is_math_indent " << is_math_indent;
1353 if (is_math_indent && !getMathIndent().empty())
1354 os << "\n\\math_indentation " << getMathIndent().asString();
1355 os << "\n\\quotes_style "
1356 << string_quotes_style[quotes_style]
1357 << "\n\\dynamic_quotes " << dynamic_quotes
1358 << "\n\\papercolumns " << columns
1359 << "\n\\papersides " << sides
1360 << "\n\\paperpagestyle " << pagestyle << '\n';
1361 if (!listings_params.empty())
1362 os << "\\listings_params \"" <<
1363 InsetListingsParams(listings_params).encodedString() << "\"\n";
1364 for (int i = 0; i < 4; ++i) {
1365 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1366 if (user_defined_bullet(i).getFont() != -1) {
1367 os << "\\bullet " << i << " "
1368 << user_defined_bullet(i).getFont() << " "
1369 << user_defined_bullet(i).getCharacter() << " "
1370 << user_defined_bullet(i).getSize() << "\n";
1374 os << "\\bulletLaTeX " << i << " \""
1375 << lyx::to_ascii(user_defined_bullet(i).getText())
1381 os << "\\tracking_changes "
1382 << (save_transient_properties ? convert<string>(track_changes) : "false")
1385 os << "\\output_changes "
1386 << (save_transient_properties ? convert<string>(output_changes) : "false")
1389 os << "\\html_math_output " << html_math_output << '\n'
1390 << "\\html_css_as_file " << html_css_as_file << '\n'
1391 << "\\html_be_strict " << convert<string>(html_be_strict) << '\n';
1393 if (html_math_img_scale != 1.0)
1394 os << "\\html_math_img_scale " << convert<string>(html_math_img_scale) << '\n';
1395 if (!html_latex_start.empty())
1396 os << "\\html_latex_start " << html_latex_start << '\n';
1397 if (!html_latex_end.empty())
1398 os << "\\html_latex_end " << html_latex_end << '\n';
1400 os << pimpl_->authorlist;
1404 void BufferParams::validate(LaTeXFeatures & features) const
1406 features.require(documentClass().requires());
1408 if (columns > 1 && language->rightToLeft())
1409 features.require("rtloutputdblcol");
1411 if (output_changes) {
1412 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1413 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1414 LaTeXFeatures::isAvailable("xcolor");
1416 switch (features.runparams().flavor) {
1417 case OutputParams::LATEX:
1418 case OutputParams::DVILUATEX:
1420 features.require("ct-dvipost");
1421 features.require("dvipost");
1422 } else if (xcolorulem) {
1423 features.require("ct-xcolor-ulem");
1424 features.require("ulem");
1425 features.require("xcolor");
1427 features.require("ct-none");
1430 case OutputParams::LUATEX:
1431 case OutputParams::PDFLATEX:
1432 case OutputParams::XETEX:
1434 features.require("ct-xcolor-ulem");
1435 features.require("ulem");
1436 features.require("xcolor");
1437 // improves color handling in PDF output
1438 features.require("pdfcolmk");
1440 features.require("ct-none");
1448 // Floats with 'Here definitely' as default setting.
1449 if (float_placement.find('H') != string::npos)
1450 features.require("float");
1452 for (PackageMap::const_iterator it = use_packages.begin();
1453 it != use_packages.end(); ++it) {
1454 if (it->first == "amsmath") {
1455 // AMS Style is at document level
1456 if (it->second == package_on ||
1457 features.isProvided("amsmath"))
1458 features.require(it->first);
1459 } else if (it->second == package_on)
1460 features.require(it->first);
1463 // Document-level line spacing
1464 if (spacing().getSpace() != Spacing::Single && !spacing().isDefault())
1465 features.require("setspace");
1467 // the bullet shapes are buffer level not paragraph level
1468 // so they are tested here
1469 for (int i = 0; i < 4; ++i) {
1470 if (user_defined_bullet(i) == ITEMIZE_DEFAULTS[i])
1472 int const font = user_defined_bullet(i).getFont();
1474 int const c = user_defined_bullet(i).getCharacter();
1480 features.require("latexsym");
1482 } else if (font == 1) {
1483 features.require("amssymb");
1484 } else if (font >= 2 && font <= 5) {
1485 features.require("pifont");
1489 if (pdfoptions().use_hyperref) {
1490 features.require("hyperref");
1491 // due to interferences with babel and hyperref, the color package has to
1492 // be loaded after hyperref when hyperref is used with the colorlinks
1493 // option, see http://www.lyx.org/trac/ticket/5291
1494 if (pdfoptions().colorlinks)
1495 features.require("color");
1497 if (!listings_params.empty()) {
1498 // do not test validity because listings_params is
1499 // supposed to be valid
1501 InsetListingsParams(listings_params).separatedParams(true);
1502 // we can't support all packages, but we should load the color package
1503 if (par.find("\\color", 0) != string::npos)
1504 features.require("color");
1507 // some languages are only available via polyglossia
1508 if (features.hasPolyglossiaExclusiveLanguages())
1509 features.require("polyglossia");
1511 if (useNonTeXFonts && fontsMath() != "auto")
1512 features.require("unicode-math");
1515 features.require("microtype");
1517 if (!language->requires().empty())
1518 features.require(language->requires());
1522 bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
1523 FileName const & filepath) const
1525 // http://www.tug.org/texmf-dist/doc/latex/base/fixltx2e.pdf
1526 // !! To use the Fix-cm package, load it before \documentclass, and use the command
1527 // \RequirePackage to do so, rather than the normal \usepackage
1528 // Do not try to load any other package before the document class, unless you
1529 // have a thorough understanding of the LATEX internals and know exactly what you
1531 if (features.mustProvide("fix-cm"))
1532 os << "\\RequirePackage{fix-cm}\n";
1533 // Likewise for fixltx2e. If other packages conflict with this policy,
1534 // treat it as a package bug (and report it!)
1535 // See http://www.latex-project.org/cgi-bin/ltxbugs2html?pr=latex/4407
1536 if (features.mustProvide("fixltx2e"))
1537 os << "\\RequirePackage{fixltx2e}\n";
1539 os << "\\documentclass";
1541 DocumentClass const & tclass = documentClass();
1543 ostringstream clsoptions; // the document class options.
1545 if (tokenPos(tclass.opt_fontsize(),
1546 '|', fontsize) >= 0) {
1547 // only write if existing in list (and not default)
1548 clsoptions << fontsize << "pt,";
1551 // all paper sizes except of A4, A5, B5 and the US sizes need the
1553 bool nonstandard_papersize = papersize != PAPER_DEFAULT
1554 && papersize != PAPER_USLETTER
1555 && papersize != PAPER_USLEGAL
1556 && papersize != PAPER_USEXECUTIVE
1557 && papersize != PAPER_A4
1558 && papersize != PAPER_A5
1559 && papersize != PAPER_B5;
1561 if (!use_geometry) {
1562 switch (papersize) {
1564 clsoptions << "a4paper,";
1566 case PAPER_USLETTER:
1567 clsoptions << "letterpaper,";
1570 clsoptions << "a5paper,";
1573 clsoptions << "b5paper,";
1575 case PAPER_USEXECUTIVE:
1576 clsoptions << "executivepaper,";
1579 clsoptions << "legalpaper,";
1613 if (sides != tclass.sides()) {
1616 clsoptions << "oneside,";
1619 clsoptions << "twoside,";
1625 if (columns != tclass.columns()) {
1627 clsoptions << "twocolumn,";
1629 clsoptions << "onecolumn,";
1633 && orientation == ORIENTATION_LANDSCAPE)
1634 clsoptions << "landscape,";
1637 clsoptions << "fleqn,";
1639 // language should be a parameter to \documentclass
1640 if (language->babel() == "hebrew"
1641 && default_language->babel() != "hebrew")
1642 // This seems necessary
1643 features.useLanguage(default_language);
1645 ostringstream language_options;
1646 bool const use_babel = features.useBabel() && !features.isProvided("babel");
1647 bool const use_polyglossia = features.usePolyglossia();
1648 bool const global = lyxrc.language_global_options;
1649 if (use_babel || (use_polyglossia && global)) {
1650 language_options << features.getBabelLanguages();
1651 if (!language->babel().empty()) {
1652 if (!language_options.str().empty())
1653 language_options << ',';
1654 language_options << language->babel();
1656 if (global && !features.needBabelLangOptions()
1657 && !language_options.str().empty())
1658 clsoptions << language_options.str() << ',';
1661 // the predefined options from the layout
1662 if (use_default_options && !tclass.options().empty())
1663 clsoptions << tclass.options() << ',';
1665 // the user-defined options
1666 if (!options.empty()) {
1667 clsoptions << options << ',';
1670 string strOptions(clsoptions.str());
1671 if (!strOptions.empty()) {
1672 strOptions = rtrim(strOptions, ",");
1674 os << '[' << from_utf8(strOptions) << ']';
1677 os << '{' << from_ascii(tclass.latexname()) << "}\n";
1678 // end of \documentclass defs
1680 // if we use fontspec or newtxmath, we have to load the AMS packages here
1681 string const ams = features.loadAMSPackages();
1682 bool const ot1 = (main_font_encoding() == "default" || main_font_encoding() == "OT1");
1683 bool const use_newtxmath =
1684 theLaTeXFonts().getLaTeXFont(from_ascii(fontsMath())).getUsedPackage(
1685 ot1, false, false) == "newtxmath";
1686 if ((useNonTeXFonts || use_newtxmath) && !ams.empty())
1687 os << from_ascii(ams);
1689 if (useNonTeXFonts) {
1690 if (!features.isProvided("fontspec"))
1691 os << "\\usepackage{fontspec}\n";
1692 if (features.mustProvide("unicode-math")
1693 && features.isAvailable("unicode-math"))
1694 os << "\\usepackage{unicode-math}\n";
1697 // font selection must be done before loading fontenc.sty
1698 string const fonts = loadFonts(features);
1700 os << from_utf8(fonts);
1702 if (fonts_default_family != "default")
1703 os << "\\renewcommand{\\familydefault}{\\"
1704 << from_ascii(fonts_default_family) << "}\n";
1706 // set font encoding
1707 // XeTeX and LuaTeX (with OS fonts) do not need fontenc
1708 if (!useNonTeXFonts && !features.isProvided("fontenc")
1709 && main_font_encoding() != "default") {
1710 // get main font encodings
1711 vector<string> fontencs = font_encodings();
1712 // get font encodings of secondary languages
1713 features.getFontEncodings(fontencs);
1714 if (!fontencs.empty()) {
1715 os << "\\usepackage["
1716 << from_ascii(getStringFromVector(fontencs))
1721 // handle inputenc etc.
1722 writeEncodingPreamble(os, features);
1725 if (!features.runparams().includeall && !included_children_.empty()) {
1726 os << "\\includeonly{";
1727 list<string>::const_iterator it = included_children_.begin();
1728 list<string>::const_iterator en = included_children_.end();
1730 for (; it != en; ++it) {
1731 string incfile = *it;
1732 FileName inc = makeAbsPath(incfile, filepath.absFileName());
1733 string mangled = DocFileName(changeExtension(inc.absFileName(), ".tex")).
1735 if (!features.runparams().nice)
1737 // \includeonly doesn't want an extension
1738 incfile = changeExtension(incfile, string());
1739 incfile = support::latex_path(incfile);
1740 if (!incfile.empty()) {
1743 os << from_utf8(incfile);
1750 if (!features.isProvided("geometry")
1751 && (use_geometry || nonstandard_papersize)) {
1752 odocstringstream ods;
1753 if (!getGraphicsDriver("geometry").empty())
1754 ods << getGraphicsDriver("geometry");
1755 if (orientation == ORIENTATION_LANDSCAPE)
1756 ods << ",landscape";
1757 switch (papersize) {
1759 if (!paperwidth.empty())
1760 ods << ",paperwidth="
1761 << from_ascii(paperwidth);
1762 if (!paperheight.empty())
1763 ods << ",paperheight="
1764 << from_ascii(paperheight);
1766 case PAPER_USLETTER:
1767 ods << ",letterpaper";
1770 ods << ",legalpaper";
1772 case PAPER_USEXECUTIVE:
1773 ods << ",executivepaper";
1862 docstring const g_options = trim(ods.str(), ",");
1863 os << "\\usepackage";
1864 if (!g_options.empty())
1865 os << '[' << g_options << ']';
1866 os << "{geometry}\n";
1867 // output this only if use_geometry is true
1869 os << "\\geometry{verbose";
1870 if (!topmargin.empty())
1871 os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1872 if (!bottommargin.empty())
1873 os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1874 if (!leftmargin.empty())
1875 os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1876 if (!rightmargin.empty())
1877 os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1878 if (!headheight.empty())
1879 os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1880 if (!headsep.empty())
1881 os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1882 if (!footskip.empty())
1883 os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1884 if (!columnsep.empty())
1885 os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
1888 } else if (orientation == ORIENTATION_LANDSCAPE
1889 || papersize != PAPER_DEFAULT) {
1890 features.require("papersize");
1893 if (tokenPos(tclass.opt_pagestyle(), '|', pagestyle) >= 0) {
1894 if (pagestyle == "fancy")
1895 os << "\\usepackage{fancyhdr}\n";
1896 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1899 // only output when the background color is not default
1900 if (isbackgroundcolor == true) {
1901 // only require color here, the background color will be defined
1902 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1904 features.require("color");
1905 features.require("pagecolor");
1908 // only output when the font color is not default
1909 if (isfontcolor == true) {
1910 // only require color here, the font color will be defined
1911 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1913 features.require("color");
1914 features.require("fontcolor");
1917 // Only if class has a ToC hierarchy
1918 if (tclass.hasTocLevels()) {
1919 if (secnumdepth != tclass.secnumdepth()) {
1920 os << "\\setcounter{secnumdepth}{"
1924 if (tocdepth != tclass.tocdepth()) {
1925 os << "\\setcounter{tocdepth}{"
1931 if (paragraph_separation) {
1932 // when skip separation
1933 switch (getDefSkip().kind()) {
1934 case VSpace::SMALLSKIP:
1935 os << "\\setlength{\\parskip}{\\smallskipamount}\n";
1937 case VSpace::MEDSKIP:
1938 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1940 case VSpace::BIGSKIP:
1941 os << "\\setlength{\\parskip}{\\bigskipamount}\n";
1943 case VSpace::LENGTH:
1944 os << "\\setlength{\\parskip}{"
1945 << from_utf8(getDefSkip().length().asLatexString())
1948 default: // should never happen // Then delete it.
1949 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1952 os << "\\setlength{\\parindent}{0pt}\n";
1954 // when separation by indentation
1955 // only output something when a width is given
1956 if (!getParIndent().empty()) {
1957 os << "\\setlength{\\parindent}{"
1958 << from_utf8(getParIndent().asLatexString())
1963 if (is_math_indent) {
1964 // when formula indentation
1965 // only output something when it is not the default
1966 if (!getMathIndent().empty()) {
1967 os << "\\setlength{\\mathindent}{"
1968 << from_utf8(getMathIndent().asString())
1973 // Now insert the LyX specific LaTeX commands...
1974 features.resolveAlternatives();
1975 features.expandMultiples();
1978 if (!output_sync_macro.empty())
1979 os << from_utf8(output_sync_macro) +"\n";
1980 else if (features.runparams().flavor == OutputParams::LATEX)
1981 os << "\\usepackage[active]{srcltx}\n";
1982 else if (features.runparams().flavor == OutputParams::PDFLATEX)
1983 os << "\\synctex=-1\n";
1986 // The package options (via \PassOptionsToPackage)
1987 os << from_ascii(features.getPackageOptions());
1989 // due to interferences with babel and hyperref, the color package has to
1990 // be loaded (when it is not already loaded) before babel when hyperref
1991 // is used with the colorlinks option, see
1992 // http://www.lyx.org/trac/ticket/5291
1993 // we decided therefore to load color always before babel, see
1994 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
1995 os << from_ascii(features.getColorOptions());
1997 // If we use hyperref, jurabib, japanese, varioref or vietnamese,
1998 // we have to call babel before
2000 && (features.isRequired("jurabib")
2001 || features.isRequired("hyperref")
2002 || features.isRequired("varioref")
2003 || features.isRequired("vietnamese")
2004 || features.isRequired("japanese"))) {
2005 os << features.getBabelPresettings();
2007 os << from_utf8(babelCall(language_options.str(),
2008 features.needBabelLangOptions())) + '\n';
2009 os << features.getBabelPostsettings();
2012 // The optional packages;
2013 os << from_ascii(features.getPackages());
2015 // Additional Indices
2016 if (features.isRequired("splitidx")) {
2017 IndicesList::const_iterator iit = indiceslist().begin();
2018 IndicesList::const_iterator iend = indiceslist().end();
2019 for (; iit != iend; ++iit) {
2020 os << "\\newindex{";
2021 os << escape(iit->shortcut());
2027 os << from_utf8(spacing().writePreamble(features.isProvided("SetSpace")));
2030 // * Hyperref manual: "Make sure it comes last of your loaded
2031 // packages, to give it a fighting chance of not being over-written,
2032 // since its job is to redefine many LaTeX commands."
2033 // * Email from Heiko Oberdiek: "It is usually better to load babel
2034 // before hyperref. Then hyperref has a chance to detect babel.
2035 // * Has to be loaded before the "LyX specific LaTeX commands" to
2036 // avoid errors with algorithm floats.
2037 // use hyperref explicitly if it is required
2038 if (features.isRequired("hyperref")) {
2039 OutputParams tmp_params = features.runparams();
2040 pdfoptions().writeLaTeX(tmp_params, os,
2041 features.isProvided("hyperref"));
2042 // correctly break URLs with hyperref and dvi output
2043 if (features.runparams().flavor == OutputParams::LATEX
2044 && features.isAvailable("breakurl"))
2045 os << "\\usepackage{breakurl}\n";
2046 } else if (features.isRequired("nameref"))
2047 // hyperref loads this automatically
2048 os << "\\usepackage{nameref}\n";
2050 // bibtopic needs to be loaded after hyperref.
2051 // the dot provides the aux file naming which LyX can detect.
2052 if (features.mustProvide("bibtopic"))
2053 os << "\\usepackage[dot]{bibtopic}\n";
2055 // Will be surrounded by \makeatletter and \makeatother when not empty
2056 otexstringstream atlyxpreamble;
2058 // Some macros LyX will need
2060 TexString tmppreamble = features.getMacros();
2061 if (!tmppreamble.str.empty())
2062 atlyxpreamble << "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2063 "LyX specific LaTeX commands.\n"
2064 << move(tmppreamble)
2067 // the text class specific preamble
2069 docstring tmppreamble = features.getTClassPreamble();
2070 if (!tmppreamble.empty())
2071 atlyxpreamble << "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2072 "Textclass specific LaTeX commands.\n"
2076 // suppress date if selected
2077 // use \@ifundefined because we cannot be sure that every document class
2078 // has a \date command
2080 atlyxpreamble << "\\@ifundefined{date}{}{\\date{}}\n";
2082 /* the user-defined preamble */
2083 if (!containsOnly(preamble, " \n\t")) {
2085 atlyxpreamble << "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2086 "User specified LaTeX commands.\n";
2088 // Check if the user preamble contains uncodable glyphs
2089 odocstringstream user_preamble;
2090 docstring uncodable_glyphs;
2091 Encoding const * const enc = features.runparams().encoding;
2093 for (size_t n = 0; n < preamble.size(); ++n) {
2094 char_type c = preamble[n];
2095 if (!enc->encodable(c)) {
2096 docstring const glyph(1, c);
2097 LYXERR0("Uncodable character '"
2099 << "' in user preamble!");
2100 uncodable_glyphs += glyph;
2101 if (features.runparams().dryrun) {
2102 user_preamble << "<" << _("LyX Warning: ")
2103 << _("uncodable character") << " '";
2104 user_preamble.put(c);
2105 user_preamble << "'>";
2108 user_preamble.put(c);
2111 user_preamble << preamble;
2113 // On BUFFER_VIEW|UPDATE, warn user if we found uncodable glyphs
2114 if (!features.runparams().dryrun && !uncodable_glyphs.empty()) {
2115 frontend::Alert::warning(
2116 _("Uncodable character in user preamble"),
2118 _("The user preamble of your document contains glyphs "
2119 "that are unknown in the current document encoding "
2120 "(namely %1$s).\nThese glyphs are omitted "
2121 " from the output, which may result in "
2122 "incomplete output."
2123 "\n\nPlease select an appropriate "
2124 "document encoding\n"
2125 "(such as utf8) or change the "
2126 "preamble code accordingly."),
2129 atlyxpreamble << user_preamble.str() << '\n';
2132 // footmisc must be loaded after setspace
2133 // Load it here to avoid clashes with footmisc loaded in the user
2134 // preamble. For that reason we also pass the options via
2135 // \PassOptionsToPackage in getPreamble() and not here.
2136 if (features.mustProvide("footmisc"))
2137 atlyxpreamble << "\\usepackage{footmisc}\n";
2139 // subfig loads internally the LaTeX package "caption". As
2140 // caption is a very popular package, users will load it in
2141 // the preamble. Therefore we must load subfig behind the
2142 // user-defined preamble and check if the caption package was
2143 // loaded or not. For the case that caption is loaded before
2144 // subfig, there is the subfig option "caption=false". This
2145 // option also works when a koma-script class is used and
2146 // koma's own caption commands are used instead of caption. We
2147 // use \PassOptionsToPackage here because the user could have
2148 // already loaded subfig in the preamble.
2149 if (features.mustProvide("subfig"))
2150 atlyxpreamble << "\\@ifundefined{showcaptionsetup}{}{%\n"
2151 " \\PassOptionsToPackage{caption=false}{subfig}}\n"
2152 "\\usepackage{subfig}\n";
2154 // Itemize bullet settings need to be last in case the user
2155 // defines their own bullets that use a package included
2156 // in the user-defined preamble -- ARRae
2157 // Actually it has to be done much later than that
2158 // since some packages like frenchb make modifications
2159 // at \begin{document} time -- JMarc
2160 docstring bullets_def;
2161 for (int i = 0; i < 4; ++i) {
2162 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
2163 if (bullets_def.empty())
2164 bullets_def += "\\AtBeginDocument{\n";
2165 bullets_def += " \\def\\labelitemi";
2167 // `i' is one less than the item to modify
2174 bullets_def += "ii";
2180 bullets_def += '{' +
2181 user_defined_bullet(i).getText()
2186 if (!bullets_def.empty())
2187 atlyxpreamble << bullets_def << "}\n\n";
2189 if (!atlyxpreamble.empty())
2190 os << "\n\\makeatletter\n"
2191 << atlyxpreamble.release()
2192 << "\\makeatother\n\n";
2194 // We try to load babel late, in case it interferes with other packages.
2195 // Jurabib, hyperref, varioref, bicaption and listings (bug 8995) have to be
2196 // called after babel, though.
2197 if (use_babel && !features.isRequired("jurabib")
2198 && !features.isRequired("hyperref")
2199 && !features.isRequired("varioref")
2200 && !features.isRequired("vietnamese")
2201 && !features.isRequired("japanese")) {
2202 os << features.getBabelPresettings();
2204 os << from_utf8(babelCall(language_options.str(),
2205 features.needBabelLangOptions())) + '\n';
2206 os << features.getBabelPostsettings();
2208 if (features.isRequired("bicaption"))
2209 os << "\\usepackage{bicaption}\n";
2210 if (!listings_params.empty() || features.mustProvide("listings"))
2211 os << "\\usepackage{listings}\n";
2212 if (!listings_params.empty()) {
2214 // do not test validity because listings_params is
2215 // supposed to be valid
2217 InsetListingsParams(listings_params).separatedParams(true);
2218 os << from_utf8(par);
2222 // xunicode only needs to be loaded if tipa is used
2223 // (the rest is obsoleted by the new TU encoding).
2224 // It needs to be loaded at least after amsmath, amssymb,
2225 // esint and the other packages that provide special glyphs
2226 if (features.mustProvide("tipa") && useNonTeXFonts) {
2227 // The package officially only supports XeTeX, but also works
2228 // with LuaTeX. Thus we work around its XeTeX test.
2229 if (features.runparams().flavor != OutputParams::XETEX) {
2230 os << "% Pretend to xunicode that we are XeTeX\n"
2231 << "\\def\\XeTeXpicfile{}\n";
2233 os << "\\usepackage{xunicode}\n";
2236 // Polyglossia must be loaded last ...
2237 if (use_polyglossia) {
2239 os << "\\usepackage{polyglossia}\n";
2240 // set the main language
2241 os << "\\setdefaultlanguage";
2242 if (!language->polyglossiaOpts().empty())
2243 os << "[" << from_ascii(language->polyglossiaOpts()) << "]";
2244 os << "{" << from_ascii(language->polyglossia()) << "}\n";
2245 // now setup the other languages
2246 set<string> const polylangs =
2247 features.getPolyglossiaLanguages();
2248 for (set<string>::const_iterator mit = polylangs.begin();
2249 mit != polylangs.end() ; ++mit) {
2250 // We do not output the options here; they are output in
2251 // the language switch commands. This is safer if multiple
2252 // varieties are used.
2253 if (*mit == language->polyglossia())
2255 os << "\\setotherlanguage";
2256 os << "{" << from_ascii(*mit) << "}\n";
2260 // ... but before biblatex (see #7065)
2261 if (features.mustProvide("biblatex")) {
2264 os << "\\usepackage";
2265 if (!biblatex_bibstyle.empty()
2266 && (biblatex_bibstyle == biblatex_citestyle)) {
2267 opts = "style=" + biblatex_bibstyle;
2270 if (!biblatex_bibstyle.empty()) {
2271 opts = "bibstyle=" + biblatex_bibstyle;
2274 if (!biblatex_citestyle.empty()) {
2275 opts += delim + "citestyle=" + biblatex_citestyle;
2279 if (!multibib.empty() && multibib != "child") {
2280 opts += delim + "refsection=" + multibib;
2283 if (bibtexCommand() == "bibtex8"
2284 || prefixIs(bibtexCommand(), "bibtex8 ")) {
2285 opts += delim + "backend=bibtex8";
2287 } else if (bibtexCommand() == "bibtex"
2288 || prefixIs(bibtexCommand(), "bibtex ")) {
2289 opts += delim + "backend=bibtex";
2292 if (!biblio_opts.empty())
2293 opts += delim + biblio_opts;
2295 os << "[" << opts << "]";
2296 os << "{biblatex}\n";
2300 // Load custom language package here
2301 if (features.langPackage() == LaTeXFeatures::LANG_PACK_CUSTOM) {
2302 if (lang_package == "default")
2303 os << from_utf8(lyxrc.language_custom_package);
2305 os << from_utf8(lang_package);
2309 docstring const i18npreamble =
2310 features.getTClassI18nPreamble(use_babel, use_polyglossia);
2311 if (!i18npreamble.empty())
2312 os << i18npreamble + '\n';
2318 void BufferParams::useClassDefaults()
2320 DocumentClass const & tclass = documentClass();
2322 sides = tclass.sides();
2323 columns = tclass.columns();
2324 pagestyle = tclass.pagestyle();
2325 use_default_options = true;
2326 // Only if class has a ToC hierarchy
2327 if (tclass.hasTocLevels()) {
2328 secnumdepth = tclass.secnumdepth();
2329 tocdepth = tclass.tocdepth();
2334 bool BufferParams::hasClassDefaults() const
2336 DocumentClass const & tclass = documentClass();
2338 return sides == tclass.sides()
2339 && columns == tclass.columns()
2340 && pagestyle == tclass.pagestyle()
2341 && use_default_options
2342 && secnumdepth == tclass.secnumdepth()
2343 && tocdepth == tclass.tocdepth();
2347 DocumentClass const & BufferParams::documentClass() const
2353 DocumentClassConstPtr BufferParams::documentClassPtr() const
2359 void BufferParams::setDocumentClass(DocumentClassConstPtr tc)
2361 // evil, but this function is evil
2362 doc_class_ = const_pointer_cast<DocumentClass>(tc);
2363 invalidateConverterCache();
2367 bool BufferParams::setBaseClass(string const & classname)
2369 LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
2370 LayoutFileList & bcl = LayoutFileList::get();
2371 if (!bcl.haveClass(classname)) {
2373 bformat(_("The layout file:\n"
2375 "could not be found. A default textclass with default\n"
2376 "layouts will be used. LyX will not be able to produce\n"
2378 from_utf8(classname));
2379 frontend::Alert::error(_("Document class not found"), s);
2380 bcl.addEmptyClass(classname);
2383 bool const success = bcl[classname].load();
2386 bformat(_("Due to some error in it, the layout file:\n"
2388 "could not be loaded. A default textclass with default\n"
2389 "layouts will be used. LyX will not be able to produce\n"
2391 from_utf8(classname));
2392 frontend::Alert::error(_("Could not load class"), s);
2393 bcl.addEmptyClass(classname);
2396 pimpl_->baseClass_ = classname;
2397 layout_modules_.adaptToBaseClass(baseClass(), removed_modules_);
2402 LayoutFile const * BufferParams::baseClass() const
2404 if (LayoutFileList::get().haveClass(pimpl_->baseClass_))
2405 return &(LayoutFileList::get()[pimpl_->baseClass_]);
2411 LayoutFileIndex const & BufferParams::baseClassID() const
2413 return pimpl_->baseClass_;
2417 void BufferParams::makeDocumentClass(bool const clone)
2422 invalidateConverterCache();
2423 LayoutModuleList mods;
2424 LayoutModuleList ces;
2425 LayoutModuleList::iterator it = layout_modules_.begin();
2426 LayoutModuleList::iterator en = layout_modules_.end();
2427 for (; it != en; ++it)
2428 mods.push_back(*it);
2430 it = cite_engine_.begin();
2431 en = cite_engine_.end();
2432 for (; it != en; ++it)
2435 doc_class_ = getDocumentClass(*baseClass(), mods, ces, clone);
2437 TextClass::ReturnValues success = TextClass::OK;
2438 if (!forced_local_layout_.empty())
2439 success = doc_class_->read(to_utf8(forced_local_layout_),
2441 if (!local_layout_.empty() &&
2442 (success == TextClass::OK || success == TextClass::OK_OLDFORMAT))
2443 success = doc_class_->read(to_utf8(local_layout_), TextClass::MODULE);
2444 if (success != TextClass::OK && success != TextClass::OK_OLDFORMAT) {
2445 docstring const msg = _("Error reading internal layout information");
2446 frontend::Alert::warning(_("Read Error"), msg);
2451 bool BufferParams::layoutModuleCanBeAdded(string const & modName) const
2453 return layout_modules_.moduleCanBeAdded(modName, baseClass());
2457 bool BufferParams::citationModuleCanBeAdded(string const & modName) const
2459 return cite_engine_.moduleCanBeAdded(modName, baseClass());
2463 docstring BufferParams::getLocalLayout(bool forced) const
2466 return from_utf8(doc_class_->forcedLayouts());
2468 return local_layout_;
2472 void BufferParams::setLocalLayout(docstring const & layout, bool forced)
2475 forced_local_layout_ = layout;
2477 local_layout_ = layout;
2481 bool BufferParams::addLayoutModule(string const & modName)
2483 LayoutModuleList::const_iterator it = layout_modules_.begin();
2484 LayoutModuleList::const_iterator end = layout_modules_.end();
2485 for (; it != end; ++it)
2488 layout_modules_.push_back(modName);
2493 string BufferParams::bufferFormat() const
2495 return documentClass().outputFormat();
2499 bool BufferParams::isExportable(string const & format, bool need_viewable) const
2501 FormatList const & formats = exportableFormats(need_viewable);
2502 FormatList::const_iterator fit = formats.begin();
2503 FormatList::const_iterator end = formats.end();
2504 for (; fit != end ; ++fit) {
2505 if ((*fit)->name() == format)
2512 FormatList const & BufferParams::exportableFormats(bool only_viewable) const
2514 FormatList & cached = only_viewable ?
2515 pimpl_->viewableFormatList : pimpl_->exportableFormatList;
2516 bool & valid = only_viewable ?
2517 pimpl_->isViewCacheValid : pimpl_->isExportCacheValid;
2521 vector<string> const backs = backends();
2522 set<string> excludes;
2523 if (useNonTeXFonts) {
2524 excludes.insert("latex");
2525 excludes.insert("pdflatex");
2528 theConverters().getReachable(backs[0], only_viewable, true, excludes);
2529 for (vector<string>::const_iterator it = backs.begin() + 1;
2530 it != backs.end(); ++it) {
2531 FormatList r = theConverters().getReachable(*it, only_viewable,
2533 result.insert(result.end(), r.begin(), r.end());
2535 sort(result.begin(), result.end(), Format::formatSorter);
2542 vector<string> BufferParams::backends() const
2545 string const buffmt = bufferFormat();
2547 // FIXME: Don't hardcode format names here, but use a flag
2548 if (buffmt == "latex") {
2549 if (encoding().package() == Encoding::japanese)
2550 v.push_back("platex");
2552 if (!useNonTeXFonts) {
2553 v.push_back("pdflatex");
2554 v.push_back("latex");
2556 v.push_back("xetex");
2557 v.push_back("luatex");
2558 v.push_back("dviluatex");
2561 v.push_back(buffmt);
2563 v.push_back("xhtml");
2564 v.push_back("text");
2570 OutputParams::FLAVOR BufferParams::getOutputFlavor(string const & format) const
2572 string const dformat = (format.empty() || format == "default") ?
2573 getDefaultOutputFormat() : format;
2574 DefaultFlavorCache::const_iterator it =
2575 default_flavors_.find(dformat);
2577 if (it != default_flavors_.end())
2580 OutputParams::FLAVOR result = OutputParams::LATEX;
2582 // FIXME It'd be better not to hardcode this, but to do
2583 // something with formats.
2584 if (dformat == "xhtml")
2585 result = OutputParams::HTML;
2586 else if (dformat == "text")
2587 result = OutputParams::TEXT;
2588 else if (dformat == "lyx")
2589 result = OutputParams::LYX;
2590 else if (dformat == "pdflatex")
2591 result = OutputParams::PDFLATEX;
2592 else if (dformat == "xetex")
2593 result = OutputParams::XETEX;
2594 else if (dformat == "luatex")
2595 result = OutputParams::LUATEX;
2596 else if (dformat == "dviluatex")
2597 result = OutputParams::DVILUATEX;
2599 // Try to determine flavor of default output format
2600 vector<string> backs = backends();
2601 if (find(backs.begin(), backs.end(), dformat) == backs.end()) {
2602 // Get shortest path to format
2603 Graph::EdgePath path;
2604 for (vector<string>::const_iterator it = backs.begin();
2605 it != backs.end(); ++it) {
2606 Graph::EdgePath p = theConverters().getPath(*it, dformat);
2607 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2612 result = theConverters().getFlavor(path);
2615 // cache this flavor
2616 default_flavors_[dformat] = result;
2621 string BufferParams::getDefaultOutputFormat() const
2623 if (!default_output_format.empty()
2624 && default_output_format != "default")
2625 return default_output_format;
2627 || encoding().package() == Encoding::japanese) {
2628 FormatList const & formats = exportableFormats(true);
2629 if (formats.empty())
2631 // return the first we find
2632 return formats.front()->name();
2635 return lyxrc.default_otf_view_format;
2636 return lyxrc.default_view_format;
2639 Font const BufferParams::getFont() const
2641 FontInfo f = documentClass().defaultfont();
2642 if (fonts_default_family == "rmdefault")
2643 f.setFamily(ROMAN_FAMILY);
2644 else if (fonts_default_family == "sfdefault")
2645 f.setFamily(SANS_FAMILY);
2646 else if (fonts_default_family == "ttdefault")
2647 f.setFamily(TYPEWRITER_FAMILY);
2648 return Font(f, language);
2652 InsetQuotesParams::QuoteStyle BufferParams::getQuoteStyle(string const & qs) const
2654 return quotesstyletranslator().find(qs);
2658 bool BufferParams::isLatex() const
2660 return documentClass().outputType() == LATEX;
2664 bool BufferParams::isLiterate() const
2666 return documentClass().outputType() == LITERATE;
2670 bool BufferParams::isDocBook() const
2672 return documentClass().outputType() == DOCBOOK;
2676 void BufferParams::readPreamble(Lexer & lex)
2678 if (lex.getString() != "\\begin_preamble")
2679 lyxerr << "Error (BufferParams::readPreamble):"
2680 "consistency check failed." << endl;
2682 preamble = lex.getLongString(from_ascii("\\end_preamble"));
2686 void BufferParams::readLocalLayout(Lexer & lex, bool forced)
2688 string const expected = forced ? "\\begin_forced_local_layout" :
2689 "\\begin_local_layout";
2690 if (lex.getString() != expected)
2691 lyxerr << "Error (BufferParams::readLocalLayout):"
2692 "consistency check failed." << endl;
2695 forced_local_layout_ =
2696 lex.getLongString(from_ascii("\\end_forced_local_layout"));
2698 local_layout_ = lex.getLongString(from_ascii("\\end_local_layout"));
2702 bool BufferParams::setLanguage(string const & lang)
2704 Language const *new_language = languages.getLanguage(lang);
2705 if (!new_language) {
2706 // Language lang was not found
2709 language = new_language;
2714 void BufferParams::readLanguage(Lexer & lex)
2716 if (!lex.next()) return;
2718 string const tmptok = lex.getString();
2720 // check if tmptok is part of tex_babel in tex-defs.h
2721 if (!setLanguage(tmptok)) {
2722 // Language tmptok was not found
2723 language = default_language;
2724 lyxerr << "Warning: Setting language `"
2725 << tmptok << "' to `" << language->lang()
2731 void BufferParams::readGraphicsDriver(Lexer & lex)
2736 string const tmptok = lex.getString();
2737 // check if tmptok is part of tex_graphics in tex_defs.h
2740 string const test = tex_graphics[n++];
2742 if (test == tmptok) {
2743 graphics_driver = tmptok;
2748 "Warning: graphics driver `$$Token' not recognized!\n"
2749 " Setting graphics driver to `default'.\n");
2750 graphics_driver = "default";
2757 void BufferParams::readBullets(Lexer & lex)
2762 int const index = lex.getInteger();
2764 int temp_int = lex.getInteger();
2765 user_defined_bullet(index).setFont(temp_int);
2766 temp_bullet(index).setFont(temp_int);
2768 user_defined_bullet(index).setCharacter(temp_int);
2769 temp_bullet(index).setCharacter(temp_int);
2771 user_defined_bullet(index).setSize(temp_int);
2772 temp_bullet(index).setSize(temp_int);
2776 void BufferParams::readBulletsLaTeX(Lexer & lex)
2778 // The bullet class should be able to read this.
2781 int const index = lex.getInteger();
2783 docstring const temp_str = lex.getDocString();
2785 user_defined_bullet(index).setText(temp_str);
2786 temp_bullet(index).setText(temp_str);
2790 void BufferParams::readModules(Lexer & lex)
2792 if (!lex.eatLine()) {
2793 lyxerr << "Error (BufferParams::readModules):"
2794 "Unexpected end of input." << endl;
2798 string mod = lex.getString();
2799 if (mod == "\\end_modules")
2801 addLayoutModule(mod);
2807 void BufferParams::readRemovedModules(Lexer & lex)
2809 if (!lex.eatLine()) {
2810 lyxerr << "Error (BufferParams::readRemovedModules):"
2811 "Unexpected end of input." << endl;
2815 string mod = lex.getString();
2816 if (mod == "\\end_removed_modules")
2818 removed_modules_.push_back(mod);
2821 // now we want to remove any removed modules that were previously
2822 // added. normally, that will be because default modules were added in
2823 // setBaseClass(), which gets called when \textclass is read at the
2824 // start of the read.
2825 list<string>::const_iterator rit = removed_modules_.begin();
2826 list<string>::const_iterator const ren = removed_modules_.end();
2827 for (; rit != ren; ++rit) {
2828 LayoutModuleList::iterator const mit = layout_modules_.begin();
2829 LayoutModuleList::iterator const men = layout_modules_.end();
2830 LayoutModuleList::iterator found = find(mit, men, *rit);
2833 layout_modules_.erase(found);
2838 void BufferParams::readIncludeonly(Lexer & lex)
2840 if (!lex.eatLine()) {
2841 lyxerr << "Error (BufferParams::readIncludeonly):"
2842 "Unexpected end of input." << endl;
2846 string child = lex.getString();
2847 if (child == "\\end_includeonly")
2849 included_children_.push_back(child);
2855 string BufferParams::paperSizeName(PapersizePurpose purpose) const
2857 switch (papersize) {
2859 // could be anything, so don't guess
2861 case PAPER_CUSTOM: {
2862 if (purpose == XDVI && !paperwidth.empty() &&
2863 !paperheight.empty()) {
2864 // heightxwidth<unit>
2865 string first = paperwidth;
2866 string second = paperheight;
2867 if (orientation == ORIENTATION_LANDSCAPE)
2870 return first.erase(first.length() - 2)
2876 // dvips and dvipdfm do not know this
2877 if (purpose == DVIPS || purpose == DVIPDFM)
2881 if (purpose == DVIPS || purpose == DVIPDFM)
2885 if (purpose == DVIPS || purpose == DVIPDFM)
2895 if (purpose == DVIPS || purpose == DVIPDFM)
2899 if (purpose == DVIPS || purpose == DVIPDFM)
2903 if (purpose == DVIPS || purpose == DVIPDFM)
2907 if (purpose == DVIPS || purpose == DVIPDFM)
2911 if (purpose == DVIPS || purpose == DVIPDFM)
2915 // dvipdfm does not know this
2916 if (purpose == DVIPDFM)
2920 if (purpose == DVIPDFM)
2924 if (purpose == DVIPS || purpose == DVIPDFM)
2928 if (purpose == DVIPS || purpose == DVIPDFM)
2932 if (purpose == DVIPS || purpose == DVIPDFM)
2936 if (purpose == DVIPS || purpose == DVIPDFM)
2940 if (purpose == DVIPS || purpose == DVIPDFM)
2944 if (purpose == DVIPS || purpose == DVIPDFM)
2948 if (purpose == DVIPS || purpose == DVIPDFM)
2952 if (purpose == DVIPS || purpose == DVIPDFM)
2956 if (purpose == DVIPS || purpose == DVIPDFM)
2960 if (purpose == DVIPS || purpose == DVIPDFM)
2964 if (purpose == DVIPS || purpose == DVIPDFM)
2968 if (purpose == DVIPS || purpose == DVIPDFM)
2972 if (purpose == DVIPS || purpose == DVIPDFM)
2976 if (purpose == DVIPS || purpose == DVIPDFM)
2980 if (purpose == DVIPS || purpose == DVIPDFM)
2983 case PAPER_USEXECUTIVE:
2984 // dvipdfm does not know this
2985 if (purpose == DVIPDFM)
2990 case PAPER_USLETTER:
2992 if (purpose == XDVI)
2999 string const BufferParams::dvips_options() const
3003 // If the class loads the geometry package, we do not know which
3004 // paper size is used, since we do not set it (bug 7013).
3005 // Therefore we must not specify any argument here.
3006 // dvips gets the correct paper size via DVI specials in this case
3007 // (if the class uses the geometry package correctly).
3008 if (documentClass().provides("geometry"))
3012 && papersize == PAPER_CUSTOM
3013 && !lyxrc.print_paper_dimension_flag.empty()
3014 && !paperwidth.empty()
3015 && !paperheight.empty()) {
3016 // using a custom papersize
3017 result = lyxrc.print_paper_dimension_flag;
3018 result += ' ' + paperwidth;
3019 result += ',' + paperheight;
3021 string const paper_option = paperSizeName(DVIPS);
3022 if (!paper_option.empty() && (paper_option != "letter" ||
3023 orientation != ORIENTATION_LANDSCAPE)) {
3024 // dvips won't accept -t letter -t landscape.
3025 // In all other cases, include the paper size
3027 result = lyxrc.print_paper_flag;
3028 result += ' ' + paper_option;
3031 if (orientation == ORIENTATION_LANDSCAPE &&
3032 papersize != PAPER_CUSTOM)
3033 result += ' ' + lyxrc.print_landscape_flag;
3038 string const BufferParams::main_font_encoding() const
3040 return font_encodings().empty() ? "default" : font_encodings().back();
3044 vector<string> const BufferParams::font_encodings() const
3046 string doc_fontenc = (fontenc == "global") ? lyxrc.fontenc : fontenc;
3048 vector<string> fontencs;
3050 // "default" means "no explicit font encoding"
3051 if (doc_fontenc != "default") {
3052 fontencs = getVectorFromString(doc_fontenc);
3053 if (!language->fontenc().empty()
3054 && ascii_lowercase(language->fontenc()) != "none") {
3055 vector<string> fencs = getVectorFromString(language->fontenc());
3056 vector<string>::const_iterator fit = fencs.begin();
3057 for (; fit != fencs.end(); ++fit) {
3058 if (find(fontencs.begin(), fontencs.end(), *fit) == fontencs.end())
3059 fontencs.push_back(*fit);
3068 string BufferParams::babelCall(string const & lang_opts, bool const langoptions) const
3070 // suppress the babel call if there is no BabelName defined
3071 // for the document language in the lib/languages file and if no
3072 // other languages are used (lang_opts is then empty)
3073 if (lang_opts.empty())
3075 // either a specific language (AsBabelOptions setting in
3076 // lib/languages) or the prefs require the languages to
3077 // be submitted to babel itself (not the class).
3079 return "\\usepackage[" + lang_opts + "]{babel}";
3080 return "\\usepackage{babel}";
3084 docstring BufferParams::getGraphicsDriver(string const & package) const
3088 if (package == "geometry") {
3089 if (graphics_driver == "dvips"
3090 || graphics_driver == "dvipdfm"
3091 || graphics_driver == "pdftex"
3092 || graphics_driver == "vtex")
3093 result = from_ascii(graphics_driver);
3094 else if (graphics_driver == "dvipdfmx")
3095 result = from_ascii("dvipdfm");
3102 void BufferParams::writeEncodingPreamble(otexstream & os,
3103 LaTeXFeatures & features) const
3105 // XeTeX/LuaTeX: (see also #9740)
3106 // With Unicode fonts we use utf8-plain without encoding package.
3107 // With TeX fonts, we cannot use utf8-plain, but "inputenc" fails.
3108 // XeTeX must use ASCII encoding (see Buffer.cpp),
3109 // for LuaTeX, we load "luainputenc" (see below).
3110 if (useNonTeXFonts || features.runparams().flavor == OutputParams::XETEX)
3113 if (inputenc == "auto") {
3114 string const doc_encoding =
3115 language->encoding()->latexName();
3116 Encoding::Package const package =
3117 language->encoding()->package();
3119 // Create list of inputenc options:
3120 set<string> encodings;
3121 // luainputenc fails with more than one encoding
3122 if (!features.runparams().isFullUnicode()) // if we reach this point, this means LuaTeX with TeX fonts
3123 // list all input encodings used in the document
3124 encodings = features.getEncodingSet(doc_encoding);
3126 // If the "japanese" package (i.e. pLaTeX) is used,
3127 // inputenc must be omitted.
3128 // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
3129 if ((!encodings.empty() || package == Encoding::inputenc)
3130 && !features.isRequired("japanese")
3131 && !features.isProvided("inputenc")) {
3132 os << "\\usepackage[";
3133 set<string>::const_iterator it = encodings.begin();
3134 set<string>::const_iterator const end = encodings.end();
3136 os << from_ascii(*it);
3139 for (; it != end; ++it)
3140 os << ',' << from_ascii(*it);
3141 if (package == Encoding::inputenc) {
3142 if (!encodings.empty())
3144 os << from_ascii(doc_encoding);
3146 if (features.runparams().flavor == OutputParams::LUATEX
3147 || features.runparams().flavor == OutputParams::DVILUATEX)
3148 os << "]{luainputenc}\n";
3150 os << "]{inputenc}\n";
3152 if (package == Encoding::CJK || features.mustProvide("CJK")) {
3153 if (language->encoding()->name() == "utf8-cjk"
3154 && LaTeXFeatures::isAvailable("CJKutf8"))
3155 os << "\\usepackage{CJKutf8}\n";
3157 os << "\\usepackage{CJK}\n";
3159 } else if (inputenc != "default") {
3160 switch (encoding().package()) {
3161 case Encoding::none:
3162 case Encoding::japanese:
3164 case Encoding::inputenc:
3165 // do not load inputenc if japanese is used
3166 // or if the class provides inputenc
3167 if (features.isRequired("japanese")
3168 || features.isProvided("inputenc"))
3170 os << "\\usepackage[" << from_ascii(encoding().latexName());
3171 if (features.runparams().flavor == OutputParams::LUATEX
3172 || features.runparams().flavor == OutputParams::DVILUATEX)
3173 os << "]{luainputenc}\n";
3175 os << "]{inputenc}\n";
3178 if (encoding().name() == "utf8-cjk"
3179 && LaTeXFeatures::isAvailable("CJKutf8"))
3180 os << "\\usepackage{CJKutf8}\n";
3182 os << "\\usepackage{CJK}\n";
3185 // Load the CJK package if needed by a secondary language.
3186 // If the main encoding is some variant of UTF8, use CJKutf8.
3187 if (encoding().package() != Encoding::CJK && features.mustProvide("CJK")) {
3188 if (encoding().iconvName() == "UTF-8"
3189 && LaTeXFeatures::isAvailable("CJKutf8"))
3190 os << "\\usepackage{CJKutf8}\n";
3192 os << "\\usepackage{CJK}\n";
3198 string const BufferParams::parseFontName(string const & name) const
3200 string mangled = name;
3201 size_t const idx = mangled.find('[');
3202 if (idx == string::npos || idx == 0)
3205 return mangled.substr(0, idx - 1);
3209 string const BufferParams::loadFonts(LaTeXFeatures & features) const
3211 if (fontsRoman() == "default" && fontsSans() == "default"
3212 && fontsTypewriter() == "default"
3213 && (fontsMath() == "default" || fontsMath() == "auto"))
3219 /* Fontspec (XeTeX, LuaTeX): we provide GUI support for oldstyle
3220 * numbers (Numbers=OldStyle) and sf/tt scaling. The Ligatures=TeX/
3221 * Mapping=tex-text option assures TeX ligatures (such as "--")
3222 * are resolved. Note that tt does not use these ligatures.
3224 * -- add more GUI options?
3225 * -- add more fonts (fonts for other scripts)
3226 * -- if there's a way to find out if a font really supports
3227 * OldStyle, enable/disable the widget accordingly.
3229 if (useNonTeXFonts && features.isAvailable("fontspec")) {
3230 // "Mapping=tex-text" and "Ligatures=TeX" are equivalent.
3231 // However, until v.2 (2010/07/11) fontspec only knew
3232 // Mapping=tex-text (for XeTeX only); then "Ligatures=TeX"
3233 // was introduced for both XeTeX and LuaTeX (LuaTeX
3234 // didn't understand "Mapping=tex-text", while XeTeX
3235 // understood both. With most recent versions, both
3236 // variants are understood by both engines. However,
3237 // we want to provide support for at least TeXLive 2009
3238 // (for XeTeX; LuaTeX is only supported as of v.2)
3239 string const texmapping =
3240 (features.runparams().flavor == OutputParams::XETEX) ?
3241 "Mapping=tex-text" : "Ligatures=TeX";
3242 if (fontsRoman() != "default") {
3243 os << "\\setmainfont[" << texmapping;
3244 if (fonts_old_figures)
3245 os << ",Numbers=OldStyle";
3246 os << "]{" << parseFontName(fontsRoman()) << "}\n";
3248 if (fontsSans() != "default") {
3249 string const sans = parseFontName(fontsSans());
3250 if (fontsSansScale() != 100)
3251 os << "\\setsansfont[Scale="
3252 << float(fontsSansScale()) / 100
3253 << "," << texmapping << "]{"
3256 os << "\\setsansfont[" << texmapping << "]{"
3259 if (fontsTypewriter() != "default") {
3260 string const mono = parseFontName(fontsTypewriter());
3261 if (fontsTypewriterScale() != 100)
3262 os << "\\setmonofont[Scale="
3263 << float(fontsTypewriterScale()) / 100
3267 os << "\\setmonofont{"
3274 bool const ot1 = (main_font_encoding() == "default" || main_font_encoding() == "OT1");
3275 bool const dryrun = features.runparams().dryrun;
3276 bool const complete = (fontsSans() == "default" && fontsTypewriter() == "default");
3277 bool const nomath = (fontsMath() == "default");
3280 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsRoman())).getLaTeXCode(
3281 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3285 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsSans())).getLaTeXCode(
3286 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3287 nomath, fontsSansScale());
3289 // MONOSPACED/TYPEWRITER
3290 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsTypewriter())).getLaTeXCode(
3291 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3292 nomath, fontsTypewriterScale());
3295 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsMath())).getLaTeXCode(
3296 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3303 Encoding const & BufferParams::encoding() const
3305 // Main encoding for LaTeX output.
3307 // Exception: XeTeX with 8-bit TeX fonts requires ASCII (see #9740).
3308 // As the "flavor" is only known once export started, this
3309 // cannot be handled here. Instead, runparams.encoding is set
3310 // to ASCII in Buffer::makeLaTeXFile (for export)
3311 // and Buffer::writeLaTeXSource (for preview).
3313 return *(encodings.fromLyXName("utf8-plain"));
3314 if (inputenc == "auto" || inputenc == "default")
3315 return *language->encoding();
3316 Encoding const * const enc = encodings.fromLyXName(inputenc);
3319 LYXERR0("Unknown inputenc value `" << inputenc
3320 << "'. Using `auto' instead.");
3321 return *language->encoding();
3325 bool BufferParams::addCiteEngine(string const & engine)
3327 LayoutModuleList::const_iterator it = cite_engine_.begin();
3328 LayoutModuleList::const_iterator en = cite_engine_.end();
3329 for (; it != en; ++it)
3332 cite_engine_.push_back(engine);
3337 bool BufferParams::addCiteEngine(vector<string> const & engine)
3339 vector<string>::const_iterator it = engine.begin();
3340 vector<string>::const_iterator en = engine.end();
3342 for (; it != en; ++it)
3343 if (!addCiteEngine(*it))
3349 string const & BufferParams::defaultBiblioStyle() const
3351 map<string, string> const & bs = documentClass().defaultBiblioStyle();
3352 auto cit = bs.find(theCiteEnginesList.getTypeAsString(citeEngineType()));
3353 if (cit != bs.end())
3356 return empty_string();
3360 bool const & BufferParams::fullAuthorList() const
3362 return documentClass().fullAuthorList();
3366 string BufferParams::getCiteAlias(string const & s) const
3368 vector<string> commands =
3369 documentClass().citeCommands(citeEngineType());
3370 // If it is a real command, don't treat it as an alias
3371 if (find(commands.begin(), commands.end(), s) != commands.end())
3373 map<string,string> aliases = documentClass().citeCommandAliases();
3374 if (aliases.find(s) != aliases.end())
3380 void BufferParams::setCiteEngine(string const & engine)
3383 addCiteEngine(engine);
3387 void BufferParams::setCiteEngine(vector<string> const & engine)
3390 addCiteEngine(engine);
3394 vector<string> BufferParams::citeCommands() const
3396 static CitationStyle const default_style;
3397 vector<string> commands =
3398 documentClass().citeCommands(citeEngineType());
3399 if (commands.empty())
3400 commands.push_back(default_style.name);
3405 vector<CitationStyle> BufferParams::citeStyles() const
3407 static CitationStyle const default_style;
3408 vector<CitationStyle> styles =
3409 documentClass().citeStyles(citeEngineType());
3411 styles.push_back(default_style);
3416 string const BufferParams::bibtexCommand() const
3418 // Return document-specific setting if available
3419 if (bibtex_command != "default")
3420 return bibtex_command;
3422 // If we have "default" in document settings, consult the prefs
3423 // 1. Japanese (uses a specific processor)
3424 if (encoding().package() == Encoding::japanese) {
3425 if (lyxrc.jbibtex_command != "automatic")
3426 // Return the specified program, if "automatic" is not set
3427 return lyxrc.jbibtex_command;
3428 else if (!useBiblatex()) {
3429 // With classic BibTeX, return pbibtex, jbibtex, bibtex
3430 if (lyxrc.jbibtex_alternatives.find("pbibtex") != lyxrc.jbibtex_alternatives.end())
3432 if (lyxrc.jbibtex_alternatives.find("jbibtex") != lyxrc.jbibtex_alternatives.end())
3437 // 2. All other languages
3438 else if (lyxrc.bibtex_command != "automatic")
3439 // Return the specified program, if "automatic" is not set
3440 return lyxrc.bibtex_command;
3442 // 3. Automatic: find the most suitable for the current cite framework
3443 if (useBiblatex()) {
3444 // For Biblatex, we prefer biber (also for Japanese)
3445 // and fall back to bibtex8 and, as last resort, bibtex
3446 if (lyxrc.bibtex_alternatives.find("biber") != lyxrc.bibtex_alternatives.end())
3448 else if (lyxrc.bibtex_alternatives.find("bibtex8") != lyxrc.bibtex_alternatives.end())
3455 bool BufferParams::useBiblatex() const
3457 return theCiteEnginesList[citeEngine().list().front()]
3458 ->getCiteFramework() == "biblatex";
3462 void BufferParams::invalidateConverterCache() const
3464 pimpl_->isExportCacheValid = false;
3465 pimpl_->isViewCacheValid = false;