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"
32 #include "IndicesList.h"
34 #include "LaTeXFeatures.h"
35 #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;
340 /** This is the amount of space used for paragraph_separation "skip",
341 * and for detached paragraphs in "indented" documents.
345 PDFOptions pdfoptions;
346 LayoutFileIndex baseClass_;
347 FormatList exportableFormatList;
348 FormatList viewableFormatList;
349 bool isViewCacheValid;
350 bool isExportCacheValid;
354 BufferParams::Impl::Impl()
355 : defskip(VSpace::MEDSKIP), baseClass_(string("")),
356 isViewCacheValid(false), isExportCacheValid(false)
358 // set initial author
360 authorlist.record(Author(from_utf8(lyxrc.user_name), from_utf8(lyxrc.user_email)));
365 BufferParams::MemoryTraits::clone(BufferParams::Impl const * ptr)
368 return new BufferParams::Impl(*ptr);
372 void BufferParams::MemoryTraits::destroy(BufferParams::Impl * ptr)
378 BufferParams::BufferParams()
381 setBaseClass(defaultBaseclass());
382 cite_engine_.push_back("basic");
383 cite_engine_type_ = ENGINE_TYPE_DEFAULT;
385 paragraph_separation = ParagraphIndentSeparation;
386 quotes_style = InsetQuotesParams::EnglishQuotes;
387 dynamic_quotes = false;
388 fontsize = "default";
391 papersize = PAPER_DEFAULT;
392 orientation = ORIENTATION_PORTRAIT;
393 use_geometry = false;
394 biblio_style = "plain";
395 use_bibtopic = false;
398 save_transient_properties = true;
399 track_changes = false;
400 output_changes = false;
401 use_default_options = true;
402 maintain_unincluded_children = false;
405 language = default_language;
407 fonts_roman[0] = "default";
408 fonts_roman[1] = "default";
409 fonts_sans[0] = "default";
410 fonts_sans[1] = "default";
411 fonts_typewriter[0] = "default";
412 fonts_typewriter[1] = "default";
413 fonts_math[0] = "auto";
414 fonts_math[1] = "auto";
415 fonts_default_family = "default";
416 useNonTeXFonts = false;
417 use_microtype = false;
418 use_dash_ligatures = true;
419 fonts_expert_sc = false;
420 fonts_old_figures = false;
421 fonts_sans_scale[0] = 100;
422 fonts_sans_scale[1] = 100;
423 fonts_typewriter_scale[0] = 100;
424 fonts_typewriter_scale[1] = 100;
426 lang_package = "default";
427 graphics_driver = "default";
428 default_output_format = "default";
429 bibtex_command = "default";
430 index_command = "default";
433 listings_params = string();
434 pagestyle = "default";
435 suppress_date = false;
436 justification = true;
437 // no color is the default (white)
438 backgroundcolor = lyx::rgbFromHexName("#ffffff");
439 isbackgroundcolor = false;
440 // no color is the default (black)
441 fontcolor = lyx::rgbFromHexName("#000000");
443 // light gray is the default font color for greyed-out notes
444 notefontcolor = lyx::rgbFromHexName("#cccccc");
445 boxbgcolor = lyx::rgbFromHexName("#ff0000");
446 compressed = lyxrc.save_compressed;
447 for (int iter = 0; iter < 4; ++iter) {
448 user_defined_bullet(iter) = ITEMIZE_DEFAULTS[iter];
449 temp_bullet(iter) = ITEMIZE_DEFAULTS[iter];
452 indiceslist().addDefault(B_("Index"));
453 html_be_strict = false;
454 html_math_output = MathML;
455 html_math_img_scale = 1.0;
456 html_css_as_file = false;
457 display_pixel_ratio = 1.0;
462 // map current author
463 author_map_[pimpl_->authorlist.get(0).bufferId()] = 0;
467 docstring BufferParams::B_(string const & l10n) const
469 LASSERT(language, return from_utf8(l10n));
470 return getMessages(language->code()).get(l10n);
474 BufferParams::Package BufferParams::use_package(std::string const & p) const
476 PackageMap::const_iterator it = use_packages.find(p);
477 if (it == use_packages.end())
483 void BufferParams::use_package(std::string const & p, BufferParams::Package u)
489 map<string, string> const & BufferParams::auto_packages()
491 static map<string, string> packages;
492 if (packages.empty()) {
493 // We could have a race condition here that two threads
494 // discover an empty map at the same time and want to fill
495 // it, but that is no problem, since the same contents is
496 // filled in twice then. Having the locker inside the
497 // packages.empty() condition has the advantage that we
498 // don't need the mutex overhead for simple reading.
500 Mutex::Locker locker(&mutex);
501 // adding a package here implies a file format change!
502 packages["amsmath"] =
503 N_("The LaTeX package amsmath is only used if AMS formula types or symbols from the AMS math toolbars are inserted into formulas");
504 packages["amssymb"] =
505 N_("The LaTeX package amssymb is only used if symbols from the AMS math toolbars are inserted into formulas");
507 N_("The LaTeX package cancel is only used if \\cancel commands are used in formulas");
509 N_("The LaTeX package esint is only used if special integral symbols are inserted into formulas");
510 packages["mathdots"] =
511 N_("The LaTeX package mathdots is only used if the command \\iddots is inserted into formulas");
512 packages["mathtools"] =
513 N_("The LaTeX package mathtools is only used if some mathematical relations are inserted into formulas");
515 N_("The LaTeX package mhchem is only used if either the command \\ce or \\cf is inserted into formulas");
516 packages["stackrel"] =
517 N_("The LaTeX package stackrel is only used if the command \\stackrel with subscript is inserted into formulas");
518 packages["stmaryrd"] =
519 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");
520 packages["undertilde"] =
521 N_("The LaTeX package undertilde is only used if you use the math frame decoration 'utilde'");
527 bool BufferParams::useBibtopic() const
531 return (use_bibtopic || (!multibib.empty() && multibib != "child"));
535 AuthorList & BufferParams::authors()
537 return pimpl_->authorlist;
541 AuthorList const & BufferParams::authors() const
543 return pimpl_->authorlist;
547 void BufferParams::addAuthor(Author a)
549 author_map_[a.bufferId()] = pimpl_->authorlist.record(a);
553 BranchList & BufferParams::branchlist()
555 return pimpl_->branchlist;
559 BranchList const & BufferParams::branchlist() const
561 return pimpl_->branchlist;
565 IndicesList & BufferParams::indiceslist()
567 return pimpl_->indiceslist;
571 IndicesList const & BufferParams::indiceslist() const
573 return pimpl_->indiceslist;
577 Bullet & BufferParams::temp_bullet(lyx::size_type const index)
579 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
580 return pimpl_->temp_bullets[index];
584 Bullet const & BufferParams::temp_bullet(lyx::size_type const index) const
586 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
587 return pimpl_->temp_bullets[index];
591 Bullet & BufferParams::user_defined_bullet(lyx::size_type const index)
593 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
594 return pimpl_->user_defined_bullets[index];
598 Bullet const & BufferParams::user_defined_bullet(lyx::size_type const index) const
600 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
601 return pimpl_->user_defined_bullets[index];
605 Spacing & BufferParams::spacing()
607 return pimpl_->spacing;
611 Spacing const & BufferParams::spacing() const
613 return pimpl_->spacing;
617 PDFOptions & BufferParams::pdfoptions()
619 return pimpl_->pdfoptions;
623 PDFOptions const & BufferParams::pdfoptions() const
625 return pimpl_->pdfoptions;
629 HSpace const & BufferParams::getIndentation() const
631 return pimpl_->indentation;
635 void BufferParams::setIndentation(HSpace const & indent)
637 pimpl_->indentation = indent;
641 VSpace const & BufferParams::getDefSkip() const
643 return pimpl_->defskip;
647 void BufferParams::setDefSkip(VSpace const & vs)
649 // DEFSKIP will cause an infinite loop
650 LASSERT(vs.kind() != VSpace::DEFSKIP, return);
651 pimpl_->defskip = vs;
655 string BufferParams::readToken(Lexer & lex, string const & token,
656 FileName const & filepath)
660 if (token == "\\textclass") {
662 string const classname = lex.getString();
663 // if there exists a local layout file, ignore the system one
664 // NOTE: in this case, the textclass (.cls file) is assumed to
667 LayoutFileList & bcl = LayoutFileList::get();
668 if (!filepath.empty()) {
669 // If classname is an absolute path, the document is
670 // using a local layout file which could not be accessed
671 // by a relative path. In this case the path is correct
672 // even if the document was moved to a different
673 // location. However, we will have a problem if the
674 // document was generated on a different platform.
675 bool isabsolute = FileName::isAbsolute(classname);
676 string const classpath = onlyPath(classname);
677 string const path = isabsolute ? classpath
678 : FileName(addPath(filepath.absFileName(),
679 classpath)).realPath();
680 string const oldpath = isabsolute ? string()
681 : FileName(addPath(origin, classpath)).realPath();
682 tcp = bcl.addLocalLayout(onlyFileName(classname), path, oldpath);
684 // that returns non-empty if a "local" layout file is found.
686 result = to_utf8(makeRelPath(from_utf8(onlyPath(tcp)),
687 from_utf8(filepath.absFileName())));
690 setBaseClass(onlyFileName(tcp));
692 setBaseClass(onlyFileName(classname));
693 // We assume that a tex class exists for local or unknown
694 // layouts so this warning, will only be given for system layouts.
695 if (!baseClass()->isTeXClassAvailable()) {
696 docstring const desc =
697 translateIfPossible(from_utf8(baseClass()->description()));
698 docstring const prereqs =
699 from_utf8(baseClass()->prerequisites());
700 docstring const msg =
701 bformat(_("The selected document class\n"
703 "requires external files that are not available.\n"
704 "The document class can still be used, but the\n"
705 "document cannot be compiled until the following\n"
706 "prerequisites are installed:\n"
708 "See section 3.1.2.2 (Class Availability) of the\n"
709 "User's Guide for more information."), desc, prereqs);
710 frontend::Alert::warning(_("Document class not available"),
713 } else if (token == "\\save_transient_properties") {
714 lex >> save_transient_properties;
715 } else if (token == "\\origin") {
717 origin = lex.getString();
718 string const sysdirprefix = "/systemlyxdir/";
719 if (prefixIs(origin, sysdirprefix)) {
721 if (inSystemDir(filepath, docsys))
722 origin.replace(0, sysdirprefix.length() - 1, docsys);
724 origin.replace(0, sysdirprefix.length() - 1,
725 package().system_support().absFileName());
727 } else if (token == "\\begin_preamble") {
729 } else if (token == "\\begin_local_layout") {
730 readLocalLayout(lex, false);
731 } else if (token == "\\begin_forced_local_layout") {
732 readLocalLayout(lex, true);
733 } else if (token == "\\begin_modules") {
735 } else if (token == "\\begin_removed_modules") {
736 readRemovedModules(lex);
737 } else if (token == "\\begin_includeonly") {
738 readIncludeonly(lex);
739 } else if (token == "\\maintain_unincluded_children") {
740 lex >> maintain_unincluded_children;
741 } else if (token == "\\options") {
743 options = lex.getString();
744 } else if (token == "\\use_default_options") {
745 lex >> use_default_options;
746 } else if (token == "\\master") {
748 master = lex.getString();
749 if (!filepath.empty() && FileName::isAbsolute(origin)) {
750 bool const isabs = FileName::isAbsolute(master);
751 FileName const abspath(isabs ? master : origin + master);
752 bool const moved = filepath != FileName(origin);
753 if (moved && abspath.exists()) {
754 docstring const path = isabs
756 : from_utf8(abspath.realPath());
757 docstring const refpath =
758 from_utf8(filepath.absFileName());
759 master = to_utf8(makeRelPath(path, refpath));
762 } else if (token == "\\suppress_date") {
763 lex >> suppress_date;
764 } else if (token == "\\justification") {
765 lex >> justification;
766 } else if (token == "\\language") {
768 } else if (token == "\\language_package") {
770 lang_package = lex.getString();
771 } else if (token == "\\inputencoding") {
773 } else if (token == "\\graphics") {
774 readGraphicsDriver(lex);
775 } else if (token == "\\default_output_format") {
776 lex >> default_output_format;
777 } else if (token == "\\bibtex_command") {
779 bibtex_command = lex.getString();
780 } else if (token == "\\index_command") {
782 index_command = lex.getString();
783 } else if (token == "\\fontencoding") {
785 fontenc = lex.getString();
786 } else if (token == "\\font_roman") {
787 lex >> fonts_roman[0];
788 lex >> fonts_roman[1];
789 } else if (token == "\\font_sans") {
790 lex >> fonts_sans[0];
791 lex >> fonts_sans[1];
792 } else if (token == "\\font_typewriter") {
793 lex >> fonts_typewriter[0];
794 lex >> fonts_typewriter[1];
795 } else if (token == "\\font_math") {
796 lex >> fonts_math[0];
797 lex >> fonts_math[1];
798 } else if (token == "\\font_default_family") {
799 lex >> fonts_default_family;
800 } else if (token == "\\use_non_tex_fonts") {
801 lex >> useNonTeXFonts;
802 } else if (token == "\\font_sc") {
803 lex >> fonts_expert_sc;
804 } else if (token == "\\font_osf") {
805 lex >> fonts_old_figures;
806 } else if (token == "\\font_sf_scale") {
807 lex >> fonts_sans_scale[0];
808 lex >> fonts_sans_scale[1];
809 } else if (token == "\\font_tt_scale") {
810 lex >> fonts_typewriter_scale[0];
811 lex >> fonts_typewriter_scale[1];
812 } else if (token == "\\font_cjk") {
814 } else if (token == "\\use_microtype") {
815 lex >> use_microtype;
816 } else if (token == "\\use_dash_ligatures") {
817 lex >> use_dash_ligatures;
818 } else if (token == "\\paragraph_separation") {
821 paragraph_separation = parseptranslator().find(parsep);
822 } else if (token == "\\paragraph_indentation") {
824 string indentation = lex.getString();
825 pimpl_->indentation = HSpace(indentation);
826 } else if (token == "\\defskip") {
828 string const defskip = lex.getString();
829 pimpl_->defskip = VSpace(defskip);
830 if (pimpl_->defskip.kind() == VSpace::DEFSKIP)
832 pimpl_->defskip = VSpace(VSpace::MEDSKIP);
833 } else if (token == "\\quotes_style") {
836 quotes_style = quotesstyletranslator().find(qstyle);
837 } else if (token == "\\dynamic_quotes") {
838 lex >> dynamic_quotes;
839 } else if (token == "\\papersize") {
842 papersize = papersizetranslator().find(ppsize);
843 } else if (token == "\\use_geometry") {
845 } else if (token == "\\use_package") {
850 use_package(package, packagetranslator().find(use));
851 } else if (token == "\\cite_engine") {
853 vector<string> engine = getVectorFromString(lex.getString());
854 setCiteEngine(engine);
855 } else if (token == "\\cite_engine_type") {
858 cite_engine_type_ = theCiteEnginesList.getType(engine_type);
859 } else if (token == "\\biblio_style") {
861 biblio_style = lex.getString();
862 } else if (token == "\\biblio_options") {
864 biblio_opts = trim(lex.getString());
865 } else if (token == "\\biblatex_bibstyle") {
867 biblatex_bibstyle = trim(lex.getString());
868 } else if (token == "\\biblatex_citestyle") {
870 biblatex_citestyle = trim(lex.getString());
871 } else if (token == "\\use_bibtopic") {
873 } else if (token == "\\multibib") {
875 } else if (token == "\\use_indices") {
877 } else if (token == "\\tracking_changes") {
878 lex >> track_changes;
879 } else if (token == "\\output_changes") {
880 lex >> output_changes;
881 } else if (token == "\\branch") {
883 docstring branch = lex.getDocString();
884 branchlist().add(branch);
887 string const tok = lex.getString();
888 if (tok == "\\end_branch")
890 Branch * branch_ptr = branchlist().find(branch);
891 if (tok == "\\selected") {
894 branch_ptr->setSelected(lex.getInteger());
896 if (tok == "\\filename_suffix") {
899 branch_ptr->setFileNameSuffix(lex.getInteger());
901 if (tok == "\\color") {
903 string color = lex.getString();
905 branch_ptr->setColor(color);
906 // Update also the Color table:
908 color = lcolor.getX11Name(Color_background);
910 lcolor.setColor(to_utf8(branch), color);
913 } else if (token == "\\index") {
915 docstring index = lex.getDocString();
917 indiceslist().add(index);
920 string const tok = lex.getString();
921 if (tok == "\\end_index")
923 Index * index_ptr = indiceslist().find(index);
924 if (tok == "\\shortcut") {
926 shortcut = lex.getDocString();
928 index_ptr->setShortcut(shortcut);
930 if (tok == "\\color") {
932 string color = lex.getString();
934 index_ptr->setColor(color);
935 // Update also the Color table:
937 color = lcolor.getX11Name(Color_background);
939 if (!shortcut.empty())
940 lcolor.setColor(to_utf8(shortcut), color);
943 } else if (token == "\\author") {
945 istringstream ss(lex.getString());
949 } else if (token == "\\paperorientation") {
952 orientation = paperorientationtranslator().find(orient);
953 } else if (token == "\\backgroundcolor") {
955 backgroundcolor = lyx::rgbFromHexName(lex.getString());
956 isbackgroundcolor = true;
957 } else if (token == "\\fontcolor") {
959 fontcolor = lyx::rgbFromHexName(lex.getString());
961 } else if (token == "\\notefontcolor") {
963 string color = lex.getString();
964 notefontcolor = lyx::rgbFromHexName(color);
965 lcolor.setColor("notefontcolor", color);
966 } else if (token == "\\boxbgcolor") {
968 string color = lex.getString();
969 boxbgcolor = lyx::rgbFromHexName(color);
970 lcolor.setColor("boxbgcolor", color);
971 } else if (token == "\\paperwidth") {
973 } else if (token == "\\paperheight") {
975 } else if (token == "\\leftmargin") {
977 } else if (token == "\\topmargin") {
979 } else if (token == "\\rightmargin") {
981 } else if (token == "\\bottommargin") {
983 } else if (token == "\\headheight") {
985 } else if (token == "\\headsep") {
987 } else if (token == "\\footskip") {
989 } else if (token == "\\columnsep") {
991 } else if (token == "\\paperfontsize") {
993 } else if (token == "\\papercolumns") {
995 } else if (token == "\\listings_params") {
998 listings_params = InsetListingsParams(par).params();
999 } else if (token == "\\papersides") {
1002 sides = sidestranslator().find(psides);
1003 } else if (token == "\\paperpagestyle") {
1005 } else if (token == "\\bullet") {
1007 } else if (token == "\\bulletLaTeX") {
1008 readBulletsLaTeX(lex);
1009 } else if (token == "\\secnumdepth") {
1011 } else if (token == "\\tocdepth") {
1013 } else if (token == "\\spacing") {
1017 if (nspacing == "other") {
1020 spacing().set(spacetranslator().find(nspacing), tmp_val);
1021 } else if (token == "\\float_placement") {
1022 lex >> float_placement;
1024 } else if (prefixIs(token, "\\pdf_") || token == "\\use_hyperref") {
1025 string toktmp = pdfoptions().readToken(lex, token);
1026 if (!toktmp.empty()) {
1027 lyxerr << "PDFOptions::readToken(): Unknown token: " <<
1031 } else if (token == "\\html_math_output") {
1034 html_math_output = static_cast<MathOutput>(temp);
1035 } else if (token == "\\html_be_strict") {
1036 lex >> html_be_strict;
1037 } else if (token == "\\html_css_as_file") {
1038 lex >> html_css_as_file;
1039 } else if (token == "\\html_math_img_scale") {
1040 lex >> html_math_img_scale;
1041 } else if (token == "\\html_latex_start") {
1043 html_latex_start = lex.getString();
1044 } else if (token == "\\html_latex_end") {
1046 html_latex_end = lex.getString();
1047 } else if (token == "\\output_sync") {
1049 } else if (token == "\\output_sync_macro") {
1050 lex >> output_sync_macro;
1051 } else if (token == "\\use_refstyle") {
1052 lex >> use_refstyle;
1054 lyxerr << "BufferParams::readToken(): Unknown token: " <<
1064 // Quote argument if it contains spaces
1065 string quoteIfNeeded(string const & str) {
1066 if (contains(str, ' '))
1067 return "\"" + str + "\"";
1073 void BufferParams::writeFile(ostream & os, Buffer const * buf) const
1075 // The top of the file is written by the buffer.
1076 // Prints out the buffer info into the .lyx file given by file
1078 os << "\\save_transient_properties "
1079 << convert<string>(save_transient_properties) << '\n';
1081 // the document directory (must end with a path separator)
1082 // realPath() is used to resolve symlinks, while addPath(..., "")
1083 // ensures a trailing path separator.
1085 string filepath = addPath(buf->fileName().onlyPath().realPath(), "");
1086 string const sysdir = inSystemDir(FileName(filepath), docsys) ? docsys
1087 : addPath(package().system_support().realPath(), "");
1088 string const relpath =
1089 to_utf8(makeRelPath(from_utf8(filepath), from_utf8(sysdir)));
1090 if (!prefixIs(relpath, "../") && !FileName::isAbsolute(relpath))
1091 filepath = addPath("/systemlyxdir", relpath);
1092 else if (!save_transient_properties || !lyxrc.save_origin)
1093 filepath = "unavailable";
1094 os << "\\origin " << quoteIfNeeded(filepath) << '\n';
1097 os << "\\textclass "
1098 << quoteIfNeeded(buf->includedFilePath(addName(buf->layoutPos(),
1099 baseClass()->name()), "layout"))
1102 // then the preamble
1103 if (!preamble.empty()) {
1104 // remove '\n' from the end of preamble
1105 docstring const tmppreamble = rtrim(preamble, "\n");
1106 os << "\\begin_preamble\n"
1107 << to_utf8(tmppreamble)
1108 << "\n\\end_preamble\n";
1112 if (!options.empty()) {
1113 os << "\\options " << options << '\n';
1116 // use the class options defined in the layout?
1117 os << "\\use_default_options "
1118 << convert<string>(use_default_options) << "\n";
1120 // the master document
1121 if (!master.empty()) {
1122 os << "\\master " << master << '\n';
1126 if (!removed_modules_.empty()) {
1127 os << "\\begin_removed_modules" << '\n';
1128 list<string>::const_iterator it = removed_modules_.begin();
1129 list<string>::const_iterator en = removed_modules_.end();
1130 for (; it != en; ++it)
1132 os << "\\end_removed_modules" << '\n';
1136 if (!layout_modules_.empty()) {
1137 os << "\\begin_modules" << '\n';
1138 LayoutModuleList::const_iterator it = layout_modules_.begin();
1139 LayoutModuleList::const_iterator en = layout_modules_.end();
1140 for (; it != en; ++it)
1142 os << "\\end_modules" << '\n';
1146 if (!included_children_.empty()) {
1147 os << "\\begin_includeonly" << '\n';
1148 list<string>::const_iterator it = included_children_.begin();
1149 list<string>::const_iterator en = included_children_.end();
1150 for (; it != en; ++it)
1152 os << "\\end_includeonly" << '\n';
1154 os << "\\maintain_unincluded_children "
1155 << convert<string>(maintain_unincluded_children) << '\n';
1157 // local layout information
1158 docstring const local_layout = getLocalLayout(false);
1159 if (!local_layout.empty()) {
1160 // remove '\n' from the end
1161 docstring const tmplocal = rtrim(local_layout, "\n");
1162 os << "\\begin_local_layout\n"
1163 << to_utf8(tmplocal)
1164 << "\n\\end_local_layout\n";
1166 docstring const forced_local_layout = getLocalLayout(true);
1167 if (!forced_local_layout.empty()) {
1168 // remove '\n' from the end
1169 docstring const tmplocal = rtrim(forced_local_layout, "\n");
1170 os << "\\begin_forced_local_layout\n"
1171 << to_utf8(tmplocal)
1172 << "\n\\end_forced_local_layout\n";
1175 // then the text parameters
1176 if (language != ignore_language)
1177 os << "\\language " << language->lang() << '\n';
1178 os << "\\language_package " << lang_package
1179 << "\n\\inputencoding " << inputenc
1180 << "\n\\fontencoding " << fontenc
1181 << "\n\\font_roman \"" << fonts_roman[0]
1182 << "\" \"" << fonts_roman[1] << '"'
1183 << "\n\\font_sans \"" << fonts_sans[0]
1184 << "\" \"" << fonts_sans[1] << '"'
1185 << "\n\\font_typewriter \"" << fonts_typewriter[0]
1186 << "\" \"" << fonts_typewriter[1] << '"'
1187 << "\n\\font_math \"" << fonts_math[0]
1188 << "\" \"" << fonts_math[1] << '"'
1189 << "\n\\font_default_family " << fonts_default_family
1190 << "\n\\use_non_tex_fonts " << convert<string>(useNonTeXFonts)
1191 << "\n\\font_sc " << convert<string>(fonts_expert_sc)
1192 << "\n\\font_osf " << convert<string>(fonts_old_figures)
1193 << "\n\\font_sf_scale " << fonts_sans_scale[0]
1194 << ' ' << fonts_sans_scale[1]
1195 << "\n\\font_tt_scale " << fonts_typewriter_scale[0]
1196 << ' ' << fonts_typewriter_scale[1]
1198 if (!fonts_cjk.empty()) {
1199 os << "\\font_cjk " << fonts_cjk << '\n';
1201 os << "\\use_microtype " << convert<string>(use_microtype) << '\n';
1202 os << "\\use_dash_ligatures " << convert<string>(use_dash_ligatures) << '\n';
1203 os << "\\graphics " << graphics_driver << '\n';
1204 os << "\\default_output_format " << default_output_format << '\n';
1205 os << "\\output_sync " << output_sync << '\n';
1206 if (!output_sync_macro.empty())
1207 os << "\\output_sync_macro \"" << output_sync_macro << "\"\n";
1208 os << "\\bibtex_command " << bibtex_command << '\n';
1209 os << "\\index_command " << index_command << '\n';
1211 if (!float_placement.empty()) {
1212 os << "\\float_placement " << float_placement << '\n';
1214 os << "\\paperfontsize " << fontsize << '\n';
1216 spacing().writeFile(os);
1217 pdfoptions().writeFile(os);
1219 os << "\\papersize " << string_papersize[papersize]
1220 << "\n\\use_geometry " << convert<string>(use_geometry);
1221 map<string, string> const & packages = auto_packages();
1222 for (map<string, string>::const_iterator it = packages.begin();
1223 it != packages.end(); ++it)
1224 os << "\n\\use_package " << it->first << ' '
1225 << use_package(it->first);
1227 os << "\n\\cite_engine ";
1229 if (!cite_engine_.empty()) {
1230 LayoutModuleList::const_iterator be = cite_engine_.begin();
1231 LayoutModuleList::const_iterator en = cite_engine_.end();
1232 for (LayoutModuleList::const_iterator it = be; it != en; ++it) {
1241 os << "\n\\cite_engine_type " << theCiteEnginesList.getTypeAsString(cite_engine_type_);
1243 if (!biblio_style.empty())
1244 os << "\n\\biblio_style " << biblio_style;
1245 if (!biblio_opts.empty())
1246 os << "\n\\biblio_options " << biblio_opts;
1247 if (!biblatex_bibstyle.empty())
1248 os << "\n\\biblatex_bibstyle " << biblatex_bibstyle;
1249 if (!biblatex_citestyle.empty())
1250 os << "\n\\biblatex_citestyle " << biblatex_citestyle;
1251 if (!multibib.empty())
1252 os << "\n\\multibib " << multibib;
1254 os << "\n\\use_bibtopic " << convert<string>(use_bibtopic)
1255 << "\n\\use_indices " << convert<string>(use_indices)
1256 << "\n\\paperorientation " << string_orientation[orientation]
1257 << "\n\\suppress_date " << convert<string>(suppress_date)
1258 << "\n\\justification " << convert<string>(justification)
1259 << "\n\\use_refstyle " << use_refstyle
1261 if (isbackgroundcolor == true)
1262 os << "\\backgroundcolor " << lyx::X11hexname(backgroundcolor) << '\n';
1263 if (isfontcolor == true)
1264 os << "\\fontcolor " << lyx::X11hexname(fontcolor) << '\n';
1265 if (notefontcolor != lyx::rgbFromHexName("#cccccc"))
1266 os << "\\notefontcolor " << lyx::X11hexname(notefontcolor) << '\n';
1267 if (boxbgcolor != lyx::rgbFromHexName("#ff0000"))
1268 os << "\\boxbgcolor " << lyx::X11hexname(boxbgcolor) << '\n';
1270 BranchList::const_iterator it = branchlist().begin();
1271 BranchList::const_iterator end = branchlist().end();
1272 for (; it != end; ++it) {
1273 os << "\\branch " << to_utf8(it->branch())
1274 << "\n\\selected " << it->isSelected()
1275 << "\n\\filename_suffix " << it->hasFileNameSuffix()
1276 << "\n\\color " << lyx::X11hexname(it->color())
1281 IndicesList::const_iterator iit = indiceslist().begin();
1282 IndicesList::const_iterator iend = indiceslist().end();
1283 for (; iit != iend; ++iit) {
1284 os << "\\index " << to_utf8(iit->index())
1285 << "\n\\shortcut " << to_utf8(iit->shortcut())
1286 << "\n\\color " << lyx::X11hexname(iit->color())
1291 if (!paperwidth.empty())
1292 os << "\\paperwidth "
1293 << VSpace(paperwidth).asLyXCommand() << '\n';
1294 if (!paperheight.empty())
1295 os << "\\paperheight "
1296 << VSpace(paperheight).asLyXCommand() << '\n';
1297 if (!leftmargin.empty())
1298 os << "\\leftmargin "
1299 << VSpace(leftmargin).asLyXCommand() << '\n';
1300 if (!topmargin.empty())
1301 os << "\\topmargin "
1302 << VSpace(topmargin).asLyXCommand() << '\n';
1303 if (!rightmargin.empty())
1304 os << "\\rightmargin "
1305 << VSpace(rightmargin).asLyXCommand() << '\n';
1306 if (!bottommargin.empty())
1307 os << "\\bottommargin "
1308 << VSpace(bottommargin).asLyXCommand() << '\n';
1309 if (!headheight.empty())
1310 os << "\\headheight "
1311 << VSpace(headheight).asLyXCommand() << '\n';
1312 if (!headsep.empty())
1314 << VSpace(headsep).asLyXCommand() << '\n';
1315 if (!footskip.empty())
1317 << VSpace(footskip).asLyXCommand() << '\n';
1318 if (!columnsep.empty())
1319 os << "\\columnsep "
1320 << VSpace(columnsep).asLyXCommand() << '\n';
1321 os << "\\secnumdepth " << secnumdepth
1322 << "\n\\tocdepth " << tocdepth
1323 << "\n\\paragraph_separation "
1324 << string_paragraph_separation[paragraph_separation];
1325 if (!paragraph_separation)
1326 os << "\n\\paragraph_indentation " << getIndentation().asLyXCommand();
1328 os << "\n\\defskip " << getDefSkip().asLyXCommand();
1329 os << "\n\\quotes_style "
1330 << string_quotes_style[quotes_style]
1331 << "\n\\dynamic_quotes " << dynamic_quotes
1332 << "\n\\papercolumns " << columns
1333 << "\n\\papersides " << sides
1334 << "\n\\paperpagestyle " << pagestyle << '\n';
1335 if (!listings_params.empty())
1336 os << "\\listings_params \"" <<
1337 InsetListingsParams(listings_params).encodedString() << "\"\n";
1338 for (int i = 0; i < 4; ++i) {
1339 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1340 if (user_defined_bullet(i).getFont() != -1) {
1341 os << "\\bullet " << i << " "
1342 << user_defined_bullet(i).getFont() << " "
1343 << user_defined_bullet(i).getCharacter() << " "
1344 << user_defined_bullet(i).getSize() << "\n";
1348 os << "\\bulletLaTeX " << i << " \""
1349 << lyx::to_ascii(user_defined_bullet(i).getText())
1355 os << "\\tracking_changes "
1356 << (save_transient_properties ? convert<string>(track_changes) : "false")
1359 os << "\\output_changes "
1360 << (save_transient_properties ? convert<string>(output_changes) : "false")
1363 os << "\\html_math_output " << html_math_output << '\n'
1364 << "\\html_css_as_file " << html_css_as_file << '\n'
1365 << "\\html_be_strict " << convert<string>(html_be_strict) << '\n';
1367 if (html_math_img_scale != 1.0)
1368 os << "\\html_math_img_scale " << convert<string>(html_math_img_scale) << '\n';
1369 if (!html_latex_start.empty())
1370 os << "\\html_latex_start " << html_latex_start << '\n';
1371 if (!html_latex_end.empty())
1372 os << "\\html_latex_end " << html_latex_end << '\n';
1374 os << pimpl_->authorlist;
1378 void BufferParams::validate(LaTeXFeatures & features) const
1380 features.require(documentClass().requires());
1382 if (columns > 1 && language->rightToLeft())
1383 features.require("rtloutputdblcol");
1385 if (output_changes) {
1386 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1387 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1388 LaTeXFeatures::isAvailable("xcolor");
1390 switch (features.runparams().flavor) {
1391 case OutputParams::LATEX:
1392 case OutputParams::DVILUATEX:
1394 features.require("ct-dvipost");
1395 features.require("dvipost");
1396 } else if (xcolorulem) {
1397 features.require("ct-xcolor-ulem");
1398 features.require("ulem");
1399 features.require("xcolor");
1401 features.require("ct-none");
1404 case OutputParams::LUATEX:
1405 case OutputParams::PDFLATEX:
1406 case OutputParams::XETEX:
1408 features.require("ct-xcolor-ulem");
1409 features.require("ulem");
1410 features.require("xcolor");
1411 // improves color handling in PDF output
1412 features.require("pdfcolmk");
1414 features.require("ct-none");
1422 // Floats with 'Here definitely' as default setting.
1423 if (float_placement.find('H') != string::npos)
1424 features.require("float");
1426 for (PackageMap::const_iterator it = use_packages.begin();
1427 it != use_packages.end(); ++it) {
1428 if (it->first == "amsmath") {
1429 // AMS Style is at document level
1430 if (it->second == package_on ||
1431 features.isProvided("amsmath"))
1432 features.require(it->first);
1433 } else if (it->second == package_on)
1434 features.require(it->first);
1437 // Document-level line spacing
1438 if (spacing().getSpace() != Spacing::Single && !spacing().isDefault())
1439 features.require("setspace");
1441 // the bullet shapes are buffer level not paragraph level
1442 // so they are tested here
1443 for (int i = 0; i < 4; ++i) {
1444 if (user_defined_bullet(i) == ITEMIZE_DEFAULTS[i])
1446 int const font = user_defined_bullet(i).getFont();
1448 int const c = user_defined_bullet(i).getCharacter();
1454 features.require("latexsym");
1456 } else if (font == 1) {
1457 features.require("amssymb");
1458 } else if (font >= 2 && font <= 5) {
1459 features.require("pifont");
1463 if (pdfoptions().use_hyperref) {
1464 features.require("hyperref");
1465 // due to interferences with babel and hyperref, the color package has to
1466 // be loaded after hyperref when hyperref is used with the colorlinks
1467 // option, see http://www.lyx.org/trac/ticket/5291
1468 if (pdfoptions().colorlinks)
1469 features.require("color");
1471 if (!listings_params.empty()) {
1472 // do not test validity because listings_params is
1473 // supposed to be valid
1475 InsetListingsParams(listings_params).separatedParams(true);
1476 // we can't support all packages, but we should load the color package
1477 if (par.find("\\color", 0) != string::npos)
1478 features.require("color");
1481 // some languages are only available via polyglossia
1482 if (features.hasPolyglossiaExclusiveLanguages())
1483 features.require("polyglossia");
1485 if (useNonTeXFonts && fontsMath() != "auto")
1486 features.require("unicode-math");
1489 features.require("microtype");
1491 if (!language->requires().empty())
1492 features.require(language->requires());
1496 bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
1497 FileName const & filepath) const
1499 // http://www.tug.org/texmf-dist/doc/latex/base/fixltx2e.pdf
1500 // !! To use the Fix-cm package, load it before \documentclass, and use the command
1501 // \RequirePackage to do so, rather than the normal \usepackage
1502 // Do not try to load any other package before the document class, unless you
1503 // have a thorough understanding of the LATEX internals and know exactly what you
1505 if (features.mustProvide("fix-cm"))
1506 os << "\\RequirePackage{fix-cm}\n";
1507 // Likewise for fixltx2e. If other packages conflict with this policy,
1508 // treat it as a package bug (and report it!)
1509 // See http://www.latex-project.org/cgi-bin/ltxbugs2html?pr=latex/4407
1510 if (features.mustProvide("fixltx2e"))
1511 os << "\\RequirePackage{fixltx2e}\n";
1513 os << "\\documentclass";
1515 DocumentClass const & tclass = documentClass();
1517 ostringstream clsoptions; // the document class options.
1519 if (tokenPos(tclass.opt_fontsize(),
1520 '|', fontsize) >= 0) {
1521 // only write if existing in list (and not default)
1522 clsoptions << fontsize << "pt,";
1525 // all paper sizes except of A4, A5, B5 and the US sizes need the
1527 bool nonstandard_papersize = papersize != PAPER_DEFAULT
1528 && papersize != PAPER_USLETTER
1529 && papersize != PAPER_USLEGAL
1530 && papersize != PAPER_USEXECUTIVE
1531 && papersize != PAPER_A4
1532 && papersize != PAPER_A5
1533 && papersize != PAPER_B5;
1535 if (!use_geometry) {
1536 switch (papersize) {
1538 clsoptions << "a4paper,";
1540 case PAPER_USLETTER:
1541 clsoptions << "letterpaper,";
1544 clsoptions << "a5paper,";
1547 clsoptions << "b5paper,";
1549 case PAPER_USEXECUTIVE:
1550 clsoptions << "executivepaper,";
1553 clsoptions << "legalpaper,";
1587 if (sides != tclass.sides()) {
1590 clsoptions << "oneside,";
1593 clsoptions << "twoside,";
1599 if (columns != tclass.columns()) {
1601 clsoptions << "twocolumn,";
1603 clsoptions << "onecolumn,";
1607 && orientation == ORIENTATION_LANDSCAPE)
1608 clsoptions << "landscape,";
1610 // language should be a parameter to \documentclass
1611 if (language->babel() == "hebrew"
1612 && default_language->babel() != "hebrew")
1613 // This seems necessary
1614 features.useLanguage(default_language);
1616 ostringstream language_options;
1617 bool const use_babel = features.useBabel() && !features.isProvided("babel");
1618 bool const use_polyglossia = features.usePolyglossia();
1619 bool const global = lyxrc.language_global_options;
1620 if (use_babel || (use_polyglossia && global)) {
1621 language_options << features.getBabelLanguages();
1622 if (!language->babel().empty()) {
1623 if (!language_options.str().empty())
1624 language_options << ',';
1625 language_options << language->babel();
1627 if (global && !features.needBabelLangOptions()
1628 && !language_options.str().empty())
1629 clsoptions << language_options.str() << ',';
1632 // the predefined options from the layout
1633 if (use_default_options && !tclass.options().empty())
1634 clsoptions << tclass.options() << ',';
1636 // the user-defined options
1637 if (!options.empty()) {
1638 clsoptions << options << ',';
1641 string strOptions(clsoptions.str());
1642 if (!strOptions.empty()) {
1643 strOptions = rtrim(strOptions, ",");
1645 os << '[' << from_utf8(strOptions) << ']';
1648 os << '{' << from_ascii(tclass.latexname()) << "}\n";
1649 // end of \documentclass defs
1651 // if we use fontspec or newtxmath, we have to load the AMS packages here
1652 string const ams = features.loadAMSPackages();
1653 bool const ot1 = (main_font_encoding() == "default" || main_font_encoding() == "OT1");
1654 bool const use_newtxmath =
1655 theLaTeXFonts().getLaTeXFont(from_ascii(fontsMath())).getUsedPackage(
1656 ot1, false, false) == "newtxmath";
1657 if ((useNonTeXFonts || use_newtxmath) && !ams.empty())
1658 os << from_ascii(ams);
1660 if (useNonTeXFonts) {
1661 if (!features.isProvided("fontspec"))
1662 os << "\\usepackage{fontspec}\n";
1663 if (features.mustProvide("unicode-math")
1664 && features.isAvailable("unicode-math"))
1665 os << "\\usepackage{unicode-math}\n";
1668 // font selection must be done before loading fontenc.sty
1669 string const fonts = loadFonts(features);
1671 os << from_utf8(fonts);
1673 if (fonts_default_family != "default")
1674 os << "\\renewcommand{\\familydefault}{\\"
1675 << from_ascii(fonts_default_family) << "}\n";
1677 // set font encoding
1678 // XeTeX and LuaTeX (with OS fonts) do not need fontenc
1679 if (!useNonTeXFonts && !features.isProvided("fontenc")
1680 && main_font_encoding() != "default") {
1681 // get main font encodings
1682 vector<string> fontencs = font_encodings();
1683 // get font encodings of secondary languages
1684 features.getFontEncodings(fontencs);
1685 if (!fontencs.empty()) {
1686 os << "\\usepackage["
1687 << from_ascii(getStringFromVector(fontencs))
1692 // handle inputenc etc.
1693 writeEncodingPreamble(os, features);
1696 if (!features.runparams().includeall && !included_children_.empty()) {
1697 os << "\\includeonly{";
1698 list<string>::const_iterator it = included_children_.begin();
1699 list<string>::const_iterator en = included_children_.end();
1701 for (; it != en; ++it) {
1702 string incfile = *it;
1703 FileName inc = makeAbsPath(incfile, filepath.absFileName());
1704 string mangled = DocFileName(changeExtension(inc.absFileName(), ".tex")).
1706 if (!features.runparams().nice)
1708 // \includeonly doesn't want an extension
1709 incfile = changeExtension(incfile, string());
1710 incfile = support::latex_path(incfile);
1711 if (!incfile.empty()) {
1714 os << from_utf8(incfile);
1721 if (!features.isProvided("geometry")
1722 && (use_geometry || nonstandard_papersize)) {
1723 odocstringstream ods;
1724 if (!getGraphicsDriver("geometry").empty())
1725 ods << getGraphicsDriver("geometry");
1726 if (orientation == ORIENTATION_LANDSCAPE)
1727 ods << ",landscape";
1728 switch (papersize) {
1730 if (!paperwidth.empty())
1731 ods << ",paperwidth="
1732 << from_ascii(paperwidth);
1733 if (!paperheight.empty())
1734 ods << ",paperheight="
1735 << from_ascii(paperheight);
1737 case PAPER_USLETTER:
1738 ods << ",letterpaper";
1741 ods << ",legalpaper";
1743 case PAPER_USEXECUTIVE:
1744 ods << ",executivepaper";
1833 docstring const g_options = trim(ods.str(), ",");
1834 os << "\\usepackage";
1835 if (!g_options.empty())
1836 os << '[' << g_options << ']';
1837 os << "{geometry}\n";
1838 // output this only if use_geometry is true
1840 os << "\\geometry{verbose";
1841 if (!topmargin.empty())
1842 os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1843 if (!bottommargin.empty())
1844 os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1845 if (!leftmargin.empty())
1846 os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1847 if (!rightmargin.empty())
1848 os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1849 if (!headheight.empty())
1850 os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1851 if (!headsep.empty())
1852 os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1853 if (!footskip.empty())
1854 os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1855 if (!columnsep.empty())
1856 os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
1859 } else if (orientation == ORIENTATION_LANDSCAPE
1860 || papersize != PAPER_DEFAULT) {
1861 features.require("papersize");
1864 if (tokenPos(tclass.opt_pagestyle(), '|', pagestyle) >= 0) {
1865 if (pagestyle == "fancy")
1866 os << "\\usepackage{fancyhdr}\n";
1867 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1870 // only output when the background color is not default
1871 if (isbackgroundcolor == true) {
1872 // only require color here, the background color will be defined
1873 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1875 features.require("color");
1876 features.require("pagecolor");
1879 // only output when the font color is not default
1880 if (isfontcolor == true) {
1881 // only require color here, the font color will be defined
1882 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1884 features.require("color");
1885 features.require("fontcolor");
1888 // Only if class has a ToC hierarchy
1889 if (tclass.hasTocLevels()) {
1890 if (secnumdepth != tclass.secnumdepth()) {
1891 os << "\\setcounter{secnumdepth}{"
1895 if (tocdepth != tclass.tocdepth()) {
1896 os << "\\setcounter{tocdepth}{"
1902 if (paragraph_separation) {
1903 // when skip separation
1904 switch (getDefSkip().kind()) {
1905 case VSpace::SMALLSKIP:
1906 os << "\\setlength{\\parskip}{\\smallskipamount}\n";
1908 case VSpace::MEDSKIP:
1909 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1911 case VSpace::BIGSKIP:
1912 os << "\\setlength{\\parskip}{\\bigskipamount}\n";
1914 case VSpace::LENGTH:
1915 os << "\\setlength{\\parskip}{"
1916 << from_utf8(getDefSkip().length().asLatexString())
1919 default: // should never happen // Then delete it.
1920 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1923 os << "\\setlength{\\parindent}{0pt}\n";
1925 // when separation by indentation
1926 // only output something when a width is given
1927 if (getIndentation().asLyXCommand() != "default") {
1928 os << "\\setlength{\\parindent}{"
1929 << from_utf8(getIndentation().asLatexCommand())
1934 // Now insert the LyX specific LaTeX commands...
1935 features.resolveAlternatives();
1936 features.expandMultiples();
1939 if (!output_sync_macro.empty())
1940 os << from_utf8(output_sync_macro) +"\n";
1941 else if (features.runparams().flavor == OutputParams::LATEX)
1942 os << "\\usepackage[active]{srcltx}\n";
1943 else if (features.runparams().flavor == OutputParams::PDFLATEX)
1944 os << "\\synctex=-1\n";
1947 // The package options (via \PassOptionsToPackage)
1948 os << from_ascii(features.getPackageOptions());
1950 // due to interferences with babel and hyperref, the color package has to
1951 // be loaded (when it is not already loaded) before babel when hyperref
1952 // is used with the colorlinks option, see
1953 // http://www.lyx.org/trac/ticket/5291
1954 // we decided therefore to load color always before babel, see
1955 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
1956 os << from_ascii(features.getColorOptions());
1958 // If we use hyperref, jurabib, japanese, varioref or vietnamese,
1959 // we have to call babel before
1961 && (features.isRequired("jurabib")
1962 || features.isRequired("hyperref")
1963 || features.isRequired("varioref")
1964 || features.isRequired("vietnamese")
1965 || features.isRequired("japanese"))) {
1966 os << features.getBabelPresettings();
1968 os << from_utf8(babelCall(language_options.str(),
1969 features.needBabelLangOptions())) + '\n';
1970 os << features.getBabelPostsettings();
1973 // The optional packages;
1974 os << from_ascii(features.getPackages());
1976 // Additional Indices
1977 if (features.isRequired("splitidx")) {
1978 IndicesList::const_iterator iit = indiceslist().begin();
1979 IndicesList::const_iterator iend = indiceslist().end();
1980 for (; iit != iend; ++iit) {
1981 os << "\\newindex{";
1982 os << escape(iit->shortcut());
1988 os << from_utf8(spacing().writePreamble(features.isProvided("SetSpace")));
1991 // * Hyperref manual: "Make sure it comes last of your loaded
1992 // packages, to give it a fighting chance of not being over-written,
1993 // since its job is to redefine many LaTeX commands."
1994 // * Email from Heiko Oberdiek: "It is usually better to load babel
1995 // before hyperref. Then hyperref has a chance to detect babel.
1996 // * Has to be loaded before the "LyX specific LaTeX commands" to
1997 // avoid errors with algorithm floats.
1998 // use hyperref explicitly if it is required
1999 if (features.isRequired("hyperref")) {
2000 OutputParams tmp_params = features.runparams();
2001 pdfoptions().writeLaTeX(tmp_params, os,
2002 features.isProvided("hyperref"));
2003 // correctly break URLs with hyperref and dvi output
2004 if (features.runparams().flavor == OutputParams::LATEX
2005 && features.isAvailable("breakurl"))
2006 os << "\\usepackage{breakurl}\n";
2007 } else if (features.isRequired("nameref"))
2008 // hyperref loads this automatically
2009 os << "\\usepackage{nameref}\n";
2011 // bibtopic needs to be loaded after hyperref.
2012 // the dot provides the aux file naming which LyX can detect.
2013 if (features.mustProvide("bibtopic"))
2014 os << "\\usepackage[dot]{bibtopic}\n";
2016 // Will be surrounded by \makeatletter and \makeatother when not empty
2017 otexstringstream atlyxpreamble;
2019 // Some macros LyX will need
2021 TexString tmppreamble = features.getMacros();
2022 if (!tmppreamble.str.empty())
2023 atlyxpreamble << "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2024 "LyX specific LaTeX commands.\n"
2025 << move(tmppreamble)
2028 // the text class specific preamble
2030 docstring tmppreamble = features.getTClassPreamble();
2031 if (!tmppreamble.empty())
2032 atlyxpreamble << "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2033 "Textclass specific LaTeX commands.\n"
2037 // suppress date if selected
2038 // use \@ifundefined because we cannot be sure that every document class
2039 // has a \date command
2041 atlyxpreamble << "\\@ifundefined{date}{}{\\date{}}\n";
2043 /* the user-defined preamble */
2044 if (!containsOnly(preamble, " \n\t")) {
2046 atlyxpreamble << "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2047 "User specified LaTeX commands.\n";
2049 // Check if the user preamble contains uncodable glyphs
2050 odocstringstream user_preamble;
2051 docstring uncodable_glyphs;
2052 Encoding const * const enc = features.runparams().encoding;
2054 for (size_t n = 0; n < preamble.size(); ++n) {
2055 char_type c = preamble[n];
2056 if (!enc->encodable(c)) {
2057 docstring const glyph(1, c);
2058 LYXERR0("Uncodable character '"
2060 << "' in user preamble!");
2061 uncodable_glyphs += glyph;
2062 if (features.runparams().dryrun) {
2063 user_preamble << "<" << _("LyX Warning: ")
2064 << _("uncodable character") << " '";
2065 user_preamble.put(c);
2066 user_preamble << "'>";
2069 user_preamble.put(c);
2072 user_preamble << preamble;
2074 // On BUFFER_VIEW|UPDATE, warn user if we found uncodable glyphs
2075 if (!features.runparams().dryrun && !uncodable_glyphs.empty()) {
2076 frontend::Alert::warning(
2077 _("Uncodable character in user preamble"),
2079 _("The user preamble of your document contains glyphs "
2080 "that are unknown in the current document encoding "
2081 "(namely %1$s).\nThese glyphs are omitted "
2082 " from the output, which may result in "
2083 "incomplete output."
2084 "\n\nPlease select an appropriate "
2085 "document encoding\n"
2086 "(such as utf8) or change the "
2087 "preamble code accordingly."),
2090 atlyxpreamble << user_preamble.str() << '\n';
2093 // footmisc must be loaded after setspace
2094 // Load it here to avoid clashes with footmisc loaded in the user
2095 // preamble. For that reason we also pass the options via
2096 // \PassOptionsToPackage in getPreamble() and not here.
2097 if (features.mustProvide("footmisc"))
2098 atlyxpreamble << "\\usepackage{footmisc}\n";
2100 // subfig loads internally the LaTeX package "caption". As
2101 // caption is a very popular package, users will load it in
2102 // the preamble. Therefore we must load subfig behind the
2103 // user-defined preamble and check if the caption package was
2104 // loaded or not. For the case that caption is loaded before
2105 // subfig, there is the subfig option "caption=false". This
2106 // option also works when a koma-script class is used and
2107 // koma's own caption commands are used instead of caption. We
2108 // use \PassOptionsToPackage here because the user could have
2109 // already loaded subfig in the preamble.
2110 if (features.mustProvide("subfig"))
2111 atlyxpreamble << "\\@ifundefined{showcaptionsetup}{}{%\n"
2112 " \\PassOptionsToPackage{caption=false}{subfig}}\n"
2113 "\\usepackage{subfig}\n";
2115 // Itemize bullet settings need to be last in case the user
2116 // defines their own bullets that use a package included
2117 // in the user-defined preamble -- ARRae
2118 // Actually it has to be done much later than that
2119 // since some packages like frenchb make modifications
2120 // at \begin{document} time -- JMarc
2121 docstring bullets_def;
2122 for (int i = 0; i < 4; ++i) {
2123 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
2124 if (bullets_def.empty())
2125 bullets_def += "\\AtBeginDocument{\n";
2126 bullets_def += " \\def\\labelitemi";
2128 // `i' is one less than the item to modify
2135 bullets_def += "ii";
2141 bullets_def += '{' +
2142 user_defined_bullet(i).getText()
2147 if (!bullets_def.empty())
2148 atlyxpreamble << bullets_def << "}\n\n";
2150 if (!atlyxpreamble.empty())
2151 os << "\n\\makeatletter\n"
2152 << atlyxpreamble.release()
2153 << "\\makeatother\n\n";
2155 // We try to load babel late, in case it interferes with other packages.
2156 // Jurabib, hyperref, varioref, bicaption and listings (bug 8995) have to be
2157 // called after babel, though.
2158 if (use_babel && !features.isRequired("jurabib")
2159 && !features.isRequired("hyperref")
2160 && !features.isRequired("varioref")
2161 && !features.isRequired("vietnamese")
2162 && !features.isRequired("japanese")) {
2163 os << features.getBabelPresettings();
2165 os << from_utf8(babelCall(language_options.str(),
2166 features.needBabelLangOptions())) + '\n';
2167 os << features.getBabelPostsettings();
2169 if (features.isRequired("bicaption"))
2170 os << "\\usepackage{bicaption}\n";
2171 if (!listings_params.empty() || features.mustProvide("listings"))
2172 os << "\\usepackage{listings}\n";
2173 if (!listings_params.empty()) {
2175 // do not test validity because listings_params is
2176 // supposed to be valid
2178 InsetListingsParams(listings_params).separatedParams(true);
2179 os << from_utf8(par);
2183 // xunicode only needs to be loaded if tipa is used
2184 // (the rest is obsoleted by the new TU encoding).
2185 // It needs to be loaded at least after amsmath, amssymb,
2186 // esint and the other packages that provide special glyphs
2187 if (features.mustProvide("tipa") && useNonTeXFonts) {
2188 // The package officially only supports XeTeX, but also works
2189 // with LuaTeX. Thus we work around its XeTeX test.
2190 if (features.runparams().flavor != OutputParams::XETEX) {
2191 os << "% Pretend to xunicode that we are XeTeX\n"
2192 << "\\def\\XeTeXpicfile{}\n";
2194 os << "\\usepackage{xunicode}\n";
2197 // Polyglossia must be loaded last ...
2198 if (use_polyglossia) {
2200 os << "\\usepackage{polyglossia}\n";
2201 // set the main language
2202 os << "\\setdefaultlanguage";
2203 if (!language->polyglossiaOpts().empty())
2204 os << "[" << from_ascii(language->polyglossiaOpts()) << "]";
2205 os << "{" << from_ascii(language->polyglossia()) << "}\n";
2206 // now setup the other languages
2207 set<string> const polylangs =
2208 features.getPolyglossiaLanguages();
2209 for (set<string>::const_iterator mit = polylangs.begin();
2210 mit != polylangs.end() ; ++mit) {
2211 // We do not output the options here; they are output in
2212 // the language switch commands. This is safer if multiple
2213 // varieties are used.
2214 if (*mit == language->polyglossia())
2216 os << "\\setotherlanguage";
2217 os << "{" << from_ascii(*mit) << "}\n";
2221 // ... but before biblatex (see #7065)
2222 if (features.mustProvide("biblatex")) {
2225 os << "\\usepackage";
2226 if (!biblatex_bibstyle.empty()
2227 && (biblatex_bibstyle == biblatex_citestyle)) {
2228 opts = "style=" + biblatex_bibstyle;
2231 if (!biblatex_bibstyle.empty()) {
2232 opts = "bibstyle=" + biblatex_bibstyle;
2235 if (!biblatex_citestyle.empty()) {
2236 opts += delim + "citestyle=" + biblatex_citestyle;
2240 if (!multibib.empty() && multibib != "child") {
2241 opts += delim + "refsection=" + multibib;
2244 if (bibtexCommand() == "bibtex8"
2245 || prefixIs(bibtexCommand(), "bibtex8 ")) {
2246 opts += delim + "backend=bibtex8";
2248 } else if (bibtexCommand() == "bibtex"
2249 || prefixIs(bibtexCommand(), "bibtex ")) {
2250 opts += delim + "backend=bibtex";
2253 if (!biblio_opts.empty())
2254 opts += delim + biblio_opts;
2256 os << "[" << opts << "]";
2257 os << "{biblatex}\n";
2261 // Load custom language package here
2262 if (features.langPackage() == LaTeXFeatures::LANG_PACK_CUSTOM) {
2263 if (lang_package == "default")
2264 os << from_utf8(lyxrc.language_custom_package);
2266 os << from_utf8(lang_package);
2270 docstring const i18npreamble =
2271 features.getTClassI18nPreamble(use_babel, use_polyglossia);
2272 if (!i18npreamble.empty())
2273 os << i18npreamble + '\n';
2279 void BufferParams::useClassDefaults()
2281 DocumentClass const & tclass = documentClass();
2283 sides = tclass.sides();
2284 columns = tclass.columns();
2285 pagestyle = tclass.pagestyle();
2286 use_default_options = true;
2287 // Only if class has a ToC hierarchy
2288 if (tclass.hasTocLevels()) {
2289 secnumdepth = tclass.secnumdepth();
2290 tocdepth = tclass.tocdepth();
2295 bool BufferParams::hasClassDefaults() const
2297 DocumentClass const & tclass = documentClass();
2299 return sides == tclass.sides()
2300 && columns == tclass.columns()
2301 && pagestyle == tclass.pagestyle()
2302 && use_default_options
2303 && secnumdepth == tclass.secnumdepth()
2304 && tocdepth == tclass.tocdepth();
2308 DocumentClass const & BufferParams::documentClass() const
2314 DocumentClassConstPtr BufferParams::documentClassPtr() const
2320 void BufferParams::setDocumentClass(DocumentClassConstPtr tc)
2322 // evil, but this function is evil
2323 doc_class_ = const_pointer_cast<DocumentClass>(tc);
2324 invalidateConverterCache();
2328 bool BufferParams::setBaseClass(string const & classname)
2330 LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
2331 LayoutFileList & bcl = LayoutFileList::get();
2332 if (!bcl.haveClass(classname)) {
2334 bformat(_("The layout file:\n"
2336 "could not be found. A default textclass with default\n"
2337 "layouts will be used. LyX will not be able to produce\n"
2339 from_utf8(classname));
2340 frontend::Alert::error(_("Document class not found"), s);
2341 bcl.addEmptyClass(classname);
2344 bool const success = bcl[classname].load();
2347 bformat(_("Due to some error in it, the layout file:\n"
2349 "could not be loaded. A default textclass with default\n"
2350 "layouts will be used. LyX will not be able to produce\n"
2352 from_utf8(classname));
2353 frontend::Alert::error(_("Could not load class"), s);
2354 bcl.addEmptyClass(classname);
2357 pimpl_->baseClass_ = classname;
2358 layout_modules_.adaptToBaseClass(baseClass(), removed_modules_);
2363 LayoutFile const * BufferParams::baseClass() const
2365 if (LayoutFileList::get().haveClass(pimpl_->baseClass_))
2366 return &(LayoutFileList::get()[pimpl_->baseClass_]);
2372 LayoutFileIndex const & BufferParams::baseClassID() const
2374 return pimpl_->baseClass_;
2378 void BufferParams::makeDocumentClass(bool const clone)
2383 invalidateConverterCache();
2384 LayoutModuleList mods;
2385 LayoutModuleList ces;
2386 LayoutModuleList::iterator it = layout_modules_.begin();
2387 LayoutModuleList::iterator en = layout_modules_.end();
2388 for (; it != en; ++it)
2389 mods.push_back(*it);
2391 it = cite_engine_.begin();
2392 en = cite_engine_.end();
2393 for (; it != en; ++it)
2396 doc_class_ = getDocumentClass(*baseClass(), mods, ces, clone);
2398 TextClass::ReturnValues success = TextClass::OK;
2399 if (!forced_local_layout_.empty())
2400 success = doc_class_->read(to_utf8(forced_local_layout_),
2402 if (!local_layout_.empty() &&
2403 (success == TextClass::OK || success == TextClass::OK_OLDFORMAT))
2404 success = doc_class_->read(to_utf8(local_layout_), TextClass::MODULE);
2405 if (success != TextClass::OK && success != TextClass::OK_OLDFORMAT) {
2406 docstring const msg = _("Error reading internal layout information");
2407 frontend::Alert::warning(_("Read Error"), msg);
2412 bool BufferParams::layoutModuleCanBeAdded(string const & modName) const
2414 return layout_modules_.moduleCanBeAdded(modName, baseClass());
2418 bool BufferParams::citationModuleCanBeAdded(string const & modName) const
2420 return cite_engine_.moduleCanBeAdded(modName, baseClass());
2424 docstring BufferParams::getLocalLayout(bool forced) const
2427 return from_utf8(doc_class_->forcedLayouts());
2429 return local_layout_;
2433 void BufferParams::setLocalLayout(docstring const & layout, bool forced)
2436 forced_local_layout_ = layout;
2438 local_layout_ = layout;
2442 bool BufferParams::addLayoutModule(string const & modName)
2444 LayoutModuleList::const_iterator it = layout_modules_.begin();
2445 LayoutModuleList::const_iterator end = layout_modules_.end();
2446 for (; it != end; ++it)
2449 layout_modules_.push_back(modName);
2454 string BufferParams::bufferFormat() const
2456 return documentClass().outputFormat();
2460 bool BufferParams::isExportable(string const & format, bool need_viewable) const
2462 FormatList const & formats = exportableFormats(need_viewable);
2463 FormatList::const_iterator fit = formats.begin();
2464 FormatList::const_iterator end = formats.end();
2465 for (; fit != end ; ++fit) {
2466 if ((*fit)->name() == format)
2473 FormatList const & BufferParams::exportableFormats(bool only_viewable) const
2475 FormatList & cached = only_viewable ?
2476 pimpl_->viewableFormatList : pimpl_->exportableFormatList;
2477 bool & valid = only_viewable ?
2478 pimpl_->isViewCacheValid : pimpl_->isExportCacheValid;
2482 vector<string> const backs = backends();
2483 set<string> excludes;
2484 if (useNonTeXFonts) {
2485 excludes.insert("latex");
2486 excludes.insert("pdflatex");
2489 theConverters().getReachable(backs[0], only_viewable, true, excludes);
2490 for (vector<string>::const_iterator it = backs.begin() + 1;
2491 it != backs.end(); ++it) {
2492 FormatList r = theConverters().getReachable(*it, only_viewable,
2494 result.insert(result.end(), r.begin(), r.end());
2496 sort(result.begin(), result.end(), Format::formatSorter);
2503 vector<string> BufferParams::backends() const
2506 string const buffmt = bufferFormat();
2508 // FIXME: Don't hardcode format names here, but use a flag
2509 if (buffmt == "latex") {
2510 if (encoding().package() == Encoding::japanese)
2511 v.push_back("platex");
2513 if (!useNonTeXFonts) {
2514 v.push_back("pdflatex");
2515 v.push_back("latex");
2517 v.push_back("xetex");
2518 v.push_back("luatex");
2519 v.push_back("dviluatex");
2522 v.push_back(buffmt);
2524 v.push_back("xhtml");
2525 v.push_back("text");
2531 OutputParams::FLAVOR BufferParams::getOutputFlavor(string const & format) const
2533 string const dformat = (format.empty() || format == "default") ?
2534 getDefaultOutputFormat() : format;
2535 DefaultFlavorCache::const_iterator it =
2536 default_flavors_.find(dformat);
2538 if (it != default_flavors_.end())
2541 OutputParams::FLAVOR result = OutputParams::LATEX;
2543 // FIXME It'd be better not to hardcode this, but to do
2544 // something with formats.
2545 if (dformat == "xhtml")
2546 result = OutputParams::HTML;
2547 else if (dformat == "text")
2548 result = OutputParams::TEXT;
2549 else if (dformat == "lyx")
2550 result = OutputParams::LYX;
2551 else if (dformat == "pdflatex")
2552 result = OutputParams::PDFLATEX;
2553 else if (dformat == "xetex")
2554 result = OutputParams::XETEX;
2555 else if (dformat == "luatex")
2556 result = OutputParams::LUATEX;
2557 else if (dformat == "dviluatex")
2558 result = OutputParams::DVILUATEX;
2560 // Try to determine flavor of default output format
2561 vector<string> backs = backends();
2562 if (find(backs.begin(), backs.end(), dformat) == backs.end()) {
2563 // Get shortest path to format
2564 Graph::EdgePath path;
2565 for (vector<string>::const_iterator it = backs.begin();
2566 it != backs.end(); ++it) {
2567 Graph::EdgePath p = theConverters().getPath(*it, dformat);
2568 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2573 result = theConverters().getFlavor(path);
2576 // cache this flavor
2577 default_flavors_[dformat] = result;
2582 string BufferParams::getDefaultOutputFormat() const
2584 if (!default_output_format.empty()
2585 && default_output_format != "default")
2586 return default_output_format;
2588 || encoding().package() == Encoding::japanese) {
2589 FormatList const & formats = exportableFormats(true);
2590 if (formats.empty())
2592 // return the first we find
2593 return formats.front()->name();
2596 return lyxrc.default_otf_view_format;
2597 return lyxrc.default_view_format;
2600 Font const BufferParams::getFont() const
2602 FontInfo f = documentClass().defaultfont();
2603 if (fonts_default_family == "rmdefault")
2604 f.setFamily(ROMAN_FAMILY);
2605 else if (fonts_default_family == "sfdefault")
2606 f.setFamily(SANS_FAMILY);
2607 else if (fonts_default_family == "ttdefault")
2608 f.setFamily(TYPEWRITER_FAMILY);
2609 return Font(f, language);
2613 InsetQuotesParams::QuoteStyle BufferParams::getQuoteStyle(string const & qs) const
2615 return quotesstyletranslator().find(qs);
2619 bool BufferParams::isLatex() const
2621 return documentClass().outputType() == LATEX;
2625 bool BufferParams::isLiterate() const
2627 return documentClass().outputType() == LITERATE;
2631 bool BufferParams::isDocBook() const
2633 return documentClass().outputType() == DOCBOOK;
2637 void BufferParams::readPreamble(Lexer & lex)
2639 if (lex.getString() != "\\begin_preamble")
2640 lyxerr << "Error (BufferParams::readPreamble):"
2641 "consistency check failed." << endl;
2643 preamble = lex.getLongString(from_ascii("\\end_preamble"));
2647 void BufferParams::readLocalLayout(Lexer & lex, bool forced)
2649 string const expected = forced ? "\\begin_forced_local_layout" :
2650 "\\begin_local_layout";
2651 if (lex.getString() != expected)
2652 lyxerr << "Error (BufferParams::readLocalLayout):"
2653 "consistency check failed." << endl;
2656 forced_local_layout_ =
2657 lex.getLongString(from_ascii("\\end_forced_local_layout"));
2659 local_layout_ = lex.getLongString(from_ascii("\\end_local_layout"));
2663 bool BufferParams::setLanguage(string const & lang)
2665 Language const *new_language = languages.getLanguage(lang);
2666 if (!new_language) {
2667 // Language lang was not found
2670 language = new_language;
2675 void BufferParams::readLanguage(Lexer & lex)
2677 if (!lex.next()) return;
2679 string const tmptok = lex.getString();
2681 // check if tmptok is part of tex_babel in tex-defs.h
2682 if (!setLanguage(tmptok)) {
2683 // Language tmptok was not found
2684 language = default_language;
2685 lyxerr << "Warning: Setting language `"
2686 << tmptok << "' to `" << language->lang()
2692 void BufferParams::readGraphicsDriver(Lexer & lex)
2697 string const tmptok = lex.getString();
2698 // check if tmptok is part of tex_graphics in tex_defs.h
2701 string const test = tex_graphics[n++];
2703 if (test == tmptok) {
2704 graphics_driver = tmptok;
2709 "Warning: graphics driver `$$Token' not recognized!\n"
2710 " Setting graphics driver to `default'.\n");
2711 graphics_driver = "default";
2718 void BufferParams::readBullets(Lexer & lex)
2723 int const index = lex.getInteger();
2725 int temp_int = lex.getInteger();
2726 user_defined_bullet(index).setFont(temp_int);
2727 temp_bullet(index).setFont(temp_int);
2729 user_defined_bullet(index).setCharacter(temp_int);
2730 temp_bullet(index).setCharacter(temp_int);
2732 user_defined_bullet(index).setSize(temp_int);
2733 temp_bullet(index).setSize(temp_int);
2737 void BufferParams::readBulletsLaTeX(Lexer & lex)
2739 // The bullet class should be able to read this.
2742 int const index = lex.getInteger();
2744 docstring const temp_str = lex.getDocString();
2746 user_defined_bullet(index).setText(temp_str);
2747 temp_bullet(index).setText(temp_str);
2751 void BufferParams::readModules(Lexer & lex)
2753 if (!lex.eatLine()) {
2754 lyxerr << "Error (BufferParams::readModules):"
2755 "Unexpected end of input." << endl;
2759 string mod = lex.getString();
2760 if (mod == "\\end_modules")
2762 addLayoutModule(mod);
2768 void BufferParams::readRemovedModules(Lexer & lex)
2770 if (!lex.eatLine()) {
2771 lyxerr << "Error (BufferParams::readRemovedModules):"
2772 "Unexpected end of input." << endl;
2776 string mod = lex.getString();
2777 if (mod == "\\end_removed_modules")
2779 removed_modules_.push_back(mod);
2782 // now we want to remove any removed modules that were previously
2783 // added. normally, that will be because default modules were added in
2784 // setBaseClass(), which gets called when \textclass is read at the
2785 // start of the read.
2786 list<string>::const_iterator rit = removed_modules_.begin();
2787 list<string>::const_iterator const ren = removed_modules_.end();
2788 for (; rit != ren; ++rit) {
2789 LayoutModuleList::iterator const mit = layout_modules_.begin();
2790 LayoutModuleList::iterator const men = layout_modules_.end();
2791 LayoutModuleList::iterator found = find(mit, men, *rit);
2794 layout_modules_.erase(found);
2799 void BufferParams::readIncludeonly(Lexer & lex)
2801 if (!lex.eatLine()) {
2802 lyxerr << "Error (BufferParams::readIncludeonly):"
2803 "Unexpected end of input." << endl;
2807 string child = lex.getString();
2808 if (child == "\\end_includeonly")
2810 included_children_.push_back(child);
2816 string BufferParams::paperSizeName(PapersizePurpose purpose) const
2818 switch (papersize) {
2820 // could be anything, so don't guess
2822 case PAPER_CUSTOM: {
2823 if (purpose == XDVI && !paperwidth.empty() &&
2824 !paperheight.empty()) {
2825 // heightxwidth<unit>
2826 string first = paperwidth;
2827 string second = paperheight;
2828 if (orientation == ORIENTATION_LANDSCAPE)
2831 return first.erase(first.length() - 2)
2837 // dvips and dvipdfm do not know this
2838 if (purpose == DVIPS || purpose == DVIPDFM)
2842 if (purpose == DVIPS || purpose == DVIPDFM)
2846 if (purpose == DVIPS || purpose == DVIPDFM)
2856 if (purpose == DVIPS || purpose == DVIPDFM)
2860 if (purpose == DVIPS || purpose == DVIPDFM)
2864 if (purpose == DVIPS || purpose == DVIPDFM)
2868 if (purpose == DVIPS || purpose == DVIPDFM)
2872 if (purpose == DVIPS || purpose == DVIPDFM)
2876 // dvipdfm does not know this
2877 if (purpose == DVIPDFM)
2881 if (purpose == DVIPDFM)
2885 if (purpose == DVIPS || purpose == DVIPDFM)
2889 if (purpose == DVIPS || purpose == DVIPDFM)
2893 if (purpose == DVIPS || purpose == DVIPDFM)
2897 if (purpose == DVIPS || purpose == DVIPDFM)
2901 if (purpose == DVIPS || purpose == DVIPDFM)
2905 if (purpose == DVIPS || purpose == DVIPDFM)
2909 if (purpose == DVIPS || purpose == DVIPDFM)
2913 if (purpose == DVIPS || purpose == DVIPDFM)
2917 if (purpose == DVIPS || purpose == DVIPDFM)
2921 if (purpose == DVIPS || purpose == DVIPDFM)
2925 if (purpose == DVIPS || purpose == DVIPDFM)
2929 if (purpose == DVIPS || purpose == DVIPDFM)
2933 if (purpose == DVIPS || purpose == DVIPDFM)
2937 if (purpose == DVIPS || purpose == DVIPDFM)
2941 if (purpose == DVIPS || purpose == DVIPDFM)
2944 case PAPER_USEXECUTIVE:
2945 // dvipdfm does not know this
2946 if (purpose == DVIPDFM)
2951 case PAPER_USLETTER:
2953 if (purpose == XDVI)
2960 string const BufferParams::dvips_options() const
2964 // If the class loads the geometry package, we do not know which
2965 // paper size is used, since we do not set it (bug 7013).
2966 // Therefore we must not specify any argument here.
2967 // dvips gets the correct paper size via DVI specials in this case
2968 // (if the class uses the geometry package correctly).
2969 if (documentClass().provides("geometry"))
2973 && papersize == PAPER_CUSTOM
2974 && !lyxrc.print_paper_dimension_flag.empty()
2975 && !paperwidth.empty()
2976 && !paperheight.empty()) {
2977 // using a custom papersize
2978 result = lyxrc.print_paper_dimension_flag;
2979 result += ' ' + paperwidth;
2980 result += ',' + paperheight;
2982 string const paper_option = paperSizeName(DVIPS);
2983 if (!paper_option.empty() && (paper_option != "letter" ||
2984 orientation != ORIENTATION_LANDSCAPE)) {
2985 // dvips won't accept -t letter -t landscape.
2986 // In all other cases, include the paper size
2988 result = lyxrc.print_paper_flag;
2989 result += ' ' + paper_option;
2992 if (orientation == ORIENTATION_LANDSCAPE &&
2993 papersize != PAPER_CUSTOM)
2994 result += ' ' + lyxrc.print_landscape_flag;
2999 string const BufferParams::main_font_encoding() const
3001 return font_encodings().empty() ? "default" : font_encodings().back();
3005 vector<string> const BufferParams::font_encodings() const
3007 string doc_fontenc = (fontenc == "global") ? lyxrc.fontenc : fontenc;
3009 vector<string> fontencs;
3011 // "default" means "no explicit font encoding"
3012 if (doc_fontenc != "default") {
3013 fontencs = getVectorFromString(doc_fontenc);
3014 if (!language->fontenc().empty()
3015 && ascii_lowercase(language->fontenc()) != "none") {
3016 vector<string> fencs = getVectorFromString(language->fontenc());
3017 vector<string>::const_iterator fit = fencs.begin();
3018 for (; fit != fencs.end(); ++fit) {
3019 if (find(fontencs.begin(), fontencs.end(), *fit) == fontencs.end())
3020 fontencs.push_back(*fit);
3029 string BufferParams::babelCall(string const & lang_opts, bool const langoptions) const
3031 // suppress the babel call if there is no BabelName defined
3032 // for the document language in the lib/languages file and if no
3033 // other languages are used (lang_opts is then empty)
3034 if (lang_opts.empty())
3036 // either a specific language (AsBabelOptions setting in
3037 // lib/languages) or the prefs require the languages to
3038 // be submitted to babel itself (not the class).
3040 return "\\usepackage[" + lang_opts + "]{babel}";
3041 return "\\usepackage{babel}";
3045 docstring BufferParams::getGraphicsDriver(string const & package) const
3049 if (package == "geometry") {
3050 if (graphics_driver == "dvips"
3051 || graphics_driver == "dvipdfm"
3052 || graphics_driver == "pdftex"
3053 || graphics_driver == "vtex")
3054 result = from_ascii(graphics_driver);
3055 else if (graphics_driver == "dvipdfmx")
3056 result = from_ascii("dvipdfm");
3063 void BufferParams::writeEncodingPreamble(otexstream & os,
3064 LaTeXFeatures & features) const
3066 // XeTeX/LuaTeX: (see also #9740)
3067 // With Unicode fonts we use utf8-plain without encoding package.
3068 // With TeX fonts, we cannot use utf8-plain, but "inputenc" fails.
3069 // XeTeX must use ASCII encoding (see Buffer.cpp),
3070 // for LuaTeX, we load "luainputenc" (see below).
3071 if (useNonTeXFonts || features.runparams().flavor == OutputParams::XETEX)
3074 if (inputenc == "auto") {
3075 string const doc_encoding =
3076 language->encoding()->latexName();
3077 Encoding::Package const package =
3078 language->encoding()->package();
3080 // Create list of inputenc options:
3081 set<string> encodings;
3082 // luainputenc fails with more than one encoding
3083 if (!features.runparams().isFullUnicode()) // if we reach this point, this means LuaTeX with TeX fonts
3084 // list all input encodings used in the document
3085 encodings = features.getEncodingSet(doc_encoding);
3087 // If the "japanese" package (i.e. pLaTeX) is used,
3088 // inputenc must be omitted.
3089 // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
3090 if ((!encodings.empty() || package == Encoding::inputenc)
3091 && !features.isRequired("japanese")
3092 && !features.isProvided("inputenc")) {
3093 os << "\\usepackage[";
3094 set<string>::const_iterator it = encodings.begin();
3095 set<string>::const_iterator const end = encodings.end();
3097 os << from_ascii(*it);
3100 for (; it != end; ++it)
3101 os << ',' << from_ascii(*it);
3102 if (package == Encoding::inputenc) {
3103 if (!encodings.empty())
3105 os << from_ascii(doc_encoding);
3107 if (features.runparams().flavor == OutputParams::LUATEX
3108 || features.runparams().flavor == OutputParams::DVILUATEX)
3109 os << "]{luainputenc}\n";
3111 os << "]{inputenc}\n";
3113 if (package == Encoding::CJK || features.mustProvide("CJK")) {
3114 if (language->encoding()->name() == "utf8-cjk"
3115 && LaTeXFeatures::isAvailable("CJKutf8"))
3116 os << "\\usepackage{CJKutf8}\n";
3118 os << "\\usepackage{CJK}\n";
3120 } else if (inputenc != "default") {
3121 switch (encoding().package()) {
3122 case Encoding::none:
3123 case Encoding::japanese:
3125 case Encoding::inputenc:
3126 // do not load inputenc if japanese is used
3127 // or if the class provides inputenc
3128 if (features.isRequired("japanese")
3129 || features.isProvided("inputenc"))
3131 os << "\\usepackage[" << from_ascii(encoding().latexName());
3132 if (features.runparams().flavor == OutputParams::LUATEX
3133 || features.runparams().flavor == OutputParams::DVILUATEX)
3134 os << "]{luainputenc}\n";
3136 os << "]{inputenc}\n";
3139 if (encoding().name() == "utf8-cjk"
3140 && LaTeXFeatures::isAvailable("CJKutf8"))
3141 os << "\\usepackage{CJKutf8}\n";
3143 os << "\\usepackage{CJK}\n";
3146 // Load the CJK package if needed by a secondary language.
3147 // If the main encoding is some variant of UTF8, use CJKutf8.
3148 if (encoding().package() != Encoding::CJK && features.mustProvide("CJK")) {
3149 if (encoding().iconvName() == "UTF-8"
3150 && LaTeXFeatures::isAvailable("CJKutf8"))
3151 os << "\\usepackage{CJKutf8}\n";
3153 os << "\\usepackage{CJK}\n";
3159 string const BufferParams::parseFontName(string const & name) const
3161 string mangled = name;
3162 size_t const idx = mangled.find('[');
3163 if (idx == string::npos || idx == 0)
3166 return mangled.substr(0, idx - 1);
3170 string const BufferParams::loadFonts(LaTeXFeatures & features) const
3172 if (fontsRoman() == "default" && fontsSans() == "default"
3173 && fontsTypewriter() == "default"
3174 && (fontsMath() == "default" || fontsMath() == "auto"))
3180 /* Fontspec (XeTeX, LuaTeX): we provide GUI support for oldstyle
3181 * numbers (Numbers=OldStyle) and sf/tt scaling. The Ligatures=TeX/
3182 * Mapping=tex-text option assures TeX ligatures (such as "--")
3183 * are resolved. Note that tt does not use these ligatures.
3185 * -- add more GUI options?
3186 * -- add more fonts (fonts for other scripts)
3187 * -- if there's a way to find out if a font really supports
3188 * OldStyle, enable/disable the widget accordingly.
3190 if (useNonTeXFonts && features.isAvailable("fontspec")) {
3191 // "Mapping=tex-text" and "Ligatures=TeX" are equivalent.
3192 // However, until v.2 (2010/07/11) fontspec only knew
3193 // Mapping=tex-text (for XeTeX only); then "Ligatures=TeX"
3194 // was introduced for both XeTeX and LuaTeX (LuaTeX
3195 // didn't understand "Mapping=tex-text", while XeTeX
3196 // understood both. With most recent versions, both
3197 // variants are understood by both engines. However,
3198 // we want to provide support for at least TeXLive 2009
3199 // (for XeTeX; LuaTeX is only supported as of v.2)
3200 string const texmapping =
3201 (features.runparams().flavor == OutputParams::XETEX) ?
3202 "Mapping=tex-text" : "Ligatures=TeX";
3203 if (fontsRoman() != "default") {
3204 os << "\\setmainfont[" << texmapping;
3205 if (fonts_old_figures)
3206 os << ",Numbers=OldStyle";
3207 os << "]{" << parseFontName(fontsRoman()) << "}\n";
3209 if (fontsSans() != "default") {
3210 string const sans = parseFontName(fontsSans());
3211 if (fontsSansScale() != 100)
3212 os << "\\setsansfont[Scale="
3213 << float(fontsSansScale()) / 100
3214 << "," << texmapping << "]{"
3217 os << "\\setsansfont[" << texmapping << "]{"
3220 if (fontsTypewriter() != "default") {
3221 string const mono = parseFontName(fontsTypewriter());
3222 if (fontsTypewriterScale() != 100)
3223 os << "\\setmonofont[Scale="
3224 << float(fontsTypewriterScale()) / 100
3228 os << "\\setmonofont{"
3235 bool const ot1 = (main_font_encoding() == "default" || main_font_encoding() == "OT1");
3236 bool const dryrun = features.runparams().dryrun;
3237 bool const complete = (fontsSans() == "default" && fontsTypewriter() == "default");
3238 bool const nomath = (fontsMath() == "default");
3241 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsRoman())).getLaTeXCode(
3242 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3246 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsSans())).getLaTeXCode(
3247 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3248 nomath, fontsSansScale());
3250 // MONOSPACED/TYPEWRITER
3251 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsTypewriter())).getLaTeXCode(
3252 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3253 nomath, fontsTypewriterScale());
3256 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsMath())).getLaTeXCode(
3257 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3264 Encoding const & BufferParams::encoding() const
3266 // Main encoding for LaTeX output.
3268 // Exception: XeTeX with 8-bit TeX fonts requires ASCII (see #9740).
3269 // As the "flavor" is only known once export started, this
3270 // cannot be handled here. Instead, runparams.encoding is set
3271 // to ASCII in Buffer::makeLaTeXFile (for export)
3272 // and Buffer::writeLaTeXSource (for preview).
3274 return *(encodings.fromLyXName("utf8-plain"));
3275 if (inputenc == "auto" || inputenc == "default")
3276 return *language->encoding();
3277 Encoding const * const enc = encodings.fromLyXName(inputenc);
3280 LYXERR0("Unknown inputenc value `" << inputenc
3281 << "'. Using `auto' instead.");
3282 return *language->encoding();
3286 bool BufferParams::addCiteEngine(string const & engine)
3288 LayoutModuleList::const_iterator it = cite_engine_.begin();
3289 LayoutModuleList::const_iterator en = cite_engine_.end();
3290 for (; it != en; ++it)
3293 cite_engine_.push_back(engine);
3298 bool BufferParams::addCiteEngine(vector<string> const & engine)
3300 vector<string>::const_iterator it = engine.begin();
3301 vector<string>::const_iterator en = engine.end();
3303 for (; it != en; ++it)
3304 if (!addCiteEngine(*it))
3310 string const & BufferParams::defaultBiblioStyle() const
3312 map<string, string> const & bs = documentClass().defaultBiblioStyle();
3313 auto cit = bs.find(theCiteEnginesList.getTypeAsString(citeEngineType()));
3314 if (cit != bs.end())
3317 return empty_string();
3321 bool const & BufferParams::fullAuthorList() const
3323 return documentClass().fullAuthorList();
3327 string BufferParams::getCiteAlias(string const & s) const
3329 vector<string> commands =
3330 documentClass().citeCommands(citeEngineType());
3331 // If it is a real command, don't treat it as an alias
3332 if (find(commands.begin(), commands.end(), s) != commands.end())
3334 map<string,string> aliases = documentClass().citeCommandAliases();
3335 if (aliases.find(s) != aliases.end())
3341 void BufferParams::setCiteEngine(string const & engine)
3344 addCiteEngine(engine);
3348 void BufferParams::setCiteEngine(vector<string> const & engine)
3351 addCiteEngine(engine);
3355 vector<string> BufferParams::citeCommands() const
3357 static CitationStyle const default_style;
3358 vector<string> commands =
3359 documentClass().citeCommands(citeEngineType());
3360 if (commands.empty())
3361 commands.push_back(default_style.name);
3366 vector<CitationStyle> BufferParams::citeStyles() const
3368 static CitationStyle const default_style;
3369 vector<CitationStyle> styles =
3370 documentClass().citeStyles(citeEngineType());
3372 styles.push_back(default_style);
3377 string const BufferParams::bibtexCommand() const
3379 // Return document-specific setting if available
3380 if (bibtex_command != "default")
3381 return bibtex_command;
3383 // If we have "default" in document settings, consult the prefs
3384 // 1. Japanese (uses a specific processor)
3385 if (encoding().package() == Encoding::japanese) {
3386 if (lyxrc.jbibtex_command != "automatic")
3387 // Return the specified program, if "automatic" is not set
3388 return lyxrc.jbibtex_command;
3389 else if (!useBiblatex()) {
3390 // With classic BibTeX, return pbibtex, jbibtex, bibtex
3391 if (lyxrc.jbibtex_alternatives.find("pbibtex") != lyxrc.jbibtex_alternatives.end())
3393 if (lyxrc.jbibtex_alternatives.find("jbibtex") != lyxrc.jbibtex_alternatives.end())
3398 // 2. All other languages
3399 else if (lyxrc.bibtex_command != "automatic")
3400 // Return the specified program, if "automatic" is not set
3401 return lyxrc.bibtex_command;
3403 // 3. Automatic: find the most suitable for the current cite framework
3404 if (useBiblatex()) {
3405 // For Biblatex, we prefer biber (also for Japanese)
3406 // and fall back to bibtex8 and, as last resort, bibtex
3407 if (lyxrc.bibtex_alternatives.find("biber") != lyxrc.bibtex_alternatives.end())
3409 else if (lyxrc.bibtex_alternatives.find("bibtex8") != lyxrc.bibtex_alternatives.end())
3416 bool BufferParams::useBiblatex() const
3418 return theCiteEnginesList[citeEngine().list().front()]
3419 ->getCiteFramework() == "biblatex";
3423 void BufferParams::invalidateConverterCache() const
3425 pimpl_->isExportCacheValid = false;
3426 pimpl_->isViewCacheValid = false;