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 math_number_before = false;
389 quotes_style = InsetQuotesParams::EnglishQuotes;
390 dynamic_quotes = false;
391 fontsize = "default";
394 papersize = PAPER_DEFAULT;
395 orientation = ORIENTATION_PORTRAIT;
396 use_geometry = false;
397 biblio_style = "plain";
398 use_bibtopic = false;
401 save_transient_properties = true;
402 track_changes = false;
403 output_changes = false;
404 use_default_options = true;
405 maintain_unincluded_children = false;
408 language = default_language;
410 fonts_roman[0] = "default";
411 fonts_roman[1] = "default";
412 fonts_sans[0] = "default";
413 fonts_sans[1] = "default";
414 fonts_typewriter[0] = "default";
415 fonts_typewriter[1] = "default";
416 fonts_math[0] = "auto";
417 fonts_math[1] = "auto";
418 fonts_default_family = "default";
419 useNonTeXFonts = false;
420 use_microtype = false;
421 use_dash_ligatures = true;
422 fonts_expert_sc = false;
423 fonts_old_figures = false;
424 fonts_sans_scale[0] = 100;
425 fonts_sans_scale[1] = 100;
426 fonts_typewriter_scale[0] = 100;
427 fonts_typewriter_scale[1] = 100;
429 lang_package = "default";
430 graphics_driver = "default";
431 default_output_format = "default";
432 bibtex_command = "default";
433 index_command = "default";
436 listings_params = string();
437 pagestyle = "default";
438 suppress_date = false;
439 justification = true;
440 // no color is the default (white)
441 backgroundcolor = lyx::rgbFromHexName("#ffffff");
442 isbackgroundcolor = false;
443 // no color is the default (black)
444 fontcolor = lyx::rgbFromHexName("#000000");
446 // light gray is the default font color for greyed-out notes
447 notefontcolor = lyx::rgbFromHexName("#cccccc");
448 boxbgcolor = lyx::rgbFromHexName("#ff0000");
449 compressed = lyxrc.save_compressed;
450 for (int iter = 0; iter < 4; ++iter) {
451 user_defined_bullet(iter) = ITEMIZE_DEFAULTS[iter];
452 temp_bullet(iter) = ITEMIZE_DEFAULTS[iter];
455 indiceslist().addDefault(B_("Index"));
456 html_be_strict = false;
457 html_math_output = MathML;
458 html_math_img_scale = 1.0;
459 html_css_as_file = false;
460 display_pixel_ratio = 1.0;
465 // map current author
466 author_map_[pimpl_->authorlist.get(0).bufferId()] = 0;
470 docstring BufferParams::B_(string const & l10n) const
472 LASSERT(language, return from_utf8(l10n));
473 return getMessages(language->code()).get(l10n);
477 BufferParams::Package BufferParams::use_package(std::string const & p) const
479 PackageMap::const_iterator it = use_packages.find(p);
480 if (it == use_packages.end())
486 void BufferParams::use_package(std::string const & p, BufferParams::Package u)
492 map<string, string> const & BufferParams::auto_packages()
494 static map<string, string> packages;
495 if (packages.empty()) {
496 // We could have a race condition here that two threads
497 // discover an empty map at the same time and want to fill
498 // it, but that is no problem, since the same contents is
499 // filled in twice then. Having the locker inside the
500 // packages.empty() condition has the advantage that we
501 // don't need the mutex overhead for simple reading.
503 Mutex::Locker locker(&mutex);
504 // adding a package here implies a file format change!
505 packages["amsmath"] =
506 N_("The LaTeX package amsmath is only used if AMS formula types or symbols from the AMS math toolbars are inserted into formulas");
507 packages["amssymb"] =
508 N_("The LaTeX package amssymb is only used if symbols from the AMS math toolbars are inserted into formulas");
510 N_("The LaTeX package cancel is only used if \\cancel commands are used in formulas");
512 N_("The LaTeX package esint is only used if special integral symbols are inserted into formulas");
513 packages["mathdots"] =
514 N_("The LaTeX package mathdots is only used if the command \\iddots is inserted into formulas");
515 packages["mathtools"] =
516 N_("The LaTeX package mathtools is only used if some mathematical relations are inserted into formulas");
518 N_("The LaTeX package mhchem is only used if either the command \\ce or \\cf is inserted into formulas");
519 packages["stackrel"] =
520 N_("The LaTeX package stackrel is only used if the command \\stackrel with subscript is inserted into formulas");
521 packages["stmaryrd"] =
522 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");
523 packages["undertilde"] =
524 N_("The LaTeX package undertilde is only used if you use the math frame decoration 'utilde'");
530 bool BufferParams::useBibtopic() const
534 return (use_bibtopic || (!multibib.empty() && multibib != "child"));
538 AuthorList & BufferParams::authors()
540 return pimpl_->authorlist;
544 AuthorList const & BufferParams::authors() const
546 return pimpl_->authorlist;
550 void BufferParams::addAuthor(Author a)
552 author_map_[a.bufferId()] = pimpl_->authorlist.record(a);
556 BranchList & BufferParams::branchlist()
558 return pimpl_->branchlist;
562 BranchList const & BufferParams::branchlist() const
564 return pimpl_->branchlist;
568 IndicesList & BufferParams::indiceslist()
570 return pimpl_->indiceslist;
574 IndicesList const & BufferParams::indiceslist() const
576 return pimpl_->indiceslist;
580 Bullet & BufferParams::temp_bullet(lyx::size_type const index)
582 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
583 return pimpl_->temp_bullets[index];
587 Bullet const & BufferParams::temp_bullet(lyx::size_type const index) const
589 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
590 return pimpl_->temp_bullets[index];
594 Bullet & BufferParams::user_defined_bullet(lyx::size_type const index)
596 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
597 return pimpl_->user_defined_bullets[index];
601 Bullet const & BufferParams::user_defined_bullet(lyx::size_type const index) const
603 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
604 return pimpl_->user_defined_bullets[index];
608 Spacing & BufferParams::spacing()
610 return pimpl_->spacing;
614 Spacing const & BufferParams::spacing() const
616 return pimpl_->spacing;
620 PDFOptions & BufferParams::pdfoptions()
622 return pimpl_->pdfoptions;
626 PDFOptions const & BufferParams::pdfoptions() const
628 return pimpl_->pdfoptions;
632 Length const & BufferParams::getMathIndent() const
634 return pimpl_->mathindent;
638 void BufferParams::setMathIndent(Length const & indent)
640 pimpl_->mathindent = indent;
644 Length const & BufferParams::getParIndent() const
646 return pimpl_->parindent;
650 void BufferParams::setParIndent(Length const & indent)
652 pimpl_->parindent = indent;
656 VSpace const & BufferParams::getDefSkip() const
658 return pimpl_->defskip;
662 void BufferParams::setDefSkip(VSpace const & vs)
664 // DEFSKIP will cause an infinite loop
665 LASSERT(vs.kind() != VSpace::DEFSKIP, return);
666 pimpl_->defskip = vs;
670 string BufferParams::readToken(Lexer & lex, string const & token,
671 FileName const & filepath)
675 if (token == "\\textclass") {
677 string const classname = lex.getString();
678 // if there exists a local layout file, ignore the system one
679 // NOTE: in this case, the textclass (.cls file) is assumed to
682 LayoutFileList & bcl = LayoutFileList::get();
683 if (!filepath.empty()) {
684 // If classname is an absolute path, the document is
685 // using a local layout file which could not be accessed
686 // by a relative path. In this case the path is correct
687 // even if the document was moved to a different
688 // location. However, we will have a problem if the
689 // document was generated on a different platform.
690 bool isabsolute = FileName::isAbsolute(classname);
691 string const classpath = onlyPath(classname);
692 string const path = isabsolute ? classpath
693 : FileName(addPath(filepath.absFileName(),
694 classpath)).realPath();
695 string const oldpath = isabsolute ? string()
696 : FileName(addPath(origin, classpath)).realPath();
697 tcp = bcl.addLocalLayout(onlyFileName(classname), path, oldpath);
699 // that returns non-empty if a "local" layout file is found.
701 result = to_utf8(makeRelPath(from_utf8(onlyPath(tcp)),
702 from_utf8(filepath.absFileName())));
705 setBaseClass(onlyFileName(tcp));
707 setBaseClass(onlyFileName(classname));
708 // We assume that a tex class exists for local or unknown
709 // layouts so this warning, will only be given for system layouts.
710 if (!baseClass()->isTeXClassAvailable()) {
711 docstring const desc =
712 translateIfPossible(from_utf8(baseClass()->description()));
713 docstring const prereqs =
714 from_utf8(baseClass()->prerequisites());
715 docstring const msg =
716 bformat(_("The selected document class\n"
718 "requires external files that are not available.\n"
719 "The document class can still be used, but the\n"
720 "document cannot be compiled until the following\n"
721 "prerequisites are installed:\n"
723 "See section 3.1.2.2 (Class Availability) of the\n"
724 "User's Guide for more information."), desc, prereqs);
725 frontend::Alert::warning(_("Document class not available"),
728 } else if (token == "\\save_transient_properties") {
729 lex >> save_transient_properties;
730 } else if (token == "\\origin") {
732 origin = lex.getString();
733 string const sysdirprefix = "/systemlyxdir/";
734 if (prefixIs(origin, sysdirprefix)) {
736 if (inSystemDir(filepath, docsys))
737 origin.replace(0, sysdirprefix.length() - 1, docsys);
739 origin.replace(0, sysdirprefix.length() - 1,
740 package().system_support().absFileName());
742 } else if (token == "\\begin_preamble") {
744 } else if (token == "\\begin_local_layout") {
745 readLocalLayout(lex, false);
746 } else if (token == "\\begin_forced_local_layout") {
747 readLocalLayout(lex, true);
748 } else if (token == "\\begin_modules") {
750 } else if (token == "\\begin_removed_modules") {
751 readRemovedModules(lex);
752 } else if (token == "\\begin_includeonly") {
753 readIncludeonly(lex);
754 } else if (token == "\\maintain_unincluded_children") {
755 lex >> maintain_unincluded_children;
756 } else if (token == "\\options") {
758 options = lex.getString();
759 } else if (token == "\\use_default_options") {
760 lex >> use_default_options;
761 } else if (token == "\\master") {
763 master = lex.getString();
764 if (!filepath.empty() && FileName::isAbsolute(origin)) {
765 bool const isabs = FileName::isAbsolute(master);
766 FileName const abspath(isabs ? master : origin + master);
767 bool const moved = filepath != FileName(origin);
768 if (moved && abspath.exists()) {
769 docstring const path = isabs
771 : from_utf8(abspath.realPath());
772 docstring const refpath =
773 from_utf8(filepath.absFileName());
774 master = to_utf8(makeRelPath(path, refpath));
777 } else if (token == "\\suppress_date") {
778 lex >> suppress_date;
779 } else if (token == "\\justification") {
780 lex >> justification;
781 } else if (token == "\\language") {
783 } else if (token == "\\language_package") {
785 lang_package = lex.getString();
786 } else if (token == "\\inputencoding") {
788 } else if (token == "\\graphics") {
789 readGraphicsDriver(lex);
790 } else if (token == "\\default_output_format") {
791 lex >> default_output_format;
792 } else if (token == "\\bibtex_command") {
794 bibtex_command = lex.getString();
795 } else if (token == "\\index_command") {
797 index_command = lex.getString();
798 } else if (token == "\\fontencoding") {
800 fontenc = lex.getString();
801 } else if (token == "\\font_roman") {
802 lex >> fonts_roman[0];
803 lex >> fonts_roman[1];
804 } else if (token == "\\font_sans") {
805 lex >> fonts_sans[0];
806 lex >> fonts_sans[1];
807 } else if (token == "\\font_typewriter") {
808 lex >> fonts_typewriter[0];
809 lex >> fonts_typewriter[1];
810 } else if (token == "\\font_math") {
811 lex >> fonts_math[0];
812 lex >> fonts_math[1];
813 } else if (token == "\\font_default_family") {
814 lex >> fonts_default_family;
815 } else if (token == "\\use_non_tex_fonts") {
816 lex >> useNonTeXFonts;
817 } else if (token == "\\font_sc") {
818 lex >> fonts_expert_sc;
819 } else if (token == "\\font_osf") {
820 lex >> fonts_old_figures;
821 } else if (token == "\\font_sf_scale") {
822 lex >> fonts_sans_scale[0];
823 lex >> fonts_sans_scale[1];
824 } else if (token == "\\font_tt_scale") {
825 lex >> fonts_typewriter_scale[0];
826 lex >> fonts_typewriter_scale[1];
827 } else if (token == "\\font_cjk") {
829 } else if (token == "\\use_microtype") {
830 lex >> use_microtype;
831 } else if (token == "\\use_dash_ligatures") {
832 lex >> use_dash_ligatures;
833 } else if (token == "\\paragraph_separation") {
836 paragraph_separation = parseptranslator().find(parsep);
837 } else if (token == "\\paragraph_indentation") {
839 string parindent = lex.getString();
840 if (parindent == "default")
841 pimpl_->parindent = Length();
843 pimpl_->parindent = Length(parindent);
844 } else if (token == "\\defskip") {
846 string const defskip = lex.getString();
847 pimpl_->defskip = VSpace(defskip);
848 if (pimpl_->defskip.kind() == VSpace::DEFSKIP)
850 pimpl_->defskip = VSpace(VSpace::MEDSKIP);
851 } else if (token == "\\is_math_indent") {
852 lex >> is_math_indent;
853 } else if (token == "\\math_indentation") {
855 pimpl_->mathindent = Length(lex.getString());
856 } else if (token == "\\math_number_before") {
857 lex >> math_number_before;
858 } else if (token == "\\quotes_style") {
861 quotes_style = quotesstyletranslator().find(qstyle);
862 } else if (token == "\\dynamic_quotes") {
863 lex >> dynamic_quotes;
864 } else if (token == "\\papersize") {
867 papersize = papersizetranslator().find(ppsize);
868 } else if (token == "\\use_geometry") {
870 } else if (token == "\\use_package") {
875 use_package(package, packagetranslator().find(use));
876 } else if (token == "\\cite_engine") {
878 vector<string> engine = getVectorFromString(lex.getString());
879 setCiteEngine(engine);
880 } else if (token == "\\cite_engine_type") {
883 cite_engine_type_ = theCiteEnginesList.getType(engine_type);
884 } else if (token == "\\biblio_style") {
886 biblio_style = lex.getString();
887 } else if (token == "\\biblio_options") {
889 biblio_opts = trim(lex.getString());
890 } else if (token == "\\biblatex_bibstyle") {
892 biblatex_bibstyle = trim(lex.getString());
893 } else if (token == "\\biblatex_citestyle") {
895 biblatex_citestyle = trim(lex.getString());
896 } else if (token == "\\use_bibtopic") {
898 } else if (token == "\\multibib") {
900 } else if (token == "\\use_indices") {
902 } else if (token == "\\tracking_changes") {
903 lex >> track_changes;
904 } else if (token == "\\output_changes") {
905 lex >> output_changes;
906 } else if (token == "\\branch") {
908 docstring branch = lex.getDocString();
909 branchlist().add(branch);
912 string const tok = lex.getString();
913 if (tok == "\\end_branch")
915 Branch * branch_ptr = branchlist().find(branch);
916 if (tok == "\\selected") {
919 branch_ptr->setSelected(lex.getInteger());
921 if (tok == "\\filename_suffix") {
924 branch_ptr->setFileNameSuffix(lex.getInteger());
926 if (tok == "\\color") {
928 string color = lex.getString();
930 branch_ptr->setColor(color);
931 // Update also the Color table:
933 color = lcolor.getX11Name(Color_background);
935 lcolor.setColor(to_utf8(branch), color);
938 } else if (token == "\\index") {
940 docstring index = lex.getDocString();
942 indiceslist().add(index);
945 string const tok = lex.getString();
946 if (tok == "\\end_index")
948 Index * index_ptr = indiceslist().find(index);
949 if (tok == "\\shortcut") {
951 shortcut = lex.getDocString();
953 index_ptr->setShortcut(shortcut);
955 if (tok == "\\color") {
957 string color = lex.getString();
959 index_ptr->setColor(color);
960 // Update also the Color table:
962 color = lcolor.getX11Name(Color_background);
964 if (!shortcut.empty())
965 lcolor.setColor(to_utf8(shortcut), color);
968 } else if (token == "\\author") {
970 istringstream ss(lex.getString());
974 } else if (token == "\\paperorientation") {
977 orientation = paperorientationtranslator().find(orient);
978 } else if (token == "\\backgroundcolor") {
980 backgroundcolor = lyx::rgbFromHexName(lex.getString());
981 isbackgroundcolor = true;
982 } else if (token == "\\fontcolor") {
984 fontcolor = lyx::rgbFromHexName(lex.getString());
986 } else if (token == "\\notefontcolor") {
988 string color = lex.getString();
989 notefontcolor = lyx::rgbFromHexName(color);
990 lcolor.setColor("notefontcolor", color);
991 } else if (token == "\\boxbgcolor") {
993 string color = lex.getString();
994 boxbgcolor = lyx::rgbFromHexName(color);
995 lcolor.setColor("boxbgcolor", color);
996 } else if (token == "\\paperwidth") {
998 } else if (token == "\\paperheight") {
1000 } else if (token == "\\leftmargin") {
1002 } else if (token == "\\topmargin") {
1004 } else if (token == "\\rightmargin") {
1006 } else if (token == "\\bottommargin") {
1007 lex >> bottommargin;
1008 } else if (token == "\\headheight") {
1010 } else if (token == "\\headsep") {
1012 } else if (token == "\\footskip") {
1014 } else if (token == "\\columnsep") {
1016 } else if (token == "\\paperfontsize") {
1018 } else if (token == "\\papercolumns") {
1020 } else if (token == "\\listings_params") {
1023 listings_params = InsetListingsParams(par).params();
1024 } else if (token == "\\papersides") {
1027 sides = sidestranslator().find(psides);
1028 } else if (token == "\\paperpagestyle") {
1030 } else if (token == "\\bullet") {
1032 } else if (token == "\\bulletLaTeX") {
1033 readBulletsLaTeX(lex);
1034 } else if (token == "\\secnumdepth") {
1036 } else if (token == "\\tocdepth") {
1038 } else if (token == "\\spacing") {
1042 if (nspacing == "other") {
1045 spacing().set(spacetranslator().find(nspacing), tmp_val);
1046 } else if (token == "\\float_placement") {
1047 lex >> float_placement;
1049 } else if (prefixIs(token, "\\pdf_") || token == "\\use_hyperref") {
1050 string toktmp = pdfoptions().readToken(lex, token);
1051 if (!toktmp.empty()) {
1052 lyxerr << "PDFOptions::readToken(): Unknown token: " <<
1056 } else if (token == "\\html_math_output") {
1059 html_math_output = static_cast<MathOutput>(temp);
1060 } else if (token == "\\html_be_strict") {
1061 lex >> html_be_strict;
1062 } else if (token == "\\html_css_as_file") {
1063 lex >> html_css_as_file;
1064 } else if (token == "\\html_math_img_scale") {
1065 lex >> html_math_img_scale;
1066 } else if (token == "\\html_latex_start") {
1068 html_latex_start = lex.getString();
1069 } else if (token == "\\html_latex_end") {
1071 html_latex_end = lex.getString();
1072 } else if (token == "\\output_sync") {
1074 } else if (token == "\\output_sync_macro") {
1075 lex >> output_sync_macro;
1076 } else if (token == "\\use_refstyle") {
1077 lex >> use_refstyle;
1079 lyxerr << "BufferParams::readToken(): Unknown token: " <<
1089 // Quote argument if it contains spaces
1090 string quoteIfNeeded(string const & str) {
1091 if (contains(str, ' '))
1092 return "\"" + str + "\"";
1098 void BufferParams::writeFile(ostream & os, Buffer const * buf) const
1100 // The top of the file is written by the buffer.
1101 // Prints out the buffer info into the .lyx file given by file
1103 os << "\\save_transient_properties "
1104 << convert<string>(save_transient_properties) << '\n';
1106 // the document directory (must end with a path separator)
1107 // realPath() is used to resolve symlinks, while addPath(..., "")
1108 // ensures a trailing path separator.
1110 string filepath = addPath(buf->fileName().onlyPath().realPath(), "");
1111 string const sysdir = inSystemDir(FileName(filepath), docsys) ? docsys
1112 : addPath(package().system_support().realPath(), "");
1113 string const relpath =
1114 to_utf8(makeRelPath(from_utf8(filepath), from_utf8(sysdir)));
1115 if (!prefixIs(relpath, "../") && !FileName::isAbsolute(relpath))
1116 filepath = addPath("/systemlyxdir", relpath);
1117 else if (!save_transient_properties || !lyxrc.save_origin)
1118 filepath = "unavailable";
1119 os << "\\origin " << quoteIfNeeded(filepath) << '\n';
1122 os << "\\textclass "
1123 << quoteIfNeeded(buf->includedFilePath(addName(buf->layoutPos(),
1124 baseClass()->name()), "layout"))
1127 // then the preamble
1128 if (!preamble.empty()) {
1129 // remove '\n' from the end of preamble
1130 docstring const tmppreamble = rtrim(preamble, "\n");
1131 os << "\\begin_preamble\n"
1132 << to_utf8(tmppreamble)
1133 << "\n\\end_preamble\n";
1137 if (!options.empty()) {
1138 os << "\\options " << options << '\n';
1141 // use the class options defined in the layout?
1142 os << "\\use_default_options "
1143 << convert<string>(use_default_options) << "\n";
1145 // the master document
1146 if (!master.empty()) {
1147 os << "\\master " << master << '\n';
1151 if (!removed_modules_.empty()) {
1152 os << "\\begin_removed_modules" << '\n';
1153 list<string>::const_iterator it = removed_modules_.begin();
1154 list<string>::const_iterator en = removed_modules_.end();
1155 for (; it != en; ++it)
1157 os << "\\end_removed_modules" << '\n';
1161 if (!layout_modules_.empty()) {
1162 os << "\\begin_modules" << '\n';
1163 LayoutModuleList::const_iterator it = layout_modules_.begin();
1164 LayoutModuleList::const_iterator en = layout_modules_.end();
1165 for (; it != en; ++it)
1167 os << "\\end_modules" << '\n';
1171 if (!included_children_.empty()) {
1172 os << "\\begin_includeonly" << '\n';
1173 list<string>::const_iterator it = included_children_.begin();
1174 list<string>::const_iterator en = included_children_.end();
1175 for (; it != en; ++it)
1177 os << "\\end_includeonly" << '\n';
1179 os << "\\maintain_unincluded_children "
1180 << convert<string>(maintain_unincluded_children) << '\n';
1182 // local layout information
1183 docstring const local_layout = getLocalLayout(false);
1184 if (!local_layout.empty()) {
1185 // remove '\n' from the end
1186 docstring const tmplocal = rtrim(local_layout, "\n");
1187 os << "\\begin_local_layout\n"
1188 << to_utf8(tmplocal)
1189 << "\n\\end_local_layout\n";
1191 docstring const forced_local_layout = getLocalLayout(true);
1192 if (!forced_local_layout.empty()) {
1193 // remove '\n' from the end
1194 docstring const tmplocal = rtrim(forced_local_layout, "\n");
1195 os << "\\begin_forced_local_layout\n"
1196 << to_utf8(tmplocal)
1197 << "\n\\end_forced_local_layout\n";
1200 // then the text parameters
1201 if (language != ignore_language)
1202 os << "\\language " << language->lang() << '\n';
1203 os << "\\language_package " << lang_package
1204 << "\n\\inputencoding " << inputenc
1205 << "\n\\fontencoding " << fontenc
1206 << "\n\\font_roman \"" << fonts_roman[0]
1207 << "\" \"" << fonts_roman[1] << '"'
1208 << "\n\\font_sans \"" << fonts_sans[0]
1209 << "\" \"" << fonts_sans[1] << '"'
1210 << "\n\\font_typewriter \"" << fonts_typewriter[0]
1211 << "\" \"" << fonts_typewriter[1] << '"'
1212 << "\n\\font_math \"" << fonts_math[0]
1213 << "\" \"" << fonts_math[1] << '"'
1214 << "\n\\font_default_family " << fonts_default_family
1215 << "\n\\use_non_tex_fonts " << convert<string>(useNonTeXFonts)
1216 << "\n\\font_sc " << convert<string>(fonts_expert_sc)
1217 << "\n\\font_osf " << convert<string>(fonts_old_figures)
1218 << "\n\\font_sf_scale " << fonts_sans_scale[0]
1219 << ' ' << fonts_sans_scale[1]
1220 << "\n\\font_tt_scale " << fonts_typewriter_scale[0]
1221 << ' ' << fonts_typewriter_scale[1]
1223 if (!fonts_cjk.empty()) {
1224 os << "\\font_cjk " << fonts_cjk << '\n';
1226 os << "\\use_microtype " << convert<string>(use_microtype) << '\n';
1227 os << "\\use_dash_ligatures " << convert<string>(use_dash_ligatures) << '\n';
1228 os << "\\graphics " << graphics_driver << '\n';
1229 os << "\\default_output_format " << default_output_format << '\n';
1230 os << "\\output_sync " << output_sync << '\n';
1231 if (!output_sync_macro.empty())
1232 os << "\\output_sync_macro \"" << output_sync_macro << "\"\n";
1233 os << "\\bibtex_command " << bibtex_command << '\n';
1234 os << "\\index_command " << index_command << '\n';
1236 if (!float_placement.empty()) {
1237 os << "\\float_placement " << float_placement << '\n';
1239 os << "\\paperfontsize " << fontsize << '\n';
1241 spacing().writeFile(os);
1242 pdfoptions().writeFile(os);
1244 os << "\\papersize " << string_papersize[papersize]
1245 << "\n\\use_geometry " << convert<string>(use_geometry);
1246 map<string, string> const & packages = auto_packages();
1247 for (map<string, string>::const_iterator it = packages.begin();
1248 it != packages.end(); ++it)
1249 os << "\n\\use_package " << it->first << ' '
1250 << use_package(it->first);
1252 os << "\n\\cite_engine ";
1254 if (!cite_engine_.empty()) {
1255 LayoutModuleList::const_iterator be = cite_engine_.begin();
1256 LayoutModuleList::const_iterator en = cite_engine_.end();
1257 for (LayoutModuleList::const_iterator it = be; it != en; ++it) {
1266 os << "\n\\cite_engine_type " << theCiteEnginesList.getTypeAsString(cite_engine_type_);
1268 if (!biblio_style.empty())
1269 os << "\n\\biblio_style " << biblio_style;
1270 if (!biblio_opts.empty())
1271 os << "\n\\biblio_options " << biblio_opts;
1272 if (!biblatex_bibstyle.empty())
1273 os << "\n\\biblatex_bibstyle " << biblatex_bibstyle;
1274 if (!biblatex_citestyle.empty())
1275 os << "\n\\biblatex_citestyle " << biblatex_citestyle;
1276 if (!multibib.empty())
1277 os << "\n\\multibib " << multibib;
1279 os << "\n\\use_bibtopic " << convert<string>(use_bibtopic)
1280 << "\n\\use_indices " << convert<string>(use_indices)
1281 << "\n\\paperorientation " << string_orientation[orientation]
1282 << "\n\\suppress_date " << convert<string>(suppress_date)
1283 << "\n\\justification " << convert<string>(justification)
1284 << "\n\\use_refstyle " << use_refstyle
1286 if (isbackgroundcolor == true)
1287 os << "\\backgroundcolor " << lyx::X11hexname(backgroundcolor) << '\n';
1288 if (isfontcolor == true)
1289 os << "\\fontcolor " << lyx::X11hexname(fontcolor) << '\n';
1290 if (notefontcolor != lyx::rgbFromHexName("#cccccc"))
1291 os << "\\notefontcolor " << lyx::X11hexname(notefontcolor) << '\n';
1292 if (boxbgcolor != lyx::rgbFromHexName("#ff0000"))
1293 os << "\\boxbgcolor " << lyx::X11hexname(boxbgcolor) << '\n';
1295 BranchList::const_iterator it = branchlist().begin();
1296 BranchList::const_iterator end = branchlist().end();
1297 for (; it != end; ++it) {
1298 os << "\\branch " << to_utf8(it->branch())
1299 << "\n\\selected " << it->isSelected()
1300 << "\n\\filename_suffix " << it->hasFileNameSuffix()
1301 << "\n\\color " << lyx::X11hexname(it->color())
1306 IndicesList::const_iterator iit = indiceslist().begin();
1307 IndicesList::const_iterator iend = indiceslist().end();
1308 for (; iit != iend; ++iit) {
1309 os << "\\index " << to_utf8(iit->index())
1310 << "\n\\shortcut " << to_utf8(iit->shortcut())
1311 << "\n\\color " << lyx::X11hexname(iit->color())
1316 if (!paperwidth.empty())
1317 os << "\\paperwidth "
1318 << VSpace(paperwidth).asLyXCommand() << '\n';
1319 if (!paperheight.empty())
1320 os << "\\paperheight "
1321 << VSpace(paperheight).asLyXCommand() << '\n';
1322 if (!leftmargin.empty())
1323 os << "\\leftmargin "
1324 << VSpace(leftmargin).asLyXCommand() << '\n';
1325 if (!topmargin.empty())
1326 os << "\\topmargin "
1327 << VSpace(topmargin).asLyXCommand() << '\n';
1328 if (!rightmargin.empty())
1329 os << "\\rightmargin "
1330 << VSpace(rightmargin).asLyXCommand() << '\n';
1331 if (!bottommargin.empty())
1332 os << "\\bottommargin "
1333 << VSpace(bottommargin).asLyXCommand() << '\n';
1334 if (!headheight.empty())
1335 os << "\\headheight "
1336 << VSpace(headheight).asLyXCommand() << '\n';
1337 if (!headsep.empty())
1339 << VSpace(headsep).asLyXCommand() << '\n';
1340 if (!footskip.empty())
1342 << VSpace(footskip).asLyXCommand() << '\n';
1343 if (!columnsep.empty())
1344 os << "\\columnsep "
1345 << VSpace(columnsep).asLyXCommand() << '\n';
1346 os << "\\secnumdepth " << secnumdepth
1347 << "\n\\tocdepth " << tocdepth
1348 << "\n\\paragraph_separation "
1349 << string_paragraph_separation[paragraph_separation];
1350 if (!paragraph_separation)
1351 os << "\n\\paragraph_indentation "
1352 << (getParIndent().empty() ? "default" : getParIndent().asString());
1354 os << "\n\\defskip " << getDefSkip().asLyXCommand();
1355 os << "\n\\is_math_indent " << is_math_indent;
1356 if (is_math_indent && !getMathIndent().empty())
1357 os << "\n\\math_indentation " << getMathIndent().asString();
1358 os << "\n\\math_number_before " << math_number_before;
1359 os << "\n\\quotes_style "
1360 << string_quotes_style[quotes_style]
1361 << "\n\\dynamic_quotes " << dynamic_quotes
1362 << "\n\\papercolumns " << columns
1363 << "\n\\papersides " << sides
1364 << "\n\\paperpagestyle " << pagestyle << '\n';
1365 if (!listings_params.empty())
1366 os << "\\listings_params \"" <<
1367 InsetListingsParams(listings_params).encodedString() << "\"\n";
1368 for (int i = 0; i < 4; ++i) {
1369 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1370 if (user_defined_bullet(i).getFont() != -1) {
1371 os << "\\bullet " << i << " "
1372 << user_defined_bullet(i).getFont() << " "
1373 << user_defined_bullet(i).getCharacter() << " "
1374 << user_defined_bullet(i).getSize() << "\n";
1378 os << "\\bulletLaTeX " << i << " \""
1379 << lyx::to_ascii(user_defined_bullet(i).getText())
1385 os << "\\tracking_changes "
1386 << (save_transient_properties ? convert<string>(track_changes) : "false")
1389 os << "\\output_changes "
1390 << (save_transient_properties ? convert<string>(output_changes) : "false")
1393 os << "\\html_math_output " << html_math_output << '\n'
1394 << "\\html_css_as_file " << html_css_as_file << '\n'
1395 << "\\html_be_strict " << convert<string>(html_be_strict) << '\n';
1397 if (html_math_img_scale != 1.0)
1398 os << "\\html_math_img_scale " << convert<string>(html_math_img_scale) << '\n';
1399 if (!html_latex_start.empty())
1400 os << "\\html_latex_start " << html_latex_start << '\n';
1401 if (!html_latex_end.empty())
1402 os << "\\html_latex_end " << html_latex_end << '\n';
1404 os << pimpl_->authorlist;
1408 void BufferParams::validate(LaTeXFeatures & features) const
1410 features.require(documentClass().requires());
1412 if (columns > 1 && language->rightToLeft())
1413 features.require("rtloutputdblcol");
1415 if (output_changes) {
1416 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1417 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1418 LaTeXFeatures::isAvailable("xcolor");
1420 switch (features.runparams().flavor) {
1421 case OutputParams::LATEX:
1422 case OutputParams::DVILUATEX:
1424 features.require("ct-dvipost");
1425 features.require("dvipost");
1426 } else if (xcolorulem) {
1427 features.require("ct-xcolor-ulem");
1428 features.require("ulem");
1429 features.require("xcolor");
1431 features.require("ct-none");
1434 case OutputParams::LUATEX:
1435 case OutputParams::PDFLATEX:
1436 case OutputParams::XETEX:
1438 features.require("ct-xcolor-ulem");
1439 features.require("ulem");
1440 features.require("xcolor");
1441 // improves color handling in PDF output
1442 features.require("pdfcolmk");
1444 features.require("ct-none");
1452 // Floats with 'Here definitely' as default setting.
1453 if (float_placement.find('H') != string::npos)
1454 features.require("float");
1456 for (PackageMap::const_iterator it = use_packages.begin();
1457 it != use_packages.end(); ++it) {
1458 if (it->first == "amsmath") {
1459 // AMS Style is at document level
1460 if (it->second == package_on ||
1461 features.isProvided("amsmath"))
1462 features.require(it->first);
1463 } else if (it->second == package_on)
1464 features.require(it->first);
1467 // Document-level line spacing
1468 if (spacing().getSpace() != Spacing::Single && !spacing().isDefault())
1469 features.require("setspace");
1471 // the bullet shapes are buffer level not paragraph level
1472 // so they are tested here
1473 for (int i = 0; i < 4; ++i) {
1474 if (user_defined_bullet(i) == ITEMIZE_DEFAULTS[i])
1476 int const font = user_defined_bullet(i).getFont();
1478 int const c = user_defined_bullet(i).getCharacter();
1484 features.require("latexsym");
1486 } else if (font == 1) {
1487 features.require("amssymb");
1488 } else if (font >= 2 && font <= 5) {
1489 features.require("pifont");
1493 if (pdfoptions().use_hyperref) {
1494 features.require("hyperref");
1495 // due to interferences with babel and hyperref, the color package has to
1496 // be loaded after hyperref when hyperref is used with the colorlinks
1497 // option, see http://www.lyx.org/trac/ticket/5291
1498 if (pdfoptions().colorlinks)
1499 features.require("color");
1501 if (!listings_params.empty()) {
1502 // do not test validity because listings_params is
1503 // supposed to be valid
1505 InsetListingsParams(listings_params).separatedParams(true);
1506 // we can't support all packages, but we should load the color package
1507 if (par.find("\\color", 0) != string::npos)
1508 features.require("color");
1511 // some languages are only available via polyglossia
1512 if (features.hasPolyglossiaExclusiveLanguages())
1513 features.require("polyglossia");
1515 if (useNonTeXFonts && fontsMath() != "auto")
1516 features.require("unicode-math");
1519 features.require("microtype");
1521 if (!language->requires().empty())
1522 features.require(language->requires());
1526 bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
1527 FileName const & filepath) const
1529 // http://www.tug.org/texmf-dist/doc/latex/base/fixltx2e.pdf
1530 // !! To use the Fix-cm package, load it before \documentclass, and use the command
1531 // \RequirePackage to do so, rather than the normal \usepackage
1532 // Do not try to load any other package before the document class, unless you
1533 // have a thorough understanding of the LATEX internals and know exactly what you
1535 if (features.mustProvide("fix-cm"))
1536 os << "\\RequirePackage{fix-cm}\n";
1537 // Likewise for fixltx2e. If other packages conflict with this policy,
1538 // treat it as a package bug (and report it!)
1539 // See http://www.latex-project.org/cgi-bin/ltxbugs2html?pr=latex/4407
1540 if (features.mustProvide("fixltx2e"))
1541 os << "\\RequirePackage{fixltx2e}\n";
1543 os << "\\documentclass";
1545 DocumentClass const & tclass = documentClass();
1547 ostringstream clsoptions; // the document class options.
1549 if (tokenPos(tclass.opt_fontsize(),
1550 '|', fontsize) >= 0) {
1551 // only write if existing in list (and not default)
1552 clsoptions << fontsize << "pt,";
1555 // all paper sizes except of A4, A5, B5 and the US sizes need the
1557 bool nonstandard_papersize = papersize != PAPER_DEFAULT
1558 && papersize != PAPER_USLETTER
1559 && papersize != PAPER_USLEGAL
1560 && papersize != PAPER_USEXECUTIVE
1561 && papersize != PAPER_A4
1562 && papersize != PAPER_A5
1563 && papersize != PAPER_B5;
1565 if (!use_geometry) {
1566 switch (papersize) {
1568 clsoptions << "a4paper,";
1570 case PAPER_USLETTER:
1571 clsoptions << "letterpaper,";
1574 clsoptions << "a5paper,";
1577 clsoptions << "b5paper,";
1579 case PAPER_USEXECUTIVE:
1580 clsoptions << "executivepaper,";
1583 clsoptions << "legalpaper,";
1617 if (sides != tclass.sides()) {
1620 clsoptions << "oneside,";
1623 clsoptions << "twoside,";
1629 if (columns != tclass.columns()) {
1631 clsoptions << "twocolumn,";
1633 clsoptions << "onecolumn,";
1637 && orientation == ORIENTATION_LANDSCAPE)
1638 clsoptions << "landscape,";
1641 clsoptions << "fleqn,";
1643 if (math_number_before)
1644 clsoptions << "leqno,";
1646 // language should be a parameter to \documentclass
1647 if (language->babel() == "hebrew"
1648 && default_language->babel() != "hebrew")
1649 // This seems necessary
1650 features.useLanguage(default_language);
1652 ostringstream language_options;
1653 bool const use_babel = features.useBabel() && !features.isProvided("babel");
1654 bool const use_polyglossia = features.usePolyglossia();
1655 bool const global = lyxrc.language_global_options;
1656 if (use_babel || (use_polyglossia && global)) {
1657 language_options << features.getBabelLanguages();
1658 if (!language->babel().empty()) {
1659 if (!language_options.str().empty())
1660 language_options << ',';
1661 language_options << language->babel();
1663 if (global && !features.needBabelLangOptions()
1664 && !language_options.str().empty())
1665 clsoptions << language_options.str() << ',';
1668 // the predefined options from the layout
1669 if (use_default_options && !tclass.options().empty())
1670 clsoptions << tclass.options() << ',';
1672 // the user-defined options
1673 if (!options.empty()) {
1674 clsoptions << options << ',';
1677 string strOptions(clsoptions.str());
1678 if (!strOptions.empty()) {
1679 strOptions = rtrim(strOptions, ",");
1681 os << '[' << from_utf8(strOptions) << ']';
1684 os << '{' << from_ascii(tclass.latexname()) << "}\n";
1685 // end of \documentclass defs
1687 // if we use fontspec or newtxmath, we have to load the AMS packages here
1688 string const ams = features.loadAMSPackages();
1689 bool const ot1 = (main_font_encoding() == "default" || main_font_encoding() == "OT1");
1690 bool const use_newtxmath =
1691 theLaTeXFonts().getLaTeXFont(from_ascii(fontsMath())).getUsedPackage(
1692 ot1, false, false) == "newtxmath";
1693 if ((useNonTeXFonts || use_newtxmath) && !ams.empty())
1694 os << from_ascii(ams);
1696 if (useNonTeXFonts) {
1697 if (!features.isProvided("fontspec"))
1698 os << "\\usepackage{fontspec}\n";
1699 if (features.mustProvide("unicode-math")
1700 && features.isAvailable("unicode-math"))
1701 os << "\\usepackage{unicode-math}\n";
1704 // font selection must be done before loading fontenc.sty
1705 string const fonts = loadFonts(features);
1707 os << from_utf8(fonts);
1709 if (fonts_default_family != "default")
1710 os << "\\renewcommand{\\familydefault}{\\"
1711 << from_ascii(fonts_default_family) << "}\n";
1713 // set font encoding
1714 // XeTeX and LuaTeX (with OS fonts) do not need fontenc
1715 if (!useNonTeXFonts && !features.isProvided("fontenc")
1716 && main_font_encoding() != "default") {
1717 // get main font encodings
1718 vector<string> fontencs = font_encodings();
1719 // get font encodings of secondary languages
1720 features.getFontEncodings(fontencs);
1721 if (!fontencs.empty()) {
1722 os << "\\usepackage["
1723 << from_ascii(getStringFromVector(fontencs))
1728 // handle inputenc etc.
1729 writeEncodingPreamble(os, features);
1732 if (!features.runparams().includeall && !included_children_.empty()) {
1733 os << "\\includeonly{";
1734 list<string>::const_iterator it = included_children_.begin();
1735 list<string>::const_iterator en = included_children_.end();
1737 for (; it != en; ++it) {
1738 string incfile = *it;
1739 FileName inc = makeAbsPath(incfile, filepath.absFileName());
1740 string mangled = DocFileName(changeExtension(inc.absFileName(), ".tex")).
1742 if (!features.runparams().nice)
1744 // \includeonly doesn't want an extension
1745 incfile = changeExtension(incfile, string());
1746 incfile = support::latex_path(incfile);
1747 if (!incfile.empty()) {
1750 os << from_utf8(incfile);
1757 if (!features.isProvided("geometry")
1758 && (use_geometry || nonstandard_papersize)) {
1759 odocstringstream ods;
1760 if (!getGraphicsDriver("geometry").empty())
1761 ods << getGraphicsDriver("geometry");
1762 if (orientation == ORIENTATION_LANDSCAPE)
1763 ods << ",landscape";
1764 switch (papersize) {
1766 if (!paperwidth.empty())
1767 ods << ",paperwidth="
1768 << from_ascii(paperwidth);
1769 if (!paperheight.empty())
1770 ods << ",paperheight="
1771 << from_ascii(paperheight);
1773 case PAPER_USLETTER:
1774 ods << ",letterpaper";
1777 ods << ",legalpaper";
1779 case PAPER_USEXECUTIVE:
1780 ods << ",executivepaper";
1869 docstring const g_options = trim(ods.str(), ",");
1870 os << "\\usepackage";
1871 if (!g_options.empty())
1872 os << '[' << g_options << ']';
1873 os << "{geometry}\n";
1874 // output this only if use_geometry is true
1876 os << "\\geometry{verbose";
1877 if (!topmargin.empty())
1878 os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1879 if (!bottommargin.empty())
1880 os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1881 if (!leftmargin.empty())
1882 os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1883 if (!rightmargin.empty())
1884 os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1885 if (!headheight.empty())
1886 os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1887 if (!headsep.empty())
1888 os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1889 if (!footskip.empty())
1890 os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1891 if (!columnsep.empty())
1892 os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
1895 } else if (orientation == ORIENTATION_LANDSCAPE
1896 || papersize != PAPER_DEFAULT) {
1897 features.require("papersize");
1900 if (tokenPos(tclass.opt_pagestyle(), '|', pagestyle) >= 0) {
1901 if (pagestyle == "fancy")
1902 os << "\\usepackage{fancyhdr}\n";
1903 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1906 // only output when the background color is not default
1907 if (isbackgroundcolor == true) {
1908 // only require color here, the background color will be defined
1909 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1911 features.require("color");
1912 features.require("pagecolor");
1915 // only output when the font color is not default
1916 if (isfontcolor == true) {
1917 // only require color here, the font color will be defined
1918 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1920 features.require("color");
1921 features.require("fontcolor");
1924 // Only if class has a ToC hierarchy
1925 if (tclass.hasTocLevels()) {
1926 if (secnumdepth != tclass.secnumdepth()) {
1927 os << "\\setcounter{secnumdepth}{"
1931 if (tocdepth != tclass.tocdepth()) {
1932 os << "\\setcounter{tocdepth}{"
1938 if (paragraph_separation) {
1939 // when skip separation
1940 switch (getDefSkip().kind()) {
1941 case VSpace::SMALLSKIP:
1942 os << "\\setlength{\\parskip}{\\smallskipamount}\n";
1944 case VSpace::MEDSKIP:
1945 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1947 case VSpace::BIGSKIP:
1948 os << "\\setlength{\\parskip}{\\bigskipamount}\n";
1950 case VSpace::LENGTH:
1951 os << "\\setlength{\\parskip}{"
1952 << from_utf8(getDefSkip().length().asLatexString())
1955 default: // should never happen // Then delete it.
1956 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1959 os << "\\setlength{\\parindent}{0pt}\n";
1961 // when separation by indentation
1962 // only output something when a width is given
1963 if (!getParIndent().empty()) {
1964 os << "\\setlength{\\parindent}{"
1965 << from_utf8(getParIndent().asLatexString())
1970 if (is_math_indent) {
1971 // when formula indentation
1972 // only output something when it is not the default
1973 if (!getMathIndent().empty()) {
1974 os << "\\setlength{\\mathindent}{"
1975 << from_utf8(getMathIndent().asString())
1980 // Now insert the LyX specific LaTeX commands...
1981 features.resolveAlternatives();
1982 features.expandMultiples();
1985 if (!output_sync_macro.empty())
1986 os << from_utf8(output_sync_macro) +"\n";
1987 else if (features.runparams().flavor == OutputParams::LATEX)
1988 os << "\\usepackage[active]{srcltx}\n";
1989 else if (features.runparams().flavor == OutputParams::PDFLATEX)
1990 os << "\\synctex=-1\n";
1993 // The package options (via \PassOptionsToPackage)
1994 os << from_ascii(features.getPackageOptions());
1996 // due to interferences with babel and hyperref, the color package has to
1997 // be loaded (when it is not already loaded) before babel when hyperref
1998 // is used with the colorlinks option, see
1999 // http://www.lyx.org/trac/ticket/5291
2000 // we decided therefore to load color always before babel, see
2001 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
2002 os << from_ascii(features.getColorOptions());
2004 // If we use hyperref, jurabib, japanese, varioref or vietnamese,
2005 // we have to call babel before
2007 && (features.isRequired("jurabib")
2008 || features.isRequired("hyperref")
2009 || features.isRequired("varioref")
2010 || features.isRequired("vietnamese")
2011 || features.isRequired("japanese"))) {
2012 os << features.getBabelPresettings();
2014 os << from_utf8(babelCall(language_options.str(),
2015 features.needBabelLangOptions())) + '\n';
2016 os << features.getBabelPostsettings();
2019 // The optional packages;
2020 os << from_ascii(features.getPackages());
2022 // Additional Indices
2023 if (features.isRequired("splitidx")) {
2024 IndicesList::const_iterator iit = indiceslist().begin();
2025 IndicesList::const_iterator iend = indiceslist().end();
2026 for (; iit != iend; ++iit) {
2027 os << "\\newindex{";
2028 os << escape(iit->shortcut());
2034 os << from_utf8(spacing().writePreamble(features.isProvided("SetSpace")));
2037 // * Hyperref manual: "Make sure it comes last of your loaded
2038 // packages, to give it a fighting chance of not being over-written,
2039 // since its job is to redefine many LaTeX commands."
2040 // * Email from Heiko Oberdiek: "It is usually better to load babel
2041 // before hyperref. Then hyperref has a chance to detect babel.
2042 // * Has to be loaded before the "LyX specific LaTeX commands" to
2043 // avoid errors with algorithm floats.
2044 // use hyperref explicitly if it is required
2045 if (features.isRequired("hyperref")) {
2046 OutputParams tmp_params = features.runparams();
2047 pdfoptions().writeLaTeX(tmp_params, os,
2048 features.isProvided("hyperref"));
2049 // correctly break URLs with hyperref and dvi output
2050 if (features.runparams().flavor == OutputParams::LATEX
2051 && features.isAvailable("breakurl"))
2052 os << "\\usepackage{breakurl}\n";
2053 } else if (features.isRequired("nameref"))
2054 // hyperref loads this automatically
2055 os << "\\usepackage{nameref}\n";
2057 // bibtopic needs to be loaded after hyperref.
2058 // the dot provides the aux file naming which LyX can detect.
2059 if (features.mustProvide("bibtopic"))
2060 os << "\\usepackage[dot]{bibtopic}\n";
2062 // Will be surrounded by \makeatletter and \makeatother when not empty
2063 otexstringstream atlyxpreamble;
2065 // Some macros LyX will need
2067 TexString tmppreamble = features.getMacros();
2068 if (!tmppreamble.str.empty())
2069 atlyxpreamble << "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2070 "LyX specific LaTeX commands.\n"
2071 << move(tmppreamble)
2074 // the text class specific preamble
2076 docstring tmppreamble = features.getTClassPreamble();
2077 if (!tmppreamble.empty())
2078 atlyxpreamble << "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2079 "Textclass specific LaTeX commands.\n"
2083 // suppress date if selected
2084 // use \@ifundefined because we cannot be sure that every document class
2085 // has a \date command
2087 atlyxpreamble << "\\@ifundefined{date}{}{\\date{}}\n";
2089 /* the user-defined preamble */
2090 if (!containsOnly(preamble, " \n\t")) {
2092 atlyxpreamble << "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2093 "User specified LaTeX commands.\n";
2095 // Check if the user preamble contains uncodable glyphs
2096 odocstringstream user_preamble;
2097 docstring uncodable_glyphs;
2098 Encoding const * const enc = features.runparams().encoding;
2100 for (size_t n = 0; n < preamble.size(); ++n) {
2101 char_type c = preamble[n];
2102 if (!enc->encodable(c)) {
2103 docstring const glyph(1, c);
2104 LYXERR0("Uncodable character '"
2106 << "' in user preamble!");
2107 uncodable_glyphs += glyph;
2108 if (features.runparams().dryrun) {
2109 user_preamble << "<" << _("LyX Warning: ")
2110 << _("uncodable character") << " '";
2111 user_preamble.put(c);
2112 user_preamble << "'>";
2115 user_preamble.put(c);
2118 user_preamble << preamble;
2120 // On BUFFER_VIEW|UPDATE, warn user if we found uncodable glyphs
2121 if (!features.runparams().dryrun && !uncodable_glyphs.empty()) {
2122 frontend::Alert::warning(
2123 _("Uncodable character in user preamble"),
2125 _("The user preamble of your document contains glyphs "
2126 "that are unknown in the current document encoding "
2127 "(namely %1$s).\nThese glyphs are omitted "
2128 " from the output, which may result in "
2129 "incomplete output."
2130 "\n\nPlease select an appropriate "
2131 "document encoding\n"
2132 "(such as utf8) or change the "
2133 "preamble code accordingly."),
2136 atlyxpreamble << user_preamble.str() << '\n';
2139 // footmisc must be loaded after setspace
2140 // Load it here to avoid clashes with footmisc loaded in the user
2141 // preamble. For that reason we also pass the options via
2142 // \PassOptionsToPackage in getPreamble() and not here.
2143 if (features.mustProvide("footmisc"))
2144 atlyxpreamble << "\\usepackage{footmisc}\n";
2146 // subfig loads internally the LaTeX package "caption". As
2147 // caption is a very popular package, users will load it in
2148 // the preamble. Therefore we must load subfig behind the
2149 // user-defined preamble and check if the caption package was
2150 // loaded or not. For the case that caption is loaded before
2151 // subfig, there is the subfig option "caption=false". This
2152 // option also works when a koma-script class is used and
2153 // koma's own caption commands are used instead of caption. We
2154 // use \PassOptionsToPackage here because the user could have
2155 // already loaded subfig in the preamble.
2156 if (features.mustProvide("subfig"))
2157 atlyxpreamble << "\\@ifundefined{showcaptionsetup}{}{%\n"
2158 " \\PassOptionsToPackage{caption=false}{subfig}}\n"
2159 "\\usepackage{subfig}\n";
2161 // Itemize bullet settings need to be last in case the user
2162 // defines their own bullets that use a package included
2163 // in the user-defined preamble -- ARRae
2164 // Actually it has to be done much later than that
2165 // since some packages like frenchb make modifications
2166 // at \begin{document} time -- JMarc
2167 docstring bullets_def;
2168 for (int i = 0; i < 4; ++i) {
2169 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
2170 if (bullets_def.empty())
2171 bullets_def += "\\AtBeginDocument{\n";
2172 bullets_def += " \\def\\labelitemi";
2174 // `i' is one less than the item to modify
2181 bullets_def += "ii";
2187 bullets_def += '{' +
2188 user_defined_bullet(i).getText()
2193 if (!bullets_def.empty())
2194 atlyxpreamble << bullets_def << "}\n\n";
2196 if (!atlyxpreamble.empty())
2197 os << "\n\\makeatletter\n"
2198 << atlyxpreamble.release()
2199 << "\\makeatother\n\n";
2201 // We try to load babel late, in case it interferes with other packages.
2202 // Jurabib, hyperref, varioref, bicaption and listings (bug 8995) have to be
2203 // called after babel, though.
2204 if (use_babel && !features.isRequired("jurabib")
2205 && !features.isRequired("hyperref")
2206 && !features.isRequired("varioref")
2207 && !features.isRequired("vietnamese")
2208 && !features.isRequired("japanese")) {
2209 os << features.getBabelPresettings();
2211 os << from_utf8(babelCall(language_options.str(),
2212 features.needBabelLangOptions())) + '\n';
2213 os << features.getBabelPostsettings();
2215 if (features.isRequired("bicaption"))
2216 os << "\\usepackage{bicaption}\n";
2217 if (!listings_params.empty() || features.mustProvide("listings"))
2218 os << "\\usepackage{listings}\n";
2219 if (!listings_params.empty()) {
2221 // do not test validity because listings_params is
2222 // supposed to be valid
2224 InsetListingsParams(listings_params).separatedParams(true);
2225 os << from_utf8(par);
2229 // xunicode only needs to be loaded if tipa is used
2230 // (the rest is obsoleted by the new TU encoding).
2231 // It needs to be loaded at least after amsmath, amssymb,
2232 // esint and the other packages that provide special glyphs
2233 if (features.mustProvide("tipa") && useNonTeXFonts) {
2234 // The package officially only supports XeTeX, but also works
2235 // with LuaTeX. Thus we work around its XeTeX test.
2236 if (features.runparams().flavor != OutputParams::XETEX) {
2237 os << "% Pretend to xunicode that we are XeTeX\n"
2238 << "\\def\\XeTeXpicfile{}\n";
2240 os << "\\usepackage{xunicode}\n";
2243 // Polyglossia must be loaded last ...
2244 if (use_polyglossia) {
2246 os << "\\usepackage{polyglossia}\n";
2247 // set the main language
2248 os << "\\setdefaultlanguage";
2249 if (!language->polyglossiaOpts().empty())
2250 os << "[" << from_ascii(language->polyglossiaOpts()) << "]";
2251 os << "{" << from_ascii(language->polyglossia()) << "}\n";
2252 // now setup the other languages
2253 set<string> const polylangs =
2254 features.getPolyglossiaLanguages();
2255 for (set<string>::const_iterator mit = polylangs.begin();
2256 mit != polylangs.end() ; ++mit) {
2257 // We do not output the options here; they are output in
2258 // the language switch commands. This is safer if multiple
2259 // varieties are used.
2260 if (*mit == language->polyglossia())
2262 os << "\\setotherlanguage";
2263 os << "{" << from_ascii(*mit) << "}\n";
2267 // ... but before biblatex (see #7065)
2268 if (features.mustProvide("biblatex")) {
2271 os << "\\usepackage";
2272 if (!biblatex_bibstyle.empty()
2273 && (biblatex_bibstyle == biblatex_citestyle)) {
2274 opts = "style=" + biblatex_bibstyle;
2277 if (!biblatex_bibstyle.empty()) {
2278 opts = "bibstyle=" + biblatex_bibstyle;
2281 if (!biblatex_citestyle.empty()) {
2282 opts += delim + "citestyle=" + biblatex_citestyle;
2286 if (!multibib.empty() && multibib != "child") {
2287 opts += delim + "refsection=" + multibib;
2290 if (bibtexCommand() == "bibtex8"
2291 || prefixIs(bibtexCommand(), "bibtex8 ")) {
2292 opts += delim + "backend=bibtex8";
2294 } else if (bibtexCommand() == "bibtex"
2295 || prefixIs(bibtexCommand(), "bibtex ")) {
2296 opts += delim + "backend=bibtex";
2299 if (!biblio_opts.empty())
2300 opts += delim + biblio_opts;
2302 os << "[" << opts << "]";
2303 os << "{biblatex}\n";
2307 // Load custom language package here
2308 if (features.langPackage() == LaTeXFeatures::LANG_PACK_CUSTOM) {
2309 if (lang_package == "default")
2310 os << from_utf8(lyxrc.language_custom_package);
2312 os << from_utf8(lang_package);
2316 docstring const i18npreamble =
2317 features.getTClassI18nPreamble(use_babel, use_polyglossia);
2318 if (!i18npreamble.empty())
2319 os << i18npreamble + '\n';
2325 void BufferParams::useClassDefaults()
2327 DocumentClass const & tclass = documentClass();
2329 sides = tclass.sides();
2330 columns = tclass.columns();
2331 pagestyle = tclass.pagestyle();
2332 use_default_options = true;
2333 // Only if class has a ToC hierarchy
2334 if (tclass.hasTocLevels()) {
2335 secnumdepth = tclass.secnumdepth();
2336 tocdepth = tclass.tocdepth();
2341 bool BufferParams::hasClassDefaults() const
2343 DocumentClass const & tclass = documentClass();
2345 return sides == tclass.sides()
2346 && columns == tclass.columns()
2347 && pagestyle == tclass.pagestyle()
2348 && use_default_options
2349 && secnumdepth == tclass.secnumdepth()
2350 && tocdepth == tclass.tocdepth();
2354 DocumentClass const & BufferParams::documentClass() const
2360 DocumentClassConstPtr BufferParams::documentClassPtr() const
2366 void BufferParams::setDocumentClass(DocumentClassConstPtr tc)
2368 // evil, but this function is evil
2369 doc_class_ = const_pointer_cast<DocumentClass>(tc);
2370 invalidateConverterCache();
2374 bool BufferParams::setBaseClass(string const & classname)
2376 LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
2377 LayoutFileList & bcl = LayoutFileList::get();
2378 if (!bcl.haveClass(classname)) {
2380 bformat(_("The layout file:\n"
2382 "could not be found. A default textclass with default\n"
2383 "layouts will be used. LyX will not be able to produce\n"
2385 from_utf8(classname));
2386 frontend::Alert::error(_("Document class not found"), s);
2387 bcl.addEmptyClass(classname);
2390 bool const success = bcl[classname].load();
2393 bformat(_("Due to some error in it, the layout file:\n"
2395 "could not be loaded. A default textclass with default\n"
2396 "layouts will be used. LyX will not be able to produce\n"
2398 from_utf8(classname));
2399 frontend::Alert::error(_("Could not load class"), s);
2400 bcl.addEmptyClass(classname);
2403 pimpl_->baseClass_ = classname;
2404 layout_modules_.adaptToBaseClass(baseClass(), removed_modules_);
2409 LayoutFile const * BufferParams::baseClass() const
2411 if (LayoutFileList::get().haveClass(pimpl_->baseClass_))
2412 return &(LayoutFileList::get()[pimpl_->baseClass_]);
2418 LayoutFileIndex const & BufferParams::baseClassID() const
2420 return pimpl_->baseClass_;
2424 void BufferParams::makeDocumentClass(bool const clone)
2429 invalidateConverterCache();
2430 LayoutModuleList mods;
2431 LayoutModuleList ces;
2432 LayoutModuleList::iterator it = layout_modules_.begin();
2433 LayoutModuleList::iterator en = layout_modules_.end();
2434 for (; it != en; ++it)
2435 mods.push_back(*it);
2437 it = cite_engine_.begin();
2438 en = cite_engine_.end();
2439 for (; it != en; ++it)
2442 doc_class_ = getDocumentClass(*baseClass(), mods, ces, clone);
2444 TextClass::ReturnValues success = TextClass::OK;
2445 if (!forced_local_layout_.empty())
2446 success = doc_class_->read(to_utf8(forced_local_layout_),
2448 if (!local_layout_.empty() &&
2449 (success == TextClass::OK || success == TextClass::OK_OLDFORMAT))
2450 success = doc_class_->read(to_utf8(local_layout_), TextClass::MODULE);
2451 if (success != TextClass::OK && success != TextClass::OK_OLDFORMAT) {
2452 docstring const msg = _("Error reading internal layout information");
2453 frontend::Alert::warning(_("Read Error"), msg);
2458 bool BufferParams::layoutModuleCanBeAdded(string const & modName) const
2460 return layout_modules_.moduleCanBeAdded(modName, baseClass());
2464 bool BufferParams::citationModuleCanBeAdded(string const & modName) const
2466 return cite_engine_.moduleCanBeAdded(modName, baseClass());
2470 docstring BufferParams::getLocalLayout(bool forced) const
2473 return from_utf8(doc_class_->forcedLayouts());
2475 return local_layout_;
2479 void BufferParams::setLocalLayout(docstring const & layout, bool forced)
2482 forced_local_layout_ = layout;
2484 local_layout_ = layout;
2488 bool BufferParams::addLayoutModule(string const & modName)
2490 LayoutModuleList::const_iterator it = layout_modules_.begin();
2491 LayoutModuleList::const_iterator end = layout_modules_.end();
2492 for (; it != end; ++it)
2495 layout_modules_.push_back(modName);
2500 string BufferParams::bufferFormat() const
2502 return documentClass().outputFormat();
2506 bool BufferParams::isExportable(string const & format, bool need_viewable) const
2508 FormatList const & formats = exportableFormats(need_viewable);
2509 FormatList::const_iterator fit = formats.begin();
2510 FormatList::const_iterator end = formats.end();
2511 for (; fit != end ; ++fit) {
2512 if ((*fit)->name() == format)
2519 FormatList const & BufferParams::exportableFormats(bool only_viewable) const
2521 FormatList & cached = only_viewable ?
2522 pimpl_->viewableFormatList : pimpl_->exportableFormatList;
2523 bool & valid = only_viewable ?
2524 pimpl_->isViewCacheValid : pimpl_->isExportCacheValid;
2528 vector<string> const backs = backends();
2529 set<string> excludes;
2530 if (useNonTeXFonts) {
2531 excludes.insert("latex");
2532 excludes.insert("pdflatex");
2535 theConverters().getReachable(backs[0], only_viewable, true, excludes);
2536 for (vector<string>::const_iterator it = backs.begin() + 1;
2537 it != backs.end(); ++it) {
2538 FormatList r = theConverters().getReachable(*it, only_viewable,
2540 result.insert(result.end(), r.begin(), r.end());
2542 sort(result.begin(), result.end(), Format::formatSorter);
2549 vector<string> BufferParams::backends() const
2552 string const buffmt = bufferFormat();
2554 // FIXME: Don't hardcode format names here, but use a flag
2555 if (buffmt == "latex") {
2556 if (encoding().package() == Encoding::japanese)
2557 v.push_back("platex");
2559 if (!useNonTeXFonts) {
2560 v.push_back("pdflatex");
2561 v.push_back("latex");
2563 v.push_back("xetex");
2564 v.push_back("luatex");
2565 v.push_back("dviluatex");
2568 v.push_back(buffmt);
2570 v.push_back("xhtml");
2571 v.push_back("text");
2577 OutputParams::FLAVOR BufferParams::getOutputFlavor(string const & format) const
2579 string const dformat = (format.empty() || format == "default") ?
2580 getDefaultOutputFormat() : format;
2581 DefaultFlavorCache::const_iterator it =
2582 default_flavors_.find(dformat);
2584 if (it != default_flavors_.end())
2587 OutputParams::FLAVOR result = OutputParams::LATEX;
2589 // FIXME It'd be better not to hardcode this, but to do
2590 // something with formats.
2591 if (dformat == "xhtml")
2592 result = OutputParams::HTML;
2593 else if (dformat == "text")
2594 result = OutputParams::TEXT;
2595 else if (dformat == "lyx")
2596 result = OutputParams::LYX;
2597 else if (dformat == "pdflatex")
2598 result = OutputParams::PDFLATEX;
2599 else if (dformat == "xetex")
2600 result = OutputParams::XETEX;
2601 else if (dformat == "luatex")
2602 result = OutputParams::LUATEX;
2603 else if (dformat == "dviluatex")
2604 result = OutputParams::DVILUATEX;
2606 // Try to determine flavor of default output format
2607 vector<string> backs = backends();
2608 if (find(backs.begin(), backs.end(), dformat) == backs.end()) {
2609 // Get shortest path to format
2610 Graph::EdgePath path;
2611 for (vector<string>::const_iterator it = backs.begin();
2612 it != backs.end(); ++it) {
2613 Graph::EdgePath p = theConverters().getPath(*it, dformat);
2614 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2619 result = theConverters().getFlavor(path);
2622 // cache this flavor
2623 default_flavors_[dformat] = result;
2628 string BufferParams::getDefaultOutputFormat() const
2630 if (!default_output_format.empty()
2631 && default_output_format != "default")
2632 return default_output_format;
2634 || encoding().package() == Encoding::japanese) {
2635 FormatList const & formats = exportableFormats(true);
2636 if (formats.empty())
2638 // return the first we find
2639 return formats.front()->name();
2642 return lyxrc.default_otf_view_format;
2643 return lyxrc.default_view_format;
2646 Font const BufferParams::getFont() const
2648 FontInfo f = documentClass().defaultfont();
2649 if (fonts_default_family == "rmdefault")
2650 f.setFamily(ROMAN_FAMILY);
2651 else if (fonts_default_family == "sfdefault")
2652 f.setFamily(SANS_FAMILY);
2653 else if (fonts_default_family == "ttdefault")
2654 f.setFamily(TYPEWRITER_FAMILY);
2655 return Font(f, language);
2659 InsetQuotesParams::QuoteStyle BufferParams::getQuoteStyle(string const & qs) const
2661 return quotesstyletranslator().find(qs);
2665 bool BufferParams::isLatex() const
2667 return documentClass().outputType() == LATEX;
2671 bool BufferParams::isLiterate() const
2673 return documentClass().outputType() == LITERATE;
2677 bool BufferParams::isDocBook() const
2679 return documentClass().outputType() == DOCBOOK;
2683 void BufferParams::readPreamble(Lexer & lex)
2685 if (lex.getString() != "\\begin_preamble")
2686 lyxerr << "Error (BufferParams::readPreamble):"
2687 "consistency check failed." << endl;
2689 preamble = lex.getLongString(from_ascii("\\end_preamble"));
2693 void BufferParams::readLocalLayout(Lexer & lex, bool forced)
2695 string const expected = forced ? "\\begin_forced_local_layout" :
2696 "\\begin_local_layout";
2697 if (lex.getString() != expected)
2698 lyxerr << "Error (BufferParams::readLocalLayout):"
2699 "consistency check failed." << endl;
2702 forced_local_layout_ =
2703 lex.getLongString(from_ascii("\\end_forced_local_layout"));
2705 local_layout_ = lex.getLongString(from_ascii("\\end_local_layout"));
2709 bool BufferParams::setLanguage(string const & lang)
2711 Language const *new_language = languages.getLanguage(lang);
2712 if (!new_language) {
2713 // Language lang was not found
2716 language = new_language;
2721 void BufferParams::readLanguage(Lexer & lex)
2723 if (!lex.next()) return;
2725 string const tmptok = lex.getString();
2727 // check if tmptok is part of tex_babel in tex-defs.h
2728 if (!setLanguage(tmptok)) {
2729 // Language tmptok was not found
2730 language = default_language;
2731 lyxerr << "Warning: Setting language `"
2732 << tmptok << "' to `" << language->lang()
2738 void BufferParams::readGraphicsDriver(Lexer & lex)
2743 string const tmptok = lex.getString();
2744 // check if tmptok is part of tex_graphics in tex_defs.h
2747 string const test = tex_graphics[n++];
2749 if (test == tmptok) {
2750 graphics_driver = tmptok;
2755 "Warning: graphics driver `$$Token' not recognized!\n"
2756 " Setting graphics driver to `default'.\n");
2757 graphics_driver = "default";
2764 void BufferParams::readBullets(Lexer & lex)
2769 int const index = lex.getInteger();
2771 int temp_int = lex.getInteger();
2772 user_defined_bullet(index).setFont(temp_int);
2773 temp_bullet(index).setFont(temp_int);
2775 user_defined_bullet(index).setCharacter(temp_int);
2776 temp_bullet(index).setCharacter(temp_int);
2778 user_defined_bullet(index).setSize(temp_int);
2779 temp_bullet(index).setSize(temp_int);
2783 void BufferParams::readBulletsLaTeX(Lexer & lex)
2785 // The bullet class should be able to read this.
2788 int const index = lex.getInteger();
2790 docstring const temp_str = lex.getDocString();
2792 user_defined_bullet(index).setText(temp_str);
2793 temp_bullet(index).setText(temp_str);
2797 void BufferParams::readModules(Lexer & lex)
2799 if (!lex.eatLine()) {
2800 lyxerr << "Error (BufferParams::readModules):"
2801 "Unexpected end of input." << endl;
2805 string mod = lex.getString();
2806 if (mod == "\\end_modules")
2808 addLayoutModule(mod);
2814 void BufferParams::readRemovedModules(Lexer & lex)
2816 if (!lex.eatLine()) {
2817 lyxerr << "Error (BufferParams::readRemovedModules):"
2818 "Unexpected end of input." << endl;
2822 string mod = lex.getString();
2823 if (mod == "\\end_removed_modules")
2825 removed_modules_.push_back(mod);
2828 // now we want to remove any removed modules that were previously
2829 // added. normally, that will be because default modules were added in
2830 // setBaseClass(), which gets called when \textclass is read at the
2831 // start of the read.
2832 list<string>::const_iterator rit = removed_modules_.begin();
2833 list<string>::const_iterator const ren = removed_modules_.end();
2834 for (; rit != ren; ++rit) {
2835 LayoutModuleList::iterator const mit = layout_modules_.begin();
2836 LayoutModuleList::iterator const men = layout_modules_.end();
2837 LayoutModuleList::iterator found = find(mit, men, *rit);
2840 layout_modules_.erase(found);
2845 void BufferParams::readIncludeonly(Lexer & lex)
2847 if (!lex.eatLine()) {
2848 lyxerr << "Error (BufferParams::readIncludeonly):"
2849 "Unexpected end of input." << endl;
2853 string child = lex.getString();
2854 if (child == "\\end_includeonly")
2856 included_children_.push_back(child);
2862 string BufferParams::paperSizeName(PapersizePurpose purpose) const
2864 switch (papersize) {
2866 // could be anything, so don't guess
2868 case PAPER_CUSTOM: {
2869 if (purpose == XDVI && !paperwidth.empty() &&
2870 !paperheight.empty()) {
2871 // heightxwidth<unit>
2872 string first = paperwidth;
2873 string second = paperheight;
2874 if (orientation == ORIENTATION_LANDSCAPE)
2877 return first.erase(first.length() - 2)
2883 // dvips and dvipdfm do not know this
2884 if (purpose == DVIPS || purpose == DVIPDFM)
2888 if (purpose == DVIPS || purpose == DVIPDFM)
2892 if (purpose == DVIPS || purpose == DVIPDFM)
2902 if (purpose == DVIPS || purpose == DVIPDFM)
2906 if (purpose == DVIPS || purpose == DVIPDFM)
2910 if (purpose == DVIPS || purpose == DVIPDFM)
2914 if (purpose == DVIPS || purpose == DVIPDFM)
2918 if (purpose == DVIPS || purpose == DVIPDFM)
2922 // dvipdfm does not know this
2923 if (purpose == DVIPDFM)
2927 if (purpose == DVIPDFM)
2931 if (purpose == DVIPS || purpose == DVIPDFM)
2935 if (purpose == DVIPS || purpose == DVIPDFM)
2939 if (purpose == DVIPS || purpose == DVIPDFM)
2943 if (purpose == DVIPS || purpose == DVIPDFM)
2947 if (purpose == DVIPS || purpose == DVIPDFM)
2951 if (purpose == DVIPS || purpose == DVIPDFM)
2955 if (purpose == DVIPS || purpose == DVIPDFM)
2959 if (purpose == DVIPS || purpose == DVIPDFM)
2963 if (purpose == DVIPS || purpose == DVIPDFM)
2967 if (purpose == DVIPS || purpose == DVIPDFM)
2971 if (purpose == DVIPS || purpose == DVIPDFM)
2975 if (purpose == DVIPS || purpose == DVIPDFM)
2979 if (purpose == DVIPS || purpose == DVIPDFM)
2983 if (purpose == DVIPS || purpose == DVIPDFM)
2987 if (purpose == DVIPS || purpose == DVIPDFM)
2990 case PAPER_USEXECUTIVE:
2991 // dvipdfm does not know this
2992 if (purpose == DVIPDFM)
2997 case PAPER_USLETTER:
2999 if (purpose == XDVI)
3006 string const BufferParams::dvips_options() const
3010 // If the class loads the geometry package, we do not know which
3011 // paper size is used, since we do not set it (bug 7013).
3012 // Therefore we must not specify any argument here.
3013 // dvips gets the correct paper size via DVI specials in this case
3014 // (if the class uses the geometry package correctly).
3015 if (documentClass().provides("geometry"))
3019 && papersize == PAPER_CUSTOM
3020 && !lyxrc.print_paper_dimension_flag.empty()
3021 && !paperwidth.empty()
3022 && !paperheight.empty()) {
3023 // using a custom papersize
3024 result = lyxrc.print_paper_dimension_flag;
3025 result += ' ' + paperwidth;
3026 result += ',' + paperheight;
3028 string const paper_option = paperSizeName(DVIPS);
3029 if (!paper_option.empty() && (paper_option != "letter" ||
3030 orientation != ORIENTATION_LANDSCAPE)) {
3031 // dvips won't accept -t letter -t landscape.
3032 // In all other cases, include the paper size
3034 result = lyxrc.print_paper_flag;
3035 result += ' ' + paper_option;
3038 if (orientation == ORIENTATION_LANDSCAPE &&
3039 papersize != PAPER_CUSTOM)
3040 result += ' ' + lyxrc.print_landscape_flag;
3045 string const BufferParams::main_font_encoding() const
3047 return font_encodings().empty() ? "default" : font_encodings().back();
3051 vector<string> const BufferParams::font_encodings() const
3053 string doc_fontenc = (fontenc == "global") ? lyxrc.fontenc : fontenc;
3055 vector<string> fontencs;
3057 // "default" means "no explicit font encoding"
3058 if (doc_fontenc != "default") {
3059 fontencs = getVectorFromString(doc_fontenc);
3060 if (!language->fontenc().empty()
3061 && ascii_lowercase(language->fontenc()) != "none") {
3062 vector<string> fencs = getVectorFromString(language->fontenc());
3063 vector<string>::const_iterator fit = fencs.begin();
3064 for (; fit != fencs.end(); ++fit) {
3065 if (find(fontencs.begin(), fontencs.end(), *fit) == fontencs.end())
3066 fontencs.push_back(*fit);
3075 string BufferParams::babelCall(string const & lang_opts, bool const langoptions) const
3077 // suppress the babel call if there is no BabelName defined
3078 // for the document language in the lib/languages file and if no
3079 // other languages are used (lang_opts is then empty)
3080 if (lang_opts.empty())
3082 // either a specific language (AsBabelOptions setting in
3083 // lib/languages) or the prefs require the languages to
3084 // be submitted to babel itself (not the class).
3086 return "\\usepackage[" + lang_opts + "]{babel}";
3087 return "\\usepackage{babel}";
3091 docstring BufferParams::getGraphicsDriver(string const & package) const
3095 if (package == "geometry") {
3096 if (graphics_driver == "dvips"
3097 || graphics_driver == "dvipdfm"
3098 || graphics_driver == "pdftex"
3099 || graphics_driver == "vtex")
3100 result = from_ascii(graphics_driver);
3101 else if (graphics_driver == "dvipdfmx")
3102 result = from_ascii("dvipdfm");
3109 void BufferParams::writeEncodingPreamble(otexstream & os,
3110 LaTeXFeatures & features) const
3112 // XeTeX/LuaTeX: (see also #9740)
3113 // With Unicode fonts we use utf8-plain without encoding package.
3114 // With TeX fonts, we cannot use utf8-plain, but "inputenc" fails.
3115 // XeTeX must use ASCII encoding (see Buffer.cpp),
3116 // for LuaTeX, we load "luainputenc" (see below).
3117 if (useNonTeXFonts || features.runparams().flavor == OutputParams::XETEX)
3120 if (inputenc == "auto") {
3121 string const doc_encoding =
3122 language->encoding()->latexName();
3123 Encoding::Package const package =
3124 language->encoding()->package();
3126 // Create list of inputenc options:
3127 set<string> encodings;
3128 // luainputenc fails with more than one encoding
3129 if (!features.runparams().isFullUnicode()) // if we reach this point, this means LuaTeX with TeX fonts
3130 // list all input encodings used in the document
3131 encodings = features.getEncodingSet(doc_encoding);
3133 // If the "japanese" package (i.e. pLaTeX) is used,
3134 // inputenc must be omitted.
3135 // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
3136 if ((!encodings.empty() || package == Encoding::inputenc)
3137 && !features.isRequired("japanese")
3138 && !features.isProvided("inputenc")) {
3139 os << "\\usepackage[";
3140 set<string>::const_iterator it = encodings.begin();
3141 set<string>::const_iterator const end = encodings.end();
3143 os << from_ascii(*it);
3146 for (; it != end; ++it)
3147 os << ',' << from_ascii(*it);
3148 if (package == Encoding::inputenc) {
3149 if (!encodings.empty())
3151 os << from_ascii(doc_encoding);
3153 if (features.runparams().flavor == OutputParams::LUATEX
3154 || features.runparams().flavor == OutputParams::DVILUATEX)
3155 os << "]{luainputenc}\n";
3157 os << "]{inputenc}\n";
3159 if (package == Encoding::CJK || features.mustProvide("CJK")) {
3160 if (language->encoding()->name() == "utf8-cjk"
3161 && LaTeXFeatures::isAvailable("CJKutf8"))
3162 os << "\\usepackage{CJKutf8}\n";
3164 os << "\\usepackage{CJK}\n";
3166 } else if (inputenc != "default") {
3167 switch (encoding().package()) {
3168 case Encoding::none:
3169 case Encoding::japanese:
3171 case Encoding::inputenc:
3172 // do not load inputenc if japanese is used
3173 // or if the class provides inputenc
3174 if (features.isRequired("japanese")
3175 || features.isProvided("inputenc"))
3177 os << "\\usepackage[" << from_ascii(encoding().latexName());
3178 if (features.runparams().flavor == OutputParams::LUATEX
3179 || features.runparams().flavor == OutputParams::DVILUATEX)
3180 os << "]{luainputenc}\n";
3182 os << "]{inputenc}\n";
3185 if (encoding().name() == "utf8-cjk"
3186 && LaTeXFeatures::isAvailable("CJKutf8"))
3187 os << "\\usepackage{CJKutf8}\n";
3189 os << "\\usepackage{CJK}\n";
3192 // Load the CJK package if needed by a secondary language.
3193 // If the main encoding is some variant of UTF8, use CJKutf8.
3194 if (encoding().package() != Encoding::CJK && features.mustProvide("CJK")) {
3195 if (encoding().iconvName() == "UTF-8"
3196 && LaTeXFeatures::isAvailable("CJKutf8"))
3197 os << "\\usepackage{CJKutf8}\n";
3199 os << "\\usepackage{CJK}\n";
3205 string const BufferParams::parseFontName(string const & name) const
3207 string mangled = name;
3208 size_t const idx = mangled.find('[');
3209 if (idx == string::npos || idx == 0)
3212 return mangled.substr(0, idx - 1);
3216 string const BufferParams::loadFonts(LaTeXFeatures & features) const
3218 if (fontsRoman() == "default" && fontsSans() == "default"
3219 && fontsTypewriter() == "default"
3220 && (fontsMath() == "default" || fontsMath() == "auto"))
3226 /* Fontspec (XeTeX, LuaTeX): we provide GUI support for oldstyle
3227 * numbers (Numbers=OldStyle) and sf/tt scaling. The Ligatures=TeX/
3228 * Mapping=tex-text option assures TeX ligatures (such as "--")
3229 * are resolved. Note that tt does not use these ligatures.
3231 * -- add more GUI options?
3232 * -- add more fonts (fonts for other scripts)
3233 * -- if there's a way to find out if a font really supports
3234 * OldStyle, enable/disable the widget accordingly.
3236 if (useNonTeXFonts && features.isAvailable("fontspec")) {
3237 // "Mapping=tex-text" and "Ligatures=TeX" are equivalent.
3238 // However, until v.2 (2010/07/11) fontspec only knew
3239 // Mapping=tex-text (for XeTeX only); then "Ligatures=TeX"
3240 // was introduced for both XeTeX and LuaTeX (LuaTeX
3241 // didn't understand "Mapping=tex-text", while XeTeX
3242 // understood both. With most recent versions, both
3243 // variants are understood by both engines. However,
3244 // we want to provide support for at least TeXLive 2009
3245 // (for XeTeX; LuaTeX is only supported as of v.2)
3246 string const texmapping =
3247 (features.runparams().flavor == OutputParams::XETEX) ?
3248 "Mapping=tex-text" : "Ligatures=TeX";
3249 if (fontsRoman() != "default") {
3250 os << "\\setmainfont[" << texmapping;
3251 if (fonts_old_figures)
3252 os << ",Numbers=OldStyle";
3253 os << "]{" << parseFontName(fontsRoman()) << "}\n";
3255 if (fontsSans() != "default") {
3256 string const sans = parseFontName(fontsSans());
3257 if (fontsSansScale() != 100)
3258 os << "\\setsansfont[Scale="
3259 << float(fontsSansScale()) / 100
3260 << "," << texmapping << "]{"
3263 os << "\\setsansfont[" << texmapping << "]{"
3266 if (fontsTypewriter() != "default") {
3267 string const mono = parseFontName(fontsTypewriter());
3268 if (fontsTypewriterScale() != 100)
3269 os << "\\setmonofont[Scale="
3270 << float(fontsTypewriterScale()) / 100
3274 os << "\\setmonofont{"
3281 bool const ot1 = (main_font_encoding() == "default" || main_font_encoding() == "OT1");
3282 bool const dryrun = features.runparams().dryrun;
3283 bool const complete = (fontsSans() == "default" && fontsTypewriter() == "default");
3284 bool const nomath = (fontsMath() == "default");
3287 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsRoman())).getLaTeXCode(
3288 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3292 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsSans())).getLaTeXCode(
3293 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3294 nomath, fontsSansScale());
3296 // MONOSPACED/TYPEWRITER
3297 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsTypewriter())).getLaTeXCode(
3298 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3299 nomath, fontsTypewriterScale());
3302 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsMath())).getLaTeXCode(
3303 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3310 Encoding const & BufferParams::encoding() const
3312 // Main encoding for LaTeX output.
3314 // Exception: XeTeX with 8-bit TeX fonts requires ASCII (see #9740).
3315 // As the "flavor" is only known once export started, this
3316 // cannot be handled here. Instead, runparams.encoding is set
3317 // to ASCII in Buffer::makeLaTeXFile (for export)
3318 // and Buffer::writeLaTeXSource (for preview).
3320 return *(encodings.fromLyXName("utf8-plain"));
3321 if (inputenc == "auto" || inputenc == "default")
3322 return *language->encoding();
3323 Encoding const * const enc = encodings.fromLyXName(inputenc);
3326 LYXERR0("Unknown inputenc value `" << inputenc
3327 << "'. Using `auto' instead.");
3328 return *language->encoding();
3332 bool BufferParams::addCiteEngine(string const & engine)
3334 LayoutModuleList::const_iterator it = cite_engine_.begin();
3335 LayoutModuleList::const_iterator en = cite_engine_.end();
3336 for (; it != en; ++it)
3339 cite_engine_.push_back(engine);
3344 bool BufferParams::addCiteEngine(vector<string> const & engine)
3346 vector<string>::const_iterator it = engine.begin();
3347 vector<string>::const_iterator en = engine.end();
3349 for (; it != en; ++it)
3350 if (!addCiteEngine(*it))
3356 string const & BufferParams::defaultBiblioStyle() const
3358 map<string, string> const & bs = documentClass().defaultBiblioStyle();
3359 auto cit = bs.find(theCiteEnginesList.getTypeAsString(citeEngineType()));
3360 if (cit != bs.end())
3363 return empty_string();
3367 bool const & BufferParams::fullAuthorList() const
3369 return documentClass().fullAuthorList();
3373 string BufferParams::getCiteAlias(string const & s) const
3375 vector<string> commands =
3376 documentClass().citeCommands(citeEngineType());
3377 // If it is a real command, don't treat it as an alias
3378 if (find(commands.begin(), commands.end(), s) != commands.end())
3380 map<string,string> aliases = documentClass().citeCommandAliases();
3381 if (aliases.find(s) != aliases.end())
3387 void BufferParams::setCiteEngine(string const & engine)
3390 addCiteEngine(engine);
3394 void BufferParams::setCiteEngine(vector<string> const & engine)
3397 addCiteEngine(engine);
3401 vector<string> BufferParams::citeCommands() const
3403 static CitationStyle const default_style;
3404 vector<string> commands =
3405 documentClass().citeCommands(citeEngineType());
3406 if (commands.empty())
3407 commands.push_back(default_style.name);
3412 vector<CitationStyle> BufferParams::citeStyles() const
3414 static CitationStyle const default_style;
3415 vector<CitationStyle> styles =
3416 documentClass().citeStyles(citeEngineType());
3418 styles.push_back(default_style);
3423 string const BufferParams::bibtexCommand() const
3425 // Return document-specific setting if available
3426 if (bibtex_command != "default")
3427 return bibtex_command;
3429 // If we have "default" in document settings, consult the prefs
3430 // 1. Japanese (uses a specific processor)
3431 if (encoding().package() == Encoding::japanese) {
3432 if (lyxrc.jbibtex_command != "automatic")
3433 // Return the specified program, if "automatic" is not set
3434 return lyxrc.jbibtex_command;
3435 else if (!useBiblatex()) {
3436 // With classic BibTeX, return pbibtex, jbibtex, bibtex
3437 if (lyxrc.jbibtex_alternatives.find("pbibtex") != lyxrc.jbibtex_alternatives.end())
3439 if (lyxrc.jbibtex_alternatives.find("jbibtex") != lyxrc.jbibtex_alternatives.end())
3444 // 2. All other languages
3445 else if (lyxrc.bibtex_command != "automatic")
3446 // Return the specified program, if "automatic" is not set
3447 return lyxrc.bibtex_command;
3449 // 3. Automatic: find the most suitable for the current cite framework
3450 if (useBiblatex()) {
3451 // For Biblatex, we prefer biber (also for Japanese)
3452 // and fall back to bibtex8 and, as last resort, bibtex
3453 if (lyxrc.bibtex_alternatives.find("biber") != lyxrc.bibtex_alternatives.end())
3455 else if (lyxrc.bibtex_alternatives.find("bibtex8") != lyxrc.bibtex_alternatives.end())
3462 bool BufferParams::useBiblatex() const
3464 return theCiteEnginesList[citeEngine().list().front()]
3465 ->getCiteFramework() == "biblatex";
3469 void BufferParams::invalidateConverterCache() const
3471 pimpl_->isExportCacheValid = false;
3472 pimpl_->isViewCacheValid = false;