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_numbering_side = DEFAULT;
389 quotes_style = InsetQuotesParams::EnglishQuotes;
390 dynamic_quotes = false;
391 fontsize = "default";
394 papersize = PAPER_DEFAULT;
395 orientation = ORIENTATION_PORTRAIT;
396 use_geometry = false;
397 biblio_style = "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;
466 // map current author
467 author_map_[pimpl_->authorlist.get(0).bufferId()] = 0;
471 docstring BufferParams::B_(string const & l10n) const
473 LASSERT(language, return from_utf8(l10n));
474 return getMessages(language->code()).get(l10n);
478 BufferParams::Package BufferParams::use_package(std::string const & p) const
480 PackageMap::const_iterator it = use_packages.find(p);
481 if (it == use_packages.end())
487 void BufferParams::use_package(std::string const & p, BufferParams::Package u)
493 map<string, string> const & BufferParams::auto_packages()
495 static map<string, string> packages;
496 if (packages.empty()) {
497 // We could have a race condition here that two threads
498 // discover an empty map at the same time and want to fill
499 // it, but that is no problem, since the same contents is
500 // filled in twice then. Having the locker inside the
501 // packages.empty() condition has the advantage that we
502 // don't need the mutex overhead for simple reading.
504 Mutex::Locker locker(&mutex);
505 // adding a package here implies a file format change!
506 packages["amsmath"] =
507 N_("The LaTeX package amsmath is only used if AMS formula types or symbols from the AMS math toolbars are inserted into formulas");
508 packages["amssymb"] =
509 N_("The LaTeX package amssymb is only used if symbols from the AMS math toolbars are inserted into formulas");
511 N_("The LaTeX package cancel is only used if \\cancel commands are used in formulas");
513 N_("The LaTeX package esint is only used if special integral symbols are inserted into formulas");
514 packages["mathdots"] =
515 N_("The LaTeX package mathdots is only used if the command \\iddots is inserted into formulas");
516 packages["mathtools"] =
517 N_("The LaTeX package mathtools is only used if some mathematical relations are inserted into formulas");
519 N_("The LaTeX package mhchem is only used if either the command \\ce or \\cf is inserted into formulas");
520 packages["stackrel"] =
521 N_("The LaTeX package stackrel is only used if the command \\stackrel with subscript is inserted into formulas");
522 packages["stmaryrd"] =
523 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");
524 packages["undertilde"] =
525 N_("The LaTeX package undertilde is only used if you use the math frame decoration 'utilde'");
531 bool BufferParams::useBibtopic() const
535 return (use_bibtopic || (!multibib.empty() && multibib != "child"));
539 AuthorList & BufferParams::authors()
541 return pimpl_->authorlist;
545 AuthorList const & BufferParams::authors() const
547 return pimpl_->authorlist;
551 void BufferParams::addAuthor(Author a)
553 author_map_[a.bufferId()] = pimpl_->authorlist.record(a);
557 BranchList & BufferParams::branchlist()
559 return pimpl_->branchlist;
563 BranchList const & BufferParams::branchlist() const
565 return pimpl_->branchlist;
569 IndicesList & BufferParams::indiceslist()
571 return pimpl_->indiceslist;
575 IndicesList const & BufferParams::indiceslist() const
577 return pimpl_->indiceslist;
581 Bullet & BufferParams::temp_bullet(lyx::size_type const index)
583 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
584 return pimpl_->temp_bullets[index];
588 Bullet const & BufferParams::temp_bullet(lyx::size_type const index) const
590 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
591 return pimpl_->temp_bullets[index];
595 Bullet & BufferParams::user_defined_bullet(lyx::size_type const index)
597 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
598 return pimpl_->user_defined_bullets[index];
602 Bullet const & BufferParams::user_defined_bullet(lyx::size_type const index) const
604 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
605 return pimpl_->user_defined_bullets[index];
609 Spacing & BufferParams::spacing()
611 return pimpl_->spacing;
615 Spacing const & BufferParams::spacing() const
617 return pimpl_->spacing;
621 PDFOptions & BufferParams::pdfoptions()
623 return pimpl_->pdfoptions;
627 PDFOptions const & BufferParams::pdfoptions() const
629 return pimpl_->pdfoptions;
633 Length const & BufferParams::getMathIndent() const
635 return pimpl_->mathindent;
639 void BufferParams::setMathIndent(Length const & indent)
641 pimpl_->mathindent = indent;
645 Length const & BufferParams::getParIndent() const
647 return pimpl_->parindent;
651 void BufferParams::setParIndent(Length const & indent)
653 pimpl_->parindent = indent;
657 VSpace const & BufferParams::getDefSkip() const
659 return pimpl_->defskip;
663 void BufferParams::setDefSkip(VSpace const & vs)
665 // DEFSKIP will cause an infinite loop
666 LASSERT(vs.kind() != VSpace::DEFSKIP, return);
667 pimpl_->defskip = vs;
671 BufferParams::MathNumber BufferParams::getMathNumber() const
673 if (math_numbering_side != DEFAULT)
674 return math_numbering_side;
675 // FIXME: do not hardcode language here
676 else if (language->lang() == "arabic_arabi"
677 || documentClass().provides("leqno"))
684 string BufferParams::readToken(Lexer & lex, string const & token,
685 FileName const & filepath)
689 if (token == "\\textclass") {
691 string const classname = lex.getString();
692 // if there exists a local layout file, ignore the system one
693 // NOTE: in this case, the textclass (.cls file) is assumed to
696 LayoutFileList & bcl = LayoutFileList::get();
697 if (!filepath.empty()) {
698 // If classname is an absolute path, the document is
699 // using a local layout file which could not be accessed
700 // by a relative path. In this case the path is correct
701 // even if the document was moved to a different
702 // location. However, we will have a problem if the
703 // document was generated on a different platform.
704 bool isabsolute = FileName::isAbsolute(classname);
705 string const classpath = onlyPath(classname);
706 string const path = isabsolute ? classpath
707 : FileName(addPath(filepath.absFileName(),
708 classpath)).realPath();
709 string const oldpath = isabsolute ? string()
710 : FileName(addPath(origin, classpath)).realPath();
711 tcp = bcl.addLocalLayout(onlyFileName(classname), path, oldpath);
713 // that returns non-empty if a "local" layout file is found.
715 result = to_utf8(makeRelPath(from_utf8(onlyPath(tcp)),
716 from_utf8(filepath.absFileName())));
719 setBaseClass(onlyFileName(tcp));
721 setBaseClass(onlyFileName(classname));
722 // We assume that a tex class exists for local or unknown
723 // layouts so this warning, will only be given for system layouts.
724 if (!baseClass()->isTeXClassAvailable()) {
725 docstring const desc =
726 translateIfPossible(from_utf8(baseClass()->description()));
727 docstring const prereqs =
728 from_utf8(baseClass()->prerequisites());
729 docstring const msg =
730 bformat(_("The selected document class\n"
732 "requires external files that are not available.\n"
733 "The document class can still be used, but the\n"
734 "document cannot be compiled until the following\n"
735 "prerequisites are installed:\n"
737 "See section 3.1.2.2 (Class Availability) of the\n"
738 "User's Guide for more information."), desc, prereqs);
739 frontend::Alert::warning(_("Document class not available"),
742 } else if (token == "\\save_transient_properties") {
743 lex >> save_transient_properties;
744 } else if (token == "\\origin") {
746 origin = lex.getString();
747 string const sysdirprefix = "/systemlyxdir/";
748 if (prefixIs(origin, sysdirprefix)) {
750 if (inSystemDir(filepath, docsys))
751 origin.replace(0, sysdirprefix.length() - 1, docsys);
753 origin.replace(0, sysdirprefix.length() - 1,
754 package().system_support().absFileName());
756 } else if (token == "\\begin_preamble") {
758 } else if (token == "\\begin_local_layout") {
759 readLocalLayout(lex, false);
760 } else if (token == "\\begin_forced_local_layout") {
761 readLocalLayout(lex, true);
762 } else if (token == "\\begin_modules") {
764 } else if (token == "\\begin_removed_modules") {
765 readRemovedModules(lex);
766 } else if (token == "\\begin_includeonly") {
767 readIncludeonly(lex);
768 } else if (token == "\\maintain_unincluded_children") {
769 lex >> maintain_unincluded_children;
770 } else if (token == "\\options") {
772 options = lex.getString();
773 } else if (token == "\\use_default_options") {
774 lex >> use_default_options;
775 } else if (token == "\\master") {
777 master = lex.getString();
778 if (!filepath.empty() && FileName::isAbsolute(origin)) {
779 bool const isabs = FileName::isAbsolute(master);
780 FileName const abspath(isabs ? master : origin + master);
781 bool const moved = filepath != FileName(origin);
782 if (moved && abspath.exists()) {
783 docstring const path = isabs
785 : from_utf8(abspath.realPath());
786 docstring const refpath =
787 from_utf8(filepath.absFileName());
788 master = to_utf8(makeRelPath(path, refpath));
791 } else if (token == "\\suppress_date") {
792 lex >> suppress_date;
793 } else if (token == "\\justification") {
794 lex >> justification;
795 } else if (token == "\\language") {
797 } else if (token == "\\language_package") {
799 lang_package = lex.getString();
800 } else if (token == "\\inputencoding") {
802 } else if (token == "\\graphics") {
803 readGraphicsDriver(lex);
804 } else if (token == "\\default_output_format") {
805 lex >> default_output_format;
806 } else if (token == "\\bibtex_command") {
808 bibtex_command = lex.getString();
809 } else if (token == "\\index_command") {
811 index_command = lex.getString();
812 } else if (token == "\\fontencoding") {
814 fontenc = lex.getString();
815 } else if (token == "\\font_roman") {
816 lex >> fonts_roman[0];
817 lex >> fonts_roman[1];
818 } else if (token == "\\font_sans") {
819 lex >> fonts_sans[0];
820 lex >> fonts_sans[1];
821 } else if (token == "\\font_typewriter") {
822 lex >> fonts_typewriter[0];
823 lex >> fonts_typewriter[1];
824 } else if (token == "\\font_math") {
825 lex >> fonts_math[0];
826 lex >> fonts_math[1];
827 } else if (token == "\\font_default_family") {
828 lex >> fonts_default_family;
829 } else if (token == "\\use_non_tex_fonts") {
830 lex >> useNonTeXFonts;
831 } else if (token == "\\font_sc") {
832 lex >> fonts_expert_sc;
833 } else if (token == "\\font_osf") {
834 lex >> fonts_old_figures;
835 } else if (token == "\\font_sf_scale") {
836 lex >> fonts_sans_scale[0];
837 lex >> fonts_sans_scale[1];
838 } else if (token == "\\font_tt_scale") {
839 lex >> fonts_typewriter_scale[0];
840 lex >> fonts_typewriter_scale[1];
841 } else if (token == "\\font_cjk") {
843 } else if (token == "\\use_microtype") {
844 lex >> use_microtype;
845 } else if (token == "\\use_dash_ligatures") {
846 lex >> use_dash_ligatures;
847 } else if (token == "\\paragraph_separation") {
850 paragraph_separation = parseptranslator().find(parsep);
851 } else if (token == "\\paragraph_indentation") {
853 string parindent = lex.getString();
854 if (parindent == "default")
855 pimpl_->parindent = Length();
857 pimpl_->parindent = Length(parindent);
858 } else if (token == "\\defskip") {
860 string const defskip = lex.getString();
861 pimpl_->defskip = VSpace(defskip);
862 if (pimpl_->defskip.kind() == VSpace::DEFSKIP)
864 pimpl_->defskip = VSpace(VSpace::MEDSKIP);
865 } else if (token == "\\is_math_indent") {
866 lex >> is_math_indent;
867 } else if (token == "\\math_indentation") {
869 string mathindent = lex.getString();
870 if (mathindent == "default")
871 pimpl_->mathindent = Length();
873 pimpl_->mathindent = Length(mathindent);
874 } else if (token == "\\math_numbering_side") {
878 math_numbering_side = LEFT;
879 else if (tmp == "right")
880 math_numbering_side = RIGHT;
882 math_numbering_side = DEFAULT;
883 } else if (token == "\\quotes_style") {
886 quotes_style = quotesstyletranslator().find(qstyle);
887 } else if (token == "\\dynamic_quotes") {
888 lex >> dynamic_quotes;
889 } else if (token == "\\papersize") {
892 papersize = papersizetranslator().find(ppsize);
893 } else if (token == "\\use_geometry") {
895 } else if (token == "\\use_package") {
900 use_package(package, packagetranslator().find(use));
901 } else if (token == "\\cite_engine") {
903 vector<string> engine = getVectorFromString(lex.getString());
904 setCiteEngine(engine);
905 } else if (token == "\\cite_engine_type") {
908 cite_engine_type_ = theCiteEnginesList.getType(engine_type);
909 } else if (token == "\\biblio_style") {
911 biblio_style = lex.getString();
912 } else if (token == "\\biblio_options") {
914 biblio_opts = trim(lex.getString());
915 } else if (token == "\\biblatex_bibstyle") {
917 biblatex_bibstyle = trim(lex.getString());
918 } else if (token == "\\biblatex_citestyle") {
920 biblatex_citestyle = trim(lex.getString());
921 } else if (token == "\\use_bibtopic") {
923 } else if (token == "\\multibib") {
925 } else if (token == "\\use_indices") {
927 } else if (token == "\\tracking_changes") {
928 lex >> track_changes;
929 } else if (token == "\\output_changes") {
930 lex >> output_changes;
931 } else if (token == "\\branch") {
933 docstring branch = lex.getDocString();
934 branchlist().add(branch);
937 string const tok = lex.getString();
938 if (tok == "\\end_branch")
940 Branch * branch_ptr = branchlist().find(branch);
941 if (tok == "\\selected") {
944 branch_ptr->setSelected(lex.getInteger());
946 if (tok == "\\filename_suffix") {
949 branch_ptr->setFileNameSuffix(lex.getInteger());
951 if (tok == "\\color") {
953 string color = lex.getString();
955 branch_ptr->setColor(color);
956 // Update also the Color table:
958 color = lcolor.getX11Name(Color_background);
960 lcolor.setColor(to_utf8(branch), color);
963 } else if (token == "\\index") {
965 docstring index = lex.getDocString();
967 indiceslist().add(index);
970 string const tok = lex.getString();
971 if (tok == "\\end_index")
973 Index * index_ptr = indiceslist().find(index);
974 if (tok == "\\shortcut") {
976 shortcut = lex.getDocString();
978 index_ptr->setShortcut(shortcut);
980 if (tok == "\\color") {
982 string color = lex.getString();
984 index_ptr->setColor(color);
985 // Update also the Color table:
987 color = lcolor.getX11Name(Color_background);
989 if (!shortcut.empty())
990 lcolor.setColor(to_utf8(shortcut), color);
993 } else if (token == "\\author") {
995 istringstream ss(lex.getString());
999 } else if (token == "\\paperorientation") {
1002 orientation = paperorientationtranslator().find(orient);
1003 } else if (token == "\\backgroundcolor") {
1005 backgroundcolor = lyx::rgbFromHexName(lex.getString());
1006 isbackgroundcolor = true;
1007 } else if (token == "\\fontcolor") {
1009 fontcolor = lyx::rgbFromHexName(lex.getString());
1011 } else if (token == "\\notefontcolor") {
1013 string color = lex.getString();
1014 notefontcolor = lyx::rgbFromHexName(color);
1015 lcolor.setColor("notefontcolor", color);
1016 } else if (token == "\\boxbgcolor") {
1018 string color = lex.getString();
1019 boxbgcolor = lyx::rgbFromHexName(color);
1020 lcolor.setColor("boxbgcolor", color);
1021 } else if (token == "\\paperwidth") {
1023 } else if (token == "\\paperheight") {
1025 } else if (token == "\\leftmargin") {
1027 } else if (token == "\\topmargin") {
1029 } else if (token == "\\rightmargin") {
1031 } else if (token == "\\bottommargin") {
1032 lex >> bottommargin;
1033 } else if (token == "\\headheight") {
1035 } else if (token == "\\headsep") {
1037 } else if (token == "\\footskip") {
1039 } else if (token == "\\columnsep") {
1041 } else if (token == "\\paperfontsize") {
1043 } else if (token == "\\papercolumns") {
1045 } else if (token == "\\listings_params") {
1048 listings_params = InsetListingsParams(par).params();
1049 } else if (token == "\\papersides") {
1052 sides = sidestranslator().find(psides);
1053 } else if (token == "\\paperpagestyle") {
1055 } else if (token == "\\bullet") {
1057 } else if (token == "\\bulletLaTeX") {
1058 readBulletsLaTeX(lex);
1059 } else if (token == "\\secnumdepth") {
1061 } else if (token == "\\tocdepth") {
1063 } else if (token == "\\spacing") {
1067 if (nspacing == "other") {
1070 spacing().set(spacetranslator().find(nspacing), tmp_val);
1071 } else if (token == "\\float_placement") {
1072 lex >> float_placement;
1074 } else if (prefixIs(token, "\\pdf_") || token == "\\use_hyperref") {
1075 string toktmp = pdfoptions().readToken(lex, token);
1076 if (!toktmp.empty()) {
1077 lyxerr << "PDFOptions::readToken(): Unknown token: " <<
1081 } else if (token == "\\html_math_output") {
1084 html_math_output = static_cast<MathOutput>(temp);
1085 } else if (token == "\\html_be_strict") {
1086 lex >> html_be_strict;
1087 } else if (token == "\\html_css_as_file") {
1088 lex >> html_css_as_file;
1089 } else if (token == "\\html_math_img_scale") {
1090 lex >> html_math_img_scale;
1091 } else if (token == "\\html_latex_start") {
1093 html_latex_start = lex.getString();
1094 } else if (token == "\\html_latex_end") {
1096 html_latex_end = lex.getString();
1097 } else if (token == "\\output_sync") {
1099 } else if (token == "\\output_sync_macro") {
1100 lex >> output_sync_macro;
1101 } else if (token == "\\use_refstyle") {
1102 lex >> use_refstyle;
1103 } else if (token == "\\use_minted") {
1106 lyxerr << "BufferParams::readToken(): Unknown token: " <<
1116 // Quote argument if it contains spaces
1117 string quoteIfNeeded(string const & str) {
1118 if (contains(str, ' '))
1119 return "\"" + str + "\"";
1125 void BufferParams::writeFile(ostream & os, Buffer const * buf) const
1127 // The top of the file is written by the buffer.
1128 // Prints out the buffer info into the .lyx file given by file
1130 os << "\\save_transient_properties "
1131 << convert<string>(save_transient_properties) << '\n';
1133 // the document directory (must end with a path separator)
1134 // realPath() is used to resolve symlinks, while addPath(..., "")
1135 // ensures a trailing path separator.
1137 string filepath = addPath(buf->fileName().onlyPath().realPath(), "");
1138 string const sysdir = inSystemDir(FileName(filepath), docsys) ? docsys
1139 : addPath(package().system_support().realPath(), "");
1140 string const relpath =
1141 to_utf8(makeRelPath(from_utf8(filepath), from_utf8(sysdir)));
1142 if (!prefixIs(relpath, "../") && !FileName::isAbsolute(relpath))
1143 filepath = addPath("/systemlyxdir", relpath);
1144 else if (!save_transient_properties || !lyxrc.save_origin)
1145 filepath = "unavailable";
1146 os << "\\origin " << quoteIfNeeded(filepath) << '\n';
1149 os << "\\textclass "
1150 << quoteIfNeeded(buf->includedFilePath(addName(buf->layoutPos(),
1151 baseClass()->name()), "layout"))
1154 // then the preamble
1155 if (!preamble.empty()) {
1156 // remove '\n' from the end of preamble
1157 docstring const tmppreamble = rtrim(preamble, "\n");
1158 os << "\\begin_preamble\n"
1159 << to_utf8(tmppreamble)
1160 << "\n\\end_preamble\n";
1164 if (!options.empty()) {
1165 os << "\\options " << options << '\n';
1168 // use the class options defined in the layout?
1169 os << "\\use_default_options "
1170 << convert<string>(use_default_options) << "\n";
1172 // the master document
1173 if (!master.empty()) {
1174 os << "\\master " << master << '\n';
1178 if (!removed_modules_.empty()) {
1179 os << "\\begin_removed_modules" << '\n';
1180 list<string>::const_iterator it = removed_modules_.begin();
1181 list<string>::const_iterator en = removed_modules_.end();
1182 for (; it != en; ++it)
1184 os << "\\end_removed_modules" << '\n';
1188 if (!layout_modules_.empty()) {
1189 os << "\\begin_modules" << '\n';
1190 LayoutModuleList::const_iterator it = layout_modules_.begin();
1191 LayoutModuleList::const_iterator en = layout_modules_.end();
1192 for (; it != en; ++it)
1194 os << "\\end_modules" << '\n';
1198 if (!included_children_.empty()) {
1199 os << "\\begin_includeonly" << '\n';
1200 list<string>::const_iterator it = included_children_.begin();
1201 list<string>::const_iterator en = included_children_.end();
1202 for (; it != en; ++it)
1204 os << "\\end_includeonly" << '\n';
1206 os << "\\maintain_unincluded_children "
1207 << convert<string>(maintain_unincluded_children) << '\n';
1209 // local layout information
1210 docstring const local_layout = getLocalLayout(false);
1211 if (!local_layout.empty()) {
1212 // remove '\n' from the end
1213 docstring const tmplocal = rtrim(local_layout, "\n");
1214 os << "\\begin_local_layout\n"
1215 << to_utf8(tmplocal)
1216 << "\n\\end_local_layout\n";
1218 docstring const forced_local_layout = getLocalLayout(true);
1219 if (!forced_local_layout.empty()) {
1220 // remove '\n' from the end
1221 docstring const tmplocal = rtrim(forced_local_layout, "\n");
1222 os << "\\begin_forced_local_layout\n"
1223 << to_utf8(tmplocal)
1224 << "\n\\end_forced_local_layout\n";
1227 // then the text parameters
1228 if (language != ignore_language)
1229 os << "\\language " << language->lang() << '\n';
1230 os << "\\language_package " << lang_package
1231 << "\n\\inputencoding " << inputenc
1232 << "\n\\fontencoding " << fontenc
1233 << "\n\\font_roman \"" << fonts_roman[0]
1234 << "\" \"" << fonts_roman[1] << '"'
1235 << "\n\\font_sans \"" << fonts_sans[0]
1236 << "\" \"" << fonts_sans[1] << '"'
1237 << "\n\\font_typewriter \"" << fonts_typewriter[0]
1238 << "\" \"" << fonts_typewriter[1] << '"'
1239 << "\n\\font_math \"" << fonts_math[0]
1240 << "\" \"" << fonts_math[1] << '"'
1241 << "\n\\font_default_family " << fonts_default_family
1242 << "\n\\use_non_tex_fonts " << convert<string>(useNonTeXFonts)
1243 << "\n\\font_sc " << convert<string>(fonts_expert_sc)
1244 << "\n\\font_osf " << convert<string>(fonts_old_figures)
1245 << "\n\\font_sf_scale " << fonts_sans_scale[0]
1246 << ' ' << fonts_sans_scale[1]
1247 << "\n\\font_tt_scale " << fonts_typewriter_scale[0]
1248 << ' ' << fonts_typewriter_scale[1]
1250 if (!fonts_cjk.empty()) {
1251 os << "\\font_cjk " << fonts_cjk << '\n';
1253 os << "\\use_microtype " << convert<string>(use_microtype) << '\n';
1254 os << "\\use_dash_ligatures " << convert<string>(use_dash_ligatures) << '\n';
1255 os << "\\graphics " << graphics_driver << '\n';
1256 os << "\\default_output_format " << default_output_format << '\n';
1257 os << "\\output_sync " << output_sync << '\n';
1258 if (!output_sync_macro.empty())
1259 os << "\\output_sync_macro \"" << output_sync_macro << "\"\n";
1260 os << "\\bibtex_command " << bibtex_command << '\n';
1261 os << "\\index_command " << index_command << '\n';
1263 if (!float_placement.empty()) {
1264 os << "\\float_placement " << float_placement << '\n';
1266 os << "\\paperfontsize " << fontsize << '\n';
1268 spacing().writeFile(os);
1269 pdfoptions().writeFile(os);
1271 os << "\\papersize " << string_papersize[papersize]
1272 << "\n\\use_geometry " << convert<string>(use_geometry);
1273 map<string, string> const & packages = auto_packages();
1274 for (map<string, string>::const_iterator it = packages.begin();
1275 it != packages.end(); ++it)
1276 os << "\n\\use_package " << it->first << ' '
1277 << use_package(it->first);
1279 os << "\n\\cite_engine ";
1281 if (!cite_engine_.empty()) {
1282 LayoutModuleList::const_iterator be = cite_engine_.begin();
1283 LayoutModuleList::const_iterator en = cite_engine_.end();
1284 for (LayoutModuleList::const_iterator it = be; it != en; ++it) {
1293 os << "\n\\cite_engine_type " << theCiteEnginesList.getTypeAsString(cite_engine_type_);
1295 if (!biblio_style.empty())
1296 os << "\n\\biblio_style " << biblio_style;
1297 if (!biblio_opts.empty())
1298 os << "\n\\biblio_options " << biblio_opts;
1299 if (!biblatex_bibstyle.empty())
1300 os << "\n\\biblatex_bibstyle " << biblatex_bibstyle;
1301 if (!biblatex_citestyle.empty())
1302 os << "\n\\biblatex_citestyle " << biblatex_citestyle;
1303 if (!multibib.empty())
1304 os << "\n\\multibib " << multibib;
1306 os << "\n\\use_bibtopic " << convert<string>(use_bibtopic)
1307 << "\n\\use_indices " << convert<string>(use_indices)
1308 << "\n\\paperorientation " << string_orientation[orientation]
1309 << "\n\\suppress_date " << convert<string>(suppress_date)
1310 << "\n\\justification " << convert<string>(justification)
1311 << "\n\\use_refstyle " << use_refstyle
1312 << "\n\\use_minted " << use_minted
1314 if (isbackgroundcolor == true)
1315 os << "\\backgroundcolor " << lyx::X11hexname(backgroundcolor) << '\n';
1316 if (isfontcolor == true)
1317 os << "\\fontcolor " << lyx::X11hexname(fontcolor) << '\n';
1318 if (notefontcolor != lyx::rgbFromHexName("#cccccc"))
1319 os << "\\notefontcolor " << lyx::X11hexname(notefontcolor) << '\n';
1320 if (boxbgcolor != lyx::rgbFromHexName("#ff0000"))
1321 os << "\\boxbgcolor " << lyx::X11hexname(boxbgcolor) << '\n';
1323 BranchList::const_iterator it = branchlist().begin();
1324 BranchList::const_iterator end = branchlist().end();
1325 for (; it != end; ++it) {
1326 os << "\\branch " << to_utf8(it->branch())
1327 << "\n\\selected " << it->isSelected()
1328 << "\n\\filename_suffix " << it->hasFileNameSuffix()
1329 << "\n\\color " << lyx::X11hexname(it->color())
1334 IndicesList::const_iterator iit = indiceslist().begin();
1335 IndicesList::const_iterator iend = indiceslist().end();
1336 for (; iit != iend; ++iit) {
1337 os << "\\index " << to_utf8(iit->index())
1338 << "\n\\shortcut " << to_utf8(iit->shortcut())
1339 << "\n\\color " << lyx::X11hexname(iit->color())
1344 if (!paperwidth.empty())
1345 os << "\\paperwidth "
1346 << VSpace(paperwidth).asLyXCommand() << '\n';
1347 if (!paperheight.empty())
1348 os << "\\paperheight "
1349 << VSpace(paperheight).asLyXCommand() << '\n';
1350 if (!leftmargin.empty())
1351 os << "\\leftmargin "
1352 << VSpace(leftmargin).asLyXCommand() << '\n';
1353 if (!topmargin.empty())
1354 os << "\\topmargin "
1355 << VSpace(topmargin).asLyXCommand() << '\n';
1356 if (!rightmargin.empty())
1357 os << "\\rightmargin "
1358 << VSpace(rightmargin).asLyXCommand() << '\n';
1359 if (!bottommargin.empty())
1360 os << "\\bottommargin "
1361 << VSpace(bottommargin).asLyXCommand() << '\n';
1362 if (!headheight.empty())
1363 os << "\\headheight "
1364 << VSpace(headheight).asLyXCommand() << '\n';
1365 if (!headsep.empty())
1367 << VSpace(headsep).asLyXCommand() << '\n';
1368 if (!footskip.empty())
1370 << VSpace(footskip).asLyXCommand() << '\n';
1371 if (!columnsep.empty())
1372 os << "\\columnsep "
1373 << VSpace(columnsep).asLyXCommand() << '\n';
1374 os << "\\secnumdepth " << secnumdepth
1375 << "\n\\tocdepth " << tocdepth
1376 << "\n\\paragraph_separation "
1377 << string_paragraph_separation[paragraph_separation];
1378 if (!paragraph_separation)
1379 os << "\n\\paragraph_indentation "
1380 << (getParIndent().empty() ? "default" : getParIndent().asString());
1382 os << "\n\\defskip " << getDefSkip().asLyXCommand();
1383 os << "\n\\is_math_indent " << is_math_indent;
1385 os << "\n\\math_indentation "
1386 << (getMathIndent().empty() ? "default" : getMathIndent().asString());
1387 os << "\n\\math_numbering_side ";
1388 switch(math_numbering_side) {
1398 os << "\n\\quotes_style "
1399 << string_quotes_style[quotes_style]
1400 << "\n\\dynamic_quotes " << dynamic_quotes
1401 << "\n\\papercolumns " << columns
1402 << "\n\\papersides " << sides
1403 << "\n\\paperpagestyle " << pagestyle << '\n';
1404 if (!listings_params.empty())
1405 os << "\\listings_params \"" <<
1406 InsetListingsParams(listings_params).encodedString() << "\"\n";
1407 for (int i = 0; i < 4; ++i) {
1408 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1409 if (user_defined_bullet(i).getFont() != -1) {
1410 os << "\\bullet " << i << " "
1411 << user_defined_bullet(i).getFont() << " "
1412 << user_defined_bullet(i).getCharacter() << " "
1413 << user_defined_bullet(i).getSize() << "\n";
1417 os << "\\bulletLaTeX " << i << " \""
1418 << lyx::to_ascii(user_defined_bullet(i).getText())
1424 os << "\\tracking_changes "
1425 << (save_transient_properties ? convert<string>(track_changes) : "false")
1428 os << "\\output_changes "
1429 << (save_transient_properties ? convert<string>(output_changes) : "false")
1432 os << "\\html_math_output " << html_math_output << '\n'
1433 << "\\html_css_as_file " << html_css_as_file << '\n'
1434 << "\\html_be_strict " << convert<string>(html_be_strict) << '\n';
1436 if (html_math_img_scale != 1.0)
1437 os << "\\html_math_img_scale " << convert<string>(html_math_img_scale) << '\n';
1438 if (!html_latex_start.empty())
1439 os << "\\html_latex_start " << html_latex_start << '\n';
1440 if (!html_latex_end.empty())
1441 os << "\\html_latex_end " << html_latex_end << '\n';
1443 os << pimpl_->authorlist;
1447 void BufferParams::validate(LaTeXFeatures & features) const
1449 features.require(documentClass().requires());
1451 if (columns > 1 && language->rightToLeft())
1452 features.require("rtloutputdblcol");
1454 if (output_changes) {
1455 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1456 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1457 LaTeXFeatures::isAvailable("xcolor");
1459 switch (features.runparams().flavor) {
1460 case OutputParams::LATEX:
1461 case OutputParams::DVILUATEX:
1463 features.require("ct-dvipost");
1464 features.require("dvipost");
1465 } else if (xcolorulem) {
1466 features.require("ct-xcolor-ulem");
1467 features.require("ulem");
1468 features.require("xcolor");
1470 features.require("ct-none");
1473 case OutputParams::LUATEX:
1474 case OutputParams::PDFLATEX:
1475 case OutputParams::XETEX:
1477 features.require("ct-xcolor-ulem");
1478 features.require("ulem");
1479 features.require("xcolor");
1480 // improves color handling in PDF output
1481 features.require("pdfcolmk");
1483 features.require("ct-none");
1491 // Floats with 'Here definitely' as default setting.
1492 if (float_placement.find('H') != string::npos)
1493 features.require("float");
1495 for (PackageMap::const_iterator it = use_packages.begin();
1496 it != use_packages.end(); ++it) {
1497 if (it->first == "amsmath") {
1498 // AMS Style is at document level
1499 if (it->second == package_on ||
1500 features.isProvided("amsmath"))
1501 features.require(it->first);
1502 } else if (it->second == package_on)
1503 features.require(it->first);
1506 // Document-level line spacing
1507 if (spacing().getSpace() != Spacing::Single && !spacing().isDefault())
1508 features.require("setspace");
1510 // the bullet shapes are buffer level not paragraph level
1511 // so they are tested here
1512 for (int i = 0; i < 4; ++i) {
1513 if (user_defined_bullet(i) == ITEMIZE_DEFAULTS[i])
1515 int const font = user_defined_bullet(i).getFont();
1517 int const c = user_defined_bullet(i).getCharacter();
1523 features.require("latexsym");
1525 } else if (font == 1) {
1526 features.require("amssymb");
1527 } else if (font >= 2 && font <= 5) {
1528 features.require("pifont");
1532 if (pdfoptions().use_hyperref) {
1533 features.require("hyperref");
1534 // due to interferences with babel and hyperref, the color package has to
1535 // be loaded after hyperref when hyperref is used with the colorlinks
1536 // option, see http://www.lyx.org/trac/ticket/5291
1537 if (pdfoptions().colorlinks)
1538 features.require("color");
1540 if (!listings_params.empty()) {
1541 // do not test validity because listings_params is
1542 // supposed to be valid
1544 InsetListingsParams(listings_params).separatedParams(true);
1545 // we can't support all packages, but we should load the color package
1546 if (par.find("\\color", 0) != string::npos)
1547 features.require("color");
1550 // some languages are only available via polyglossia
1551 if (features.hasPolyglossiaExclusiveLanguages())
1552 features.require("polyglossia");
1554 if (useNonTeXFonts && fontsMath() != "auto")
1555 features.require("unicode-math");
1558 features.require("microtype");
1560 if (!language->requires().empty())
1561 features.require(language->requires());
1565 bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
1566 FileName const & filepath) const
1568 // http://www.tug.org/texmf-dist/doc/latex/base/fixltx2e.pdf
1569 // !! To use the Fix-cm package, load it before \documentclass, and use the command
1570 // \RequirePackage to do so, rather than the normal \usepackage
1571 // Do not try to load any other package before the document class, unless you
1572 // have a thorough understanding of the LATEX internals and know exactly what you
1574 if (features.mustProvide("fix-cm"))
1575 os << "\\RequirePackage{fix-cm}\n";
1576 // Likewise for fixltx2e. If other packages conflict with this policy,
1577 // treat it as a package bug (and report it!)
1578 // See http://www.latex-project.org/cgi-bin/ltxbugs2html?pr=latex/4407
1579 if (features.mustProvide("fixltx2e"))
1580 os << "\\RequirePackage{fixltx2e}\n";
1582 os << "\\documentclass";
1584 DocumentClass const & tclass = documentClass();
1586 ostringstream clsoptions; // the document class options.
1588 if (tokenPos(tclass.opt_fontsize(),
1589 '|', fontsize) >= 0) {
1590 // only write if existing in list (and not default)
1591 clsoptions << fontsize << "pt,";
1594 // all paper sizes except of A4, A5, B5 and the US sizes need the
1596 bool nonstandard_papersize = papersize != PAPER_DEFAULT
1597 && papersize != PAPER_USLETTER
1598 && papersize != PAPER_USLEGAL
1599 && papersize != PAPER_USEXECUTIVE
1600 && papersize != PAPER_A4
1601 && papersize != PAPER_A5
1602 && papersize != PAPER_B5;
1604 if (!use_geometry) {
1605 switch (papersize) {
1607 clsoptions << "a4paper,";
1609 case PAPER_USLETTER:
1610 clsoptions << "letterpaper,";
1613 clsoptions << "a5paper,";
1616 clsoptions << "b5paper,";
1618 case PAPER_USEXECUTIVE:
1619 clsoptions << "executivepaper,";
1622 clsoptions << "legalpaper,";
1656 if (sides != tclass.sides()) {
1659 clsoptions << "oneside,";
1662 clsoptions << "twoside,";
1668 if (columns != tclass.columns()) {
1670 clsoptions << "twocolumn,";
1672 clsoptions << "onecolumn,";
1676 && orientation == ORIENTATION_LANDSCAPE)
1677 clsoptions << "landscape,";
1680 clsoptions << "fleqn,";
1682 switch(math_numbering_side) {
1684 clsoptions << "leqno,";
1687 clsoptions << "reqno,";
1688 features.require("amsmath");
1694 // language should be a parameter to \documentclass
1695 if (language->babel() == "hebrew"
1696 && default_language->babel() != "hebrew")
1697 // This seems necessary
1698 features.useLanguage(default_language);
1700 ostringstream language_options;
1701 bool const use_babel = features.useBabel() && !features.isProvided("babel");
1702 bool const use_polyglossia = features.usePolyglossia();
1703 bool const global = lyxrc.language_global_options;
1704 if (use_babel || (use_polyglossia && global)) {
1705 language_options << features.getBabelLanguages();
1706 if (!language->babel().empty()) {
1707 if (!language_options.str().empty())
1708 language_options << ',';
1709 language_options << language->babel();
1711 if (global && !features.needBabelLangOptions()
1712 && !language_options.str().empty())
1713 clsoptions << language_options.str() << ',';
1716 // the predefined options from the layout
1717 if (use_default_options && !tclass.options().empty())
1718 clsoptions << tclass.options() << ',';
1720 // the user-defined options
1721 if (!options.empty()) {
1722 clsoptions << options << ',';
1725 string strOptions(clsoptions.str());
1726 if (!strOptions.empty()) {
1727 strOptions = rtrim(strOptions, ",");
1729 os << '[' << from_utf8(strOptions) << ']';
1732 os << '{' << from_ascii(tclass.latexname()) << "}\n";
1733 // end of \documentclass defs
1735 // if we use fontspec or newtxmath, we have to load the AMS packages here
1736 string const ams = features.loadAMSPackages();
1737 bool const ot1 = (main_font_encoding() == "default" || main_font_encoding() == "OT1");
1738 bool const use_newtxmath =
1739 theLaTeXFonts().getLaTeXFont(from_ascii(fontsMath())).getUsedPackage(
1740 ot1, false, false) == "newtxmath";
1741 if ((useNonTeXFonts || use_newtxmath) && !ams.empty())
1742 os << from_ascii(ams);
1744 if (useNonTeXFonts) {
1745 if (!features.isProvided("fontspec"))
1746 os << "\\usepackage{fontspec}\n";
1747 if (features.mustProvide("unicode-math")
1748 && features.isAvailable("unicode-math"))
1749 os << "\\usepackage{unicode-math}\n";
1752 // font selection must be done before loading fontenc.sty
1753 string const fonts = loadFonts(features);
1755 os << from_utf8(fonts);
1757 if (fonts_default_family != "default")
1758 os << "\\renewcommand{\\familydefault}{\\"
1759 << from_ascii(fonts_default_family) << "}\n";
1761 // set font encoding
1762 // XeTeX and LuaTeX (with OS fonts) do not need fontenc
1763 if (!useNonTeXFonts && !features.isProvided("fontenc")
1764 && main_font_encoding() != "default") {
1765 // get main font encodings
1766 vector<string> fontencs = font_encodings();
1767 // get font encodings of secondary languages
1768 features.getFontEncodings(fontencs);
1769 if (!fontencs.empty()) {
1770 os << "\\usepackage["
1771 << from_ascii(getStringFromVector(fontencs))
1776 // handle inputenc etc.
1777 writeEncodingPreamble(os, features);
1780 if (!features.runparams().includeall && !included_children_.empty()) {
1781 os << "\\includeonly{";
1782 list<string>::const_iterator it = included_children_.begin();
1783 list<string>::const_iterator en = included_children_.end();
1785 for (; it != en; ++it) {
1786 string incfile = *it;
1787 FileName inc = makeAbsPath(incfile, filepath.absFileName());
1788 string mangled = DocFileName(changeExtension(inc.absFileName(), ".tex")).
1790 if (!features.runparams().nice)
1792 // \includeonly doesn't want an extension
1793 incfile = changeExtension(incfile, string());
1794 incfile = support::latex_path(incfile);
1795 if (!incfile.empty()) {
1798 os << from_utf8(incfile);
1805 if (!features.isProvided("geometry")
1806 && (use_geometry || nonstandard_papersize)) {
1807 odocstringstream ods;
1808 if (!getGraphicsDriver("geometry").empty())
1809 ods << getGraphicsDriver("geometry");
1810 if (orientation == ORIENTATION_LANDSCAPE)
1811 ods << ",landscape";
1812 switch (papersize) {
1814 if (!paperwidth.empty())
1815 ods << ",paperwidth="
1816 << from_ascii(paperwidth);
1817 if (!paperheight.empty())
1818 ods << ",paperheight="
1819 << from_ascii(paperheight);
1821 case PAPER_USLETTER:
1822 ods << ",letterpaper";
1825 ods << ",legalpaper";
1827 case PAPER_USEXECUTIVE:
1828 ods << ",executivepaper";
1917 docstring const g_options = trim(ods.str(), ",");
1918 os << "\\usepackage";
1919 if (!g_options.empty())
1920 os << '[' << g_options << ']';
1921 os << "{geometry}\n";
1922 // output this only if use_geometry is true
1924 os << "\\geometry{verbose";
1925 if (!topmargin.empty())
1926 os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1927 if (!bottommargin.empty())
1928 os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1929 if (!leftmargin.empty())
1930 os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1931 if (!rightmargin.empty())
1932 os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1933 if (!headheight.empty())
1934 os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1935 if (!headsep.empty())
1936 os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1937 if (!footskip.empty())
1938 os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1939 if (!columnsep.empty())
1940 os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
1943 } else if (orientation == ORIENTATION_LANDSCAPE
1944 || papersize != PAPER_DEFAULT) {
1945 features.require("papersize");
1948 if (tokenPos(tclass.opt_pagestyle(), '|', pagestyle) >= 0) {
1949 if (pagestyle == "fancy")
1950 os << "\\usepackage{fancyhdr}\n";
1951 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1954 // only output when the background color is not default
1955 if (isbackgroundcolor == true) {
1956 // only require color here, the background color will be defined
1957 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1959 features.require("color");
1960 features.require("pagecolor");
1963 // only output when the font color is not default
1964 if (isfontcolor == true) {
1965 // only require color here, the font color will be defined
1966 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1968 features.require("color");
1969 features.require("fontcolor");
1972 // Only if class has a ToC hierarchy
1973 if (tclass.hasTocLevels()) {
1974 if (secnumdepth != tclass.secnumdepth()) {
1975 os << "\\setcounter{secnumdepth}{"
1979 if (tocdepth != tclass.tocdepth()) {
1980 os << "\\setcounter{tocdepth}{"
1986 if (paragraph_separation) {
1987 // when skip separation
1988 switch (getDefSkip().kind()) {
1989 case VSpace::SMALLSKIP:
1990 os << "\\setlength{\\parskip}{\\smallskipamount}\n";
1992 case VSpace::MEDSKIP:
1993 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1995 case VSpace::BIGSKIP:
1996 os << "\\setlength{\\parskip}{\\bigskipamount}\n";
1998 case VSpace::LENGTH:
1999 os << "\\setlength{\\parskip}{"
2000 << from_utf8(getDefSkip().length().asLatexString())
2003 default: // should never happen // Then delete it.
2004 os << "\\setlength{\\parskip}{\\medskipamount}\n";
2007 os << "\\setlength{\\parindent}{0pt}\n";
2009 // when separation by indentation
2010 // only output something when a width is given
2011 if (!getParIndent().empty()) {
2012 os << "\\setlength{\\parindent}{"
2013 << from_utf8(getParIndent().asLatexString())
2018 if (is_math_indent) {
2019 // when formula indentation
2020 // only output something when it is not the default
2021 if (!getMathIndent().empty()) {
2022 os << "\\setlength{\\mathindent}{"
2023 << from_utf8(getMathIndent().asString())
2028 // Now insert the LyX specific LaTeX commands...
2029 features.resolveAlternatives();
2030 features.expandMultiples();
2033 if (!output_sync_macro.empty())
2034 os << from_utf8(output_sync_macro) +"\n";
2035 else if (features.runparams().flavor == OutputParams::LATEX)
2036 os << "\\usepackage[active]{srcltx}\n";
2037 else if (features.runparams().flavor == OutputParams::PDFLATEX)
2038 os << "\\synctex=-1\n";
2041 // The package options (via \PassOptionsToPackage)
2042 os << from_ascii(features.getPackageOptions());
2044 // due to interferences with babel and hyperref, the color package has to
2045 // be loaded (when it is not already loaded) before babel when hyperref
2046 // is used with the colorlinks option, see
2047 // http://www.lyx.org/trac/ticket/5291
2048 // we decided therefore to load color always before babel, see
2049 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
2050 os << from_ascii(features.getColorOptions());
2052 // If we use hyperref, jurabib, japanese, varioref or vietnamese,
2053 // we have to call babel before
2055 && (features.isRequired("jurabib")
2056 || features.isRequired("hyperref")
2057 || features.isRequired("varioref")
2058 || features.isRequired("vietnamese")
2059 || features.isRequired("japanese"))) {
2060 os << features.getBabelPresettings();
2062 os << from_utf8(babelCall(language_options.str(),
2063 features.needBabelLangOptions())) + '\n';
2064 os << features.getBabelPostsettings();
2067 // The optional packages;
2068 os << from_ascii(features.getPackages());
2070 // Additional Indices
2071 if (features.isRequired("splitidx")) {
2072 IndicesList::const_iterator iit = indiceslist().begin();
2073 IndicesList::const_iterator iend = indiceslist().end();
2074 for (; iit != iend; ++iit) {
2075 os << "\\newindex{";
2076 os << escape(iit->shortcut());
2082 os << from_utf8(spacing().writePreamble(features.isProvided("SetSpace")));
2085 // * Hyperref manual: "Make sure it comes last of your loaded
2086 // packages, to give it a fighting chance of not being over-written,
2087 // since its job is to redefine many LaTeX commands."
2088 // * Email from Heiko Oberdiek: "It is usually better to load babel
2089 // before hyperref. Then hyperref has a chance to detect babel.
2090 // * Has to be loaded before the "LyX specific LaTeX commands" to
2091 // avoid errors with algorithm floats.
2092 // use hyperref explicitly if it is required
2093 if (features.isRequired("hyperref")) {
2094 OutputParams tmp_params = features.runparams();
2095 pdfoptions().writeLaTeX(tmp_params, os,
2096 features.isProvided("hyperref"));
2097 // correctly break URLs with hyperref and dvi output
2098 if (features.runparams().flavor == OutputParams::LATEX
2099 && features.isAvailable("breakurl"))
2100 os << "\\usepackage{breakurl}\n";
2101 } else if (features.isRequired("nameref"))
2102 // hyperref loads this automatically
2103 os << "\\usepackage{nameref}\n";
2105 // bibtopic needs to be loaded after hyperref.
2106 // the dot provides the aux file naming which LyX can detect.
2107 if (features.mustProvide("bibtopic"))
2108 os << "\\usepackage[dot]{bibtopic}\n";
2110 // Will be surrounded by \makeatletter and \makeatother when not empty
2111 otexstringstream atlyxpreamble;
2113 // Some macros LyX will need
2115 TexString tmppreamble = features.getMacros();
2116 if (!tmppreamble.str.empty())
2117 atlyxpreamble << "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2118 "LyX specific LaTeX commands.\n"
2119 << move(tmppreamble)
2122 // the text class specific preamble
2124 docstring tmppreamble = features.getTClassPreamble();
2125 if (!tmppreamble.empty())
2126 atlyxpreamble << "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2127 "Textclass specific LaTeX commands.\n"
2131 // suppress date if selected
2132 // use \@ifundefined because we cannot be sure that every document class
2133 // has a \date command
2135 atlyxpreamble << "\\@ifundefined{date}{}{\\date{}}\n";
2137 /* the user-defined preamble */
2138 if (!containsOnly(preamble, " \n\t")) {
2140 atlyxpreamble << "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2141 "User specified LaTeX commands.\n";
2143 // Check if the user preamble contains uncodable glyphs
2144 odocstringstream user_preamble;
2145 docstring uncodable_glyphs;
2146 Encoding const * const enc = features.runparams().encoding;
2148 for (size_t n = 0; n < preamble.size(); ++n) {
2149 char_type c = preamble[n];
2150 if (!enc->encodable(c)) {
2151 docstring const glyph(1, c);
2152 LYXERR0("Uncodable character '"
2154 << "' in user preamble!");
2155 uncodable_glyphs += glyph;
2156 if (features.runparams().dryrun) {
2157 user_preamble << "<" << _("LyX Warning: ")
2158 << _("uncodable character") << " '";
2159 user_preamble.put(c);
2160 user_preamble << "'>";
2163 user_preamble.put(c);
2166 user_preamble << preamble;
2168 // On BUFFER_VIEW|UPDATE, warn user if we found uncodable glyphs
2169 if (!features.runparams().dryrun && !uncodable_glyphs.empty()) {
2170 frontend::Alert::warning(
2171 _("Uncodable character in user preamble"),
2173 _("The user preamble of your document contains glyphs "
2174 "that are unknown in the current document encoding "
2175 "(namely %1$s).\nThese glyphs are omitted "
2176 " from the output, which may result in "
2177 "incomplete output."
2178 "\n\nPlease select an appropriate "
2179 "document encoding\n"
2180 "(such as utf8) or change the "
2181 "preamble code accordingly."),
2184 atlyxpreamble << user_preamble.str() << '\n';
2187 // footmisc must be loaded after setspace
2188 // Load it here to avoid clashes with footmisc loaded in the user
2189 // preamble. For that reason we also pass the options via
2190 // \PassOptionsToPackage in getPreamble() and not here.
2191 if (features.mustProvide("footmisc"))
2192 atlyxpreamble << "\\usepackage{footmisc}\n";
2194 // subfig loads internally the LaTeX package "caption". As
2195 // caption is a very popular package, users will load it in
2196 // the preamble. Therefore we must load subfig behind the
2197 // user-defined preamble and check if the caption package was
2198 // loaded or not. For the case that caption is loaded before
2199 // subfig, there is the subfig option "caption=false". This
2200 // option also works when a koma-script class is used and
2201 // koma's own caption commands are used instead of caption. We
2202 // use \PassOptionsToPackage here because the user could have
2203 // already loaded subfig in the preamble.
2204 if (features.mustProvide("subfig"))
2205 atlyxpreamble << "\\@ifundefined{showcaptionsetup}{}{%\n"
2206 " \\PassOptionsToPackage{caption=false}{subfig}}\n"
2207 "\\usepackage{subfig}\n";
2209 // Itemize bullet settings need to be last in case the user
2210 // defines their own bullets that use a package included
2211 // in the user-defined preamble -- ARRae
2212 // Actually it has to be done much later than that
2213 // since some packages like frenchb make modifications
2214 // at \begin{document} time -- JMarc
2215 docstring bullets_def;
2216 for (int i = 0; i < 4; ++i) {
2217 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
2218 if (bullets_def.empty())
2219 bullets_def += "\\AtBeginDocument{\n";
2220 bullets_def += " \\def\\labelitemi";
2222 // `i' is one less than the item to modify
2229 bullets_def += "ii";
2235 bullets_def += '{' +
2236 user_defined_bullet(i).getText()
2241 if (!bullets_def.empty())
2242 atlyxpreamble << bullets_def << "}\n\n";
2244 if (!atlyxpreamble.empty())
2245 os << "\n\\makeatletter\n"
2246 << atlyxpreamble.release()
2247 << "\\makeatother\n\n";
2249 // We try to load babel late, in case it interferes with other packages.
2250 // Jurabib, hyperref, varioref, bicaption and listings (bug 8995) have to be
2251 // called after babel, though.
2252 if (use_babel && !features.isRequired("jurabib")
2253 && !features.isRequired("hyperref")
2254 && !features.isRequired("varioref")
2255 && !features.isRequired("vietnamese")
2256 && !features.isRequired("japanese")) {
2257 os << features.getBabelPresettings();
2259 os << from_utf8(babelCall(language_options.str(),
2260 features.needBabelLangOptions())) + '\n';
2261 os << features.getBabelPostsettings();
2263 if (features.isRequired("bicaption"))
2264 os << "\\usepackage{bicaption}\n";
2265 if (!listings_params.empty()
2266 || features.mustProvide("listings")
2267 || features.mustProvide("minted")) {
2268 if (features.mustProvide("listings"))
2269 os << "\\usepackage{listings}\n";
2271 os << "\\usepackage{minted}\n";
2273 if (!listings_params.empty()) {
2274 if (features.mustProvide("listings"))
2277 os << "\\setminted{";
2278 // do not test validity because listings_params is
2279 // supposed to be valid
2281 InsetListingsParams(listings_params).separatedParams(true);
2282 os << from_utf8(par);
2286 // xunicode only needs to be loaded if tipa is used
2287 // (the rest is obsoleted by the new TU encoding).
2288 // It needs to be loaded at least after amsmath, amssymb,
2289 // esint and the other packages that provide special glyphs
2290 if (features.mustProvide("tipa") && useNonTeXFonts) {
2291 // The package officially only supports XeTeX, but also works
2292 // with LuaTeX. Thus we work around its XeTeX test.
2293 if (features.runparams().flavor != OutputParams::XETEX) {
2294 os << "% Pretend to xunicode that we are XeTeX\n"
2295 << "\\def\\XeTeXpicfile{}\n";
2297 os << "\\usepackage{xunicode}\n";
2300 // Polyglossia must be loaded last ...
2301 if (use_polyglossia) {
2303 os << "\\usepackage{polyglossia}\n";
2304 // set the main language
2305 os << "\\setdefaultlanguage";
2306 if (!language->polyglossiaOpts().empty())
2307 os << "[" << from_ascii(language->polyglossiaOpts()) << "]";
2308 os << "{" << from_ascii(language->polyglossia()) << "}\n";
2309 // now setup the other languages
2310 set<string> const polylangs =
2311 features.getPolyglossiaLanguages();
2312 for (set<string>::const_iterator mit = polylangs.begin();
2313 mit != polylangs.end() ; ++mit) {
2314 // We do not output the options here; they are output in
2315 // the language switch commands. This is safer if multiple
2316 // varieties are used.
2317 if (*mit == language->polyglossia())
2319 os << "\\setotherlanguage";
2320 os << "{" << from_ascii(*mit) << "}\n";
2324 // ... but before biblatex (see #7065)
2325 if (features.mustProvide("biblatex")) {
2328 os << "\\usepackage";
2329 if (!biblatex_bibstyle.empty()
2330 && (biblatex_bibstyle == biblatex_citestyle)) {
2331 opts = "style=" + biblatex_bibstyle;
2334 if (!biblatex_bibstyle.empty()) {
2335 opts = "bibstyle=" + biblatex_bibstyle;
2338 if (!biblatex_citestyle.empty()) {
2339 opts += delim + "citestyle=" + biblatex_citestyle;
2343 if (!multibib.empty() && multibib != "child") {
2344 opts += delim + "refsection=" + multibib;
2347 if (bibtexCommand() == "bibtex8"
2348 || prefixIs(bibtexCommand(), "bibtex8 ")) {
2349 opts += delim + "backend=bibtex8";
2351 } else if (bibtexCommand() == "bibtex"
2352 || prefixIs(bibtexCommand(), "bibtex ")) {
2353 opts += delim + "backend=bibtex";
2356 if (!biblio_opts.empty())
2357 opts += delim + biblio_opts;
2359 os << "[" << opts << "]";
2360 os << "{biblatex}\n";
2364 // Load custom language package here
2365 if (features.langPackage() == LaTeXFeatures::LANG_PACK_CUSTOM) {
2366 if (lang_package == "default")
2367 os << from_utf8(lyxrc.language_custom_package);
2369 os << from_utf8(lang_package);
2373 docstring const i18npreamble =
2374 features.getTClassI18nPreamble(use_babel, use_polyglossia,
2376 if (!i18npreamble.empty())
2377 os << i18npreamble + '\n';
2383 void BufferParams::useClassDefaults()
2385 DocumentClass const & tclass = documentClass();
2387 sides = tclass.sides();
2388 columns = tclass.columns();
2389 pagestyle = tclass.pagestyle();
2390 use_default_options = true;
2391 // Only if class has a ToC hierarchy
2392 if (tclass.hasTocLevels()) {
2393 secnumdepth = tclass.secnumdepth();
2394 tocdepth = tclass.tocdepth();
2399 bool BufferParams::hasClassDefaults() const
2401 DocumentClass const & tclass = documentClass();
2403 return sides == tclass.sides()
2404 && columns == tclass.columns()
2405 && pagestyle == tclass.pagestyle()
2406 && use_default_options
2407 && secnumdepth == tclass.secnumdepth()
2408 && tocdepth == tclass.tocdepth();
2412 DocumentClass const & BufferParams::documentClass() const
2418 DocumentClassConstPtr BufferParams::documentClassPtr() const
2424 void BufferParams::setDocumentClass(DocumentClassConstPtr tc)
2426 // evil, but this function is evil
2427 doc_class_ = const_pointer_cast<DocumentClass>(tc);
2428 invalidateConverterCache();
2432 bool BufferParams::setBaseClass(string const & classname)
2434 LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
2435 LayoutFileList & bcl = LayoutFileList::get();
2436 if (!bcl.haveClass(classname)) {
2438 bformat(_("The layout file:\n"
2440 "could not be found. A default textclass with default\n"
2441 "layouts will be used. LyX will not be able to produce\n"
2443 from_utf8(classname));
2444 frontend::Alert::error(_("Document class not found"), s);
2445 bcl.addEmptyClass(classname);
2448 bool const success = bcl[classname].load();
2451 bformat(_("Due to some error in it, the layout file:\n"
2453 "could not be loaded. A default textclass with default\n"
2454 "layouts will be used. LyX will not be able to produce\n"
2456 from_utf8(classname));
2457 frontend::Alert::error(_("Could not load class"), s);
2458 bcl.addEmptyClass(classname);
2461 pimpl_->baseClass_ = classname;
2462 layout_modules_.adaptToBaseClass(baseClass(), removed_modules_);
2467 LayoutFile const * BufferParams::baseClass() const
2469 if (LayoutFileList::get().haveClass(pimpl_->baseClass_))
2470 return &(LayoutFileList::get()[pimpl_->baseClass_]);
2476 LayoutFileIndex const & BufferParams::baseClassID() const
2478 return pimpl_->baseClass_;
2482 void BufferParams::makeDocumentClass(bool const clone)
2487 invalidateConverterCache();
2488 LayoutModuleList mods;
2489 LayoutModuleList ces;
2490 LayoutModuleList::iterator it = layout_modules_.begin();
2491 LayoutModuleList::iterator en = layout_modules_.end();
2492 for (; it != en; ++it)
2493 mods.push_back(*it);
2495 it = cite_engine_.begin();
2496 en = cite_engine_.end();
2497 for (; it != en; ++it)
2500 doc_class_ = getDocumentClass(*baseClass(), mods, ces, clone);
2502 TextClass::ReturnValues success = TextClass::OK;
2503 if (!forced_local_layout_.empty())
2504 success = doc_class_->read(to_utf8(forced_local_layout_),
2506 if (!local_layout_.empty() &&
2507 (success == TextClass::OK || success == TextClass::OK_OLDFORMAT))
2508 success = doc_class_->read(to_utf8(local_layout_), TextClass::MODULE);
2509 if (success != TextClass::OK && success != TextClass::OK_OLDFORMAT) {
2510 docstring const msg = _("Error reading internal layout information");
2511 frontend::Alert::warning(_("Read Error"), msg);
2516 bool BufferParams::layoutModuleCanBeAdded(string const & modName) const
2518 return layout_modules_.moduleCanBeAdded(modName, baseClass());
2522 bool BufferParams::citationModuleCanBeAdded(string const & modName) const
2524 return cite_engine_.moduleCanBeAdded(modName, baseClass());
2528 docstring BufferParams::getLocalLayout(bool forced) const
2531 return from_utf8(doc_class_->forcedLayouts());
2533 return local_layout_;
2537 void BufferParams::setLocalLayout(docstring const & layout, bool forced)
2540 forced_local_layout_ = layout;
2542 local_layout_ = layout;
2546 bool BufferParams::addLayoutModule(string const & modName)
2548 LayoutModuleList::const_iterator it = layout_modules_.begin();
2549 LayoutModuleList::const_iterator end = layout_modules_.end();
2550 for (; it != end; ++it)
2553 layout_modules_.push_back(modName);
2558 string BufferParams::bufferFormat() const
2560 return documentClass().outputFormat();
2564 bool BufferParams::isExportable(string const & format, bool need_viewable) const
2566 FormatList const & formats = exportableFormats(need_viewable);
2567 FormatList::const_iterator fit = formats.begin();
2568 FormatList::const_iterator end = formats.end();
2569 for (; fit != end ; ++fit) {
2570 if ((*fit)->name() == format)
2577 FormatList const & BufferParams::exportableFormats(bool only_viewable) const
2579 FormatList & cached = only_viewable ?
2580 pimpl_->viewableFormatList : pimpl_->exportableFormatList;
2581 bool & valid = only_viewable ?
2582 pimpl_->isViewCacheValid : pimpl_->isExportCacheValid;
2586 vector<string> const backs = backends();
2587 set<string> excludes;
2588 if (useNonTeXFonts) {
2589 excludes.insert("latex");
2590 excludes.insert("pdflatex");
2593 theConverters().getReachable(backs[0], only_viewable, true, excludes);
2594 for (vector<string>::const_iterator it = backs.begin() + 1;
2595 it != backs.end(); ++it) {
2596 FormatList r = theConverters().getReachable(*it, only_viewable,
2598 result.insert(result.end(), r.begin(), r.end());
2600 sort(result.begin(), result.end(), Format::formatSorter);
2607 vector<string> BufferParams::backends() const
2610 string const buffmt = bufferFormat();
2612 // FIXME: Don't hardcode format names here, but use a flag
2613 if (buffmt == "latex") {
2614 if (encoding().package() == Encoding::japanese)
2615 v.push_back("platex");
2617 if (!useNonTeXFonts) {
2618 v.push_back("pdflatex");
2619 v.push_back("latex");
2621 v.push_back("xetex");
2622 v.push_back("luatex");
2623 v.push_back("dviluatex");
2626 v.push_back(buffmt);
2628 v.push_back("xhtml");
2629 v.push_back("text");
2635 OutputParams::FLAVOR BufferParams::getOutputFlavor(string const & format) const
2637 string const dformat = (format.empty() || format == "default") ?
2638 getDefaultOutputFormat() : format;
2639 DefaultFlavorCache::const_iterator it =
2640 default_flavors_.find(dformat);
2642 if (it != default_flavors_.end())
2645 OutputParams::FLAVOR result = OutputParams::LATEX;
2647 // FIXME It'd be better not to hardcode this, but to do
2648 // something with formats.
2649 if (dformat == "xhtml")
2650 result = OutputParams::HTML;
2651 else if (dformat == "text")
2652 result = OutputParams::TEXT;
2653 else if (dformat == "lyx")
2654 result = OutputParams::LYX;
2655 else if (dformat == "pdflatex")
2656 result = OutputParams::PDFLATEX;
2657 else if (dformat == "xetex")
2658 result = OutputParams::XETEX;
2659 else if (dformat == "luatex")
2660 result = OutputParams::LUATEX;
2661 else if (dformat == "dviluatex")
2662 result = OutputParams::DVILUATEX;
2664 // Try to determine flavor of default output format
2665 vector<string> backs = backends();
2666 if (find(backs.begin(), backs.end(), dformat) == backs.end()) {
2667 // Get shortest path to format
2668 Graph::EdgePath path;
2669 for (vector<string>::const_iterator it = backs.begin();
2670 it != backs.end(); ++it) {
2671 Graph::EdgePath p = theConverters().getPath(*it, dformat);
2672 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2677 result = theConverters().getFlavor(path);
2680 // cache this flavor
2681 default_flavors_[dformat] = result;
2686 string BufferParams::getDefaultOutputFormat() const
2688 if (!default_output_format.empty()
2689 && default_output_format != "default")
2690 return default_output_format;
2692 || encoding().package() == Encoding::japanese) {
2693 FormatList const & formats = exportableFormats(true);
2694 if (formats.empty())
2696 // return the first we find
2697 return formats.front()->name();
2700 return lyxrc.default_otf_view_format;
2701 return lyxrc.default_view_format;
2704 Font const BufferParams::getFont() const
2706 FontInfo f = documentClass().defaultfont();
2707 if (fonts_default_family == "rmdefault")
2708 f.setFamily(ROMAN_FAMILY);
2709 else if (fonts_default_family == "sfdefault")
2710 f.setFamily(SANS_FAMILY);
2711 else if (fonts_default_family == "ttdefault")
2712 f.setFamily(TYPEWRITER_FAMILY);
2713 return Font(f, language);
2717 InsetQuotesParams::QuoteStyle BufferParams::getQuoteStyle(string const & qs) const
2719 return quotesstyletranslator().find(qs);
2723 bool BufferParams::isLatex() const
2725 return documentClass().outputType() == LATEX;
2729 bool BufferParams::isLiterate() const
2731 return documentClass().outputType() == LITERATE;
2735 bool BufferParams::isDocBook() const
2737 return documentClass().outputType() == DOCBOOK;
2741 void BufferParams::readPreamble(Lexer & lex)
2743 if (lex.getString() != "\\begin_preamble")
2744 lyxerr << "Error (BufferParams::readPreamble):"
2745 "consistency check failed." << endl;
2747 preamble = lex.getLongString(from_ascii("\\end_preamble"));
2751 void BufferParams::readLocalLayout(Lexer & lex, bool forced)
2753 string const expected = forced ? "\\begin_forced_local_layout" :
2754 "\\begin_local_layout";
2755 if (lex.getString() != expected)
2756 lyxerr << "Error (BufferParams::readLocalLayout):"
2757 "consistency check failed." << endl;
2760 forced_local_layout_ =
2761 lex.getLongString(from_ascii("\\end_forced_local_layout"));
2763 local_layout_ = lex.getLongString(from_ascii("\\end_local_layout"));
2767 bool BufferParams::setLanguage(string const & lang)
2769 Language const *new_language = languages.getLanguage(lang);
2770 if (!new_language) {
2771 // Language lang was not found
2774 language = new_language;
2779 void BufferParams::readLanguage(Lexer & lex)
2781 if (!lex.next()) return;
2783 string const tmptok = lex.getString();
2785 // check if tmptok is part of tex_babel in tex-defs.h
2786 if (!setLanguage(tmptok)) {
2787 // Language tmptok was not found
2788 language = default_language;
2789 lyxerr << "Warning: Setting language `"
2790 << tmptok << "' to `" << language->lang()
2796 void BufferParams::readGraphicsDriver(Lexer & lex)
2801 string const tmptok = lex.getString();
2802 // check if tmptok is part of tex_graphics in tex_defs.h
2805 string const test = tex_graphics[n++];
2807 if (test == tmptok) {
2808 graphics_driver = tmptok;
2813 "Warning: graphics driver `$$Token' not recognized!\n"
2814 " Setting graphics driver to `default'.\n");
2815 graphics_driver = "default";
2822 void BufferParams::readBullets(Lexer & lex)
2827 int const index = lex.getInteger();
2829 int temp_int = lex.getInteger();
2830 user_defined_bullet(index).setFont(temp_int);
2831 temp_bullet(index).setFont(temp_int);
2833 user_defined_bullet(index).setCharacter(temp_int);
2834 temp_bullet(index).setCharacter(temp_int);
2836 user_defined_bullet(index).setSize(temp_int);
2837 temp_bullet(index).setSize(temp_int);
2841 void BufferParams::readBulletsLaTeX(Lexer & lex)
2843 // The bullet class should be able to read this.
2846 int const index = lex.getInteger();
2848 docstring const temp_str = lex.getDocString();
2850 user_defined_bullet(index).setText(temp_str);
2851 temp_bullet(index).setText(temp_str);
2855 void BufferParams::readModules(Lexer & lex)
2857 if (!lex.eatLine()) {
2858 lyxerr << "Error (BufferParams::readModules):"
2859 "Unexpected end of input." << endl;
2863 string mod = lex.getString();
2864 if (mod == "\\end_modules")
2866 addLayoutModule(mod);
2872 void BufferParams::readRemovedModules(Lexer & lex)
2874 if (!lex.eatLine()) {
2875 lyxerr << "Error (BufferParams::readRemovedModules):"
2876 "Unexpected end of input." << endl;
2880 string mod = lex.getString();
2881 if (mod == "\\end_removed_modules")
2883 removed_modules_.push_back(mod);
2886 // now we want to remove any removed modules that were previously
2887 // added. normally, that will be because default modules were added in
2888 // setBaseClass(), which gets called when \textclass is read at the
2889 // start of the read.
2890 list<string>::const_iterator rit = removed_modules_.begin();
2891 list<string>::const_iterator const ren = removed_modules_.end();
2892 for (; rit != ren; ++rit) {
2893 LayoutModuleList::iterator const mit = layout_modules_.begin();
2894 LayoutModuleList::iterator const men = layout_modules_.end();
2895 LayoutModuleList::iterator found = find(mit, men, *rit);
2898 layout_modules_.erase(found);
2903 void BufferParams::readIncludeonly(Lexer & lex)
2905 if (!lex.eatLine()) {
2906 lyxerr << "Error (BufferParams::readIncludeonly):"
2907 "Unexpected end of input." << endl;
2911 string child = lex.getString();
2912 if (child == "\\end_includeonly")
2914 included_children_.push_back(child);
2920 string BufferParams::paperSizeName(PapersizePurpose purpose) const
2922 switch (papersize) {
2924 // could be anything, so don't guess
2926 case PAPER_CUSTOM: {
2927 if (purpose == XDVI && !paperwidth.empty() &&
2928 !paperheight.empty()) {
2929 // heightxwidth<unit>
2930 string first = paperwidth;
2931 string second = paperheight;
2932 if (orientation == ORIENTATION_LANDSCAPE)
2935 return first.erase(first.length() - 2)
2941 // dvips and dvipdfm do not know this
2942 if (purpose == DVIPS || purpose == DVIPDFM)
2946 if (purpose == DVIPS || purpose == DVIPDFM)
2950 if (purpose == DVIPS || purpose == DVIPDFM)
2960 if (purpose == DVIPS || purpose == DVIPDFM)
2964 if (purpose == DVIPS || purpose == DVIPDFM)
2968 if (purpose == DVIPS || purpose == DVIPDFM)
2972 if (purpose == DVIPS || purpose == DVIPDFM)
2976 if (purpose == DVIPS || purpose == DVIPDFM)
2980 // dvipdfm does not know this
2981 if (purpose == DVIPDFM)
2985 if (purpose == DVIPDFM)
2989 if (purpose == DVIPS || purpose == DVIPDFM)
2993 if (purpose == DVIPS || purpose == DVIPDFM)
2997 if (purpose == DVIPS || purpose == DVIPDFM)
3001 if (purpose == DVIPS || purpose == DVIPDFM)
3005 if (purpose == DVIPS || purpose == DVIPDFM)
3009 if (purpose == DVIPS || purpose == DVIPDFM)
3013 if (purpose == DVIPS || purpose == DVIPDFM)
3017 if (purpose == DVIPS || purpose == DVIPDFM)
3021 if (purpose == DVIPS || purpose == DVIPDFM)
3025 if (purpose == DVIPS || purpose == DVIPDFM)
3029 if (purpose == DVIPS || purpose == DVIPDFM)
3033 if (purpose == DVIPS || purpose == DVIPDFM)
3037 if (purpose == DVIPS || purpose == DVIPDFM)
3041 if (purpose == DVIPS || purpose == DVIPDFM)
3045 if (purpose == DVIPS || purpose == DVIPDFM)
3048 case PAPER_USEXECUTIVE:
3049 // dvipdfm does not know this
3050 if (purpose == DVIPDFM)
3055 case PAPER_USLETTER:
3057 if (purpose == XDVI)
3064 string const BufferParams::dvips_options() const
3068 // If the class loads the geometry package, we do not know which
3069 // paper size is used, since we do not set it (bug 7013).
3070 // Therefore we must not specify any argument here.
3071 // dvips gets the correct paper size via DVI specials in this case
3072 // (if the class uses the geometry package correctly).
3073 if (documentClass().provides("geometry"))
3077 && papersize == PAPER_CUSTOM
3078 && !lyxrc.print_paper_dimension_flag.empty()
3079 && !paperwidth.empty()
3080 && !paperheight.empty()) {
3081 // using a custom papersize
3082 result = lyxrc.print_paper_dimension_flag;
3083 result += ' ' + paperwidth;
3084 result += ',' + paperheight;
3086 string const paper_option = paperSizeName(DVIPS);
3087 if (!paper_option.empty() && (paper_option != "letter" ||
3088 orientation != ORIENTATION_LANDSCAPE)) {
3089 // dvips won't accept -t letter -t landscape.
3090 // In all other cases, include the paper size
3092 result = lyxrc.print_paper_flag;
3093 result += ' ' + paper_option;
3096 if (orientation == ORIENTATION_LANDSCAPE &&
3097 papersize != PAPER_CUSTOM)
3098 result += ' ' + lyxrc.print_landscape_flag;
3103 string const BufferParams::main_font_encoding() const
3105 return font_encodings().empty() ? "default" : font_encodings().back();
3109 vector<string> const BufferParams::font_encodings() const
3111 string doc_fontenc = (fontenc == "global") ? lyxrc.fontenc : fontenc;
3113 vector<string> fontencs;
3115 // "default" means "no explicit font encoding"
3116 if (doc_fontenc != "default") {
3117 fontencs = getVectorFromString(doc_fontenc);
3118 if (!language->fontenc().empty()
3119 && ascii_lowercase(language->fontenc()) != "none") {
3120 vector<string> fencs = getVectorFromString(language->fontenc());
3121 vector<string>::const_iterator fit = fencs.begin();
3122 for (; fit != fencs.end(); ++fit) {
3123 if (find(fontencs.begin(), fontencs.end(), *fit) == fontencs.end())
3124 fontencs.push_back(*fit);
3133 string BufferParams::babelCall(string const & lang_opts, bool const langoptions) const
3135 // suppress the babel call if there is no BabelName defined
3136 // for the document language in the lib/languages file and if no
3137 // other languages are used (lang_opts is then empty)
3138 if (lang_opts.empty())
3140 // either a specific language (AsBabelOptions setting in
3141 // lib/languages) or the prefs require the languages to
3142 // be submitted to babel itself (not the class).
3144 return "\\usepackage[" + lang_opts + "]{babel}";
3145 return "\\usepackage{babel}";
3149 docstring BufferParams::getGraphicsDriver(string const & package) const
3153 if (package == "geometry") {
3154 if (graphics_driver == "dvips"
3155 || graphics_driver == "dvipdfm"
3156 || graphics_driver == "pdftex"
3157 || graphics_driver == "vtex")
3158 result = from_ascii(graphics_driver);
3159 else if (graphics_driver == "dvipdfmx")
3160 result = from_ascii("dvipdfm");
3167 void BufferParams::writeEncodingPreamble(otexstream & os,
3168 LaTeXFeatures & features) const
3170 // XeTeX/LuaTeX: (see also #9740)
3171 // With Unicode fonts we use utf8-plain without encoding package.
3172 // With TeX fonts, we cannot use utf8-plain, but "inputenc" fails.
3173 // XeTeX must use ASCII encoding (see Buffer.cpp),
3174 // for LuaTeX, we load "luainputenc" (see below).
3175 if (useNonTeXFonts || features.runparams().flavor == OutputParams::XETEX)
3178 if (inputenc == "auto") {
3179 string const doc_encoding =
3180 language->encoding()->latexName();
3181 Encoding::Package const package =
3182 language->encoding()->package();
3184 // Create list of inputenc options:
3185 set<string> encodings;
3186 // luainputenc fails with more than one encoding
3187 if (!features.runparams().isFullUnicode()) // if we reach this point, this means LuaTeX with TeX fonts
3188 // list all input encodings used in the document
3189 encodings = features.getEncodingSet(doc_encoding);
3191 // If the "japanese" package (i.e. pLaTeX) is used,
3192 // inputenc must be omitted.
3193 // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
3194 if ((!encodings.empty() || package == Encoding::inputenc)
3195 && !features.isRequired("japanese")
3196 && !features.isProvided("inputenc")) {
3197 os << "\\usepackage[";
3198 set<string>::const_iterator it = encodings.begin();
3199 set<string>::const_iterator const end = encodings.end();
3201 os << from_ascii(*it);
3204 for (; it != end; ++it)
3205 os << ',' << from_ascii(*it);
3206 if (package == Encoding::inputenc) {
3207 if (!encodings.empty())
3209 os << from_ascii(doc_encoding);
3211 if (features.runparams().flavor == OutputParams::LUATEX
3212 || features.runparams().flavor == OutputParams::DVILUATEX)
3213 os << "]{luainputenc}\n";
3215 os << "]{inputenc}\n";
3217 if (package == Encoding::CJK || features.mustProvide("CJK")) {
3218 if (language->encoding()->name() == "utf8-cjk"
3219 && LaTeXFeatures::isAvailable("CJKutf8"))
3220 os << "\\usepackage{CJKutf8}\n";
3222 os << "\\usepackage{CJK}\n";
3224 } else if (inputenc != "default") {
3225 switch (encoding().package()) {
3226 case Encoding::none:
3227 case Encoding::japanese:
3229 case Encoding::inputenc:
3230 // do not load inputenc if japanese is used
3231 // or if the class provides inputenc
3232 if (features.isRequired("japanese")
3233 || features.isProvided("inputenc"))
3235 os << "\\usepackage[" << from_ascii(encoding().latexName());
3236 if (features.runparams().flavor == OutputParams::LUATEX
3237 || features.runparams().flavor == OutputParams::DVILUATEX)
3238 os << "]{luainputenc}\n";
3240 os << "]{inputenc}\n";
3243 if (encoding().name() == "utf8-cjk"
3244 && LaTeXFeatures::isAvailable("CJKutf8"))
3245 os << "\\usepackage{CJKutf8}\n";
3247 os << "\\usepackage{CJK}\n";
3250 // Load the CJK package if needed by a secondary language.
3251 // If the main encoding is some variant of UTF8, use CJKutf8.
3252 if (encoding().package() != Encoding::CJK && features.mustProvide("CJK")) {
3253 if (encoding().iconvName() == "UTF-8"
3254 && LaTeXFeatures::isAvailable("CJKutf8"))
3255 os << "\\usepackage{CJKutf8}\n";
3257 os << "\\usepackage{CJK}\n";
3263 string const BufferParams::parseFontName(string const & name) const
3265 string mangled = name;
3266 size_t const idx = mangled.find('[');
3267 if (idx == string::npos || idx == 0)
3270 return mangled.substr(0, idx - 1);
3274 string const BufferParams::loadFonts(LaTeXFeatures & features) const
3276 if (fontsRoman() == "default" && fontsSans() == "default"
3277 && fontsTypewriter() == "default"
3278 && (fontsMath() == "default" || fontsMath() == "auto"))
3284 /* Fontspec (XeTeX, LuaTeX): we provide GUI support for oldstyle
3285 * numbers (Numbers=OldStyle) and sf/tt scaling. The Ligatures=TeX/
3286 * Mapping=tex-text option assures TeX ligatures (such as "--")
3287 * are resolved. Note that tt does not use these ligatures.
3289 * -- add more GUI options?
3290 * -- add more fonts (fonts for other scripts)
3291 * -- if there's a way to find out if a font really supports
3292 * OldStyle, enable/disable the widget accordingly.
3294 if (useNonTeXFonts && features.isAvailable("fontspec")) {
3295 // "Mapping=tex-text" and "Ligatures=TeX" are equivalent.
3296 // However, until v.2 (2010/07/11) fontspec only knew
3297 // Mapping=tex-text (for XeTeX only); then "Ligatures=TeX"
3298 // was introduced for both XeTeX and LuaTeX (LuaTeX
3299 // didn't understand "Mapping=tex-text", while XeTeX
3300 // understood both. With most recent versions, both
3301 // variants are understood by both engines. However,
3302 // we want to provide support for at least TeXLive 2009
3303 // (for XeTeX; LuaTeX is only supported as of v.2)
3304 string const texmapping =
3305 (features.runparams().flavor == OutputParams::XETEX) ?
3306 "Mapping=tex-text" : "Ligatures=TeX";
3307 if (fontsRoman() != "default") {
3308 os << "\\setmainfont[" << texmapping;
3309 if (fonts_old_figures)
3310 os << ",Numbers=OldStyle";
3311 os << "]{" << parseFontName(fontsRoman()) << "}\n";
3313 if (fontsSans() != "default") {
3314 string const sans = parseFontName(fontsSans());
3315 if (fontsSansScale() != 100)
3316 os << "\\setsansfont[Scale="
3317 << float(fontsSansScale()) / 100
3318 << "," << texmapping << "]{"
3321 os << "\\setsansfont[" << texmapping << "]{"
3324 if (fontsTypewriter() != "default") {
3325 string const mono = parseFontName(fontsTypewriter());
3326 if (fontsTypewriterScale() != 100)
3327 os << "\\setmonofont[Scale="
3328 << float(fontsTypewriterScale()) / 100
3332 os << "\\setmonofont{"
3339 bool const ot1 = (main_font_encoding() == "default" || main_font_encoding() == "OT1");
3340 bool const dryrun = features.runparams().dryrun;
3341 bool const complete = (fontsSans() == "default" && fontsTypewriter() == "default");
3342 bool const nomath = (fontsMath() == "default");
3345 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsRoman())).getLaTeXCode(
3346 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3350 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsSans())).getLaTeXCode(
3351 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3352 nomath, fontsSansScale());
3354 // MONOSPACED/TYPEWRITER
3355 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsTypewriter())).getLaTeXCode(
3356 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3357 nomath, fontsTypewriterScale());
3360 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsMath())).getLaTeXCode(
3361 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3368 Encoding const & BufferParams::encoding() const
3370 // Main encoding for LaTeX output.
3372 // Exception: XeTeX with 8-bit TeX fonts requires ASCII (see #9740).
3373 // As the "flavor" is only known once export started, this
3374 // cannot be handled here. Instead, runparams.encoding is set
3375 // to ASCII in Buffer::makeLaTeXFile (for export)
3376 // and Buffer::writeLaTeXSource (for preview).
3378 return *(encodings.fromLyXName("utf8-plain"));
3379 if (inputenc == "auto" || inputenc == "default")
3380 return *language->encoding();
3381 Encoding const * const enc = encodings.fromLyXName(inputenc);
3384 LYXERR0("Unknown inputenc value `" << inputenc
3385 << "'. Using `auto' instead.");
3386 return *language->encoding();
3390 bool BufferParams::addCiteEngine(string const & engine)
3392 LayoutModuleList::const_iterator it = cite_engine_.begin();
3393 LayoutModuleList::const_iterator en = cite_engine_.end();
3394 for (; it != en; ++it)
3397 cite_engine_.push_back(engine);
3402 bool BufferParams::addCiteEngine(vector<string> const & engine)
3404 vector<string>::const_iterator it = engine.begin();
3405 vector<string>::const_iterator en = engine.end();
3407 for (; it != en; ++it)
3408 if (!addCiteEngine(*it))
3414 string const & BufferParams::defaultBiblioStyle() const
3416 map<string, string> const & bs = documentClass().defaultBiblioStyle();
3417 auto cit = bs.find(theCiteEnginesList.getTypeAsString(citeEngineType()));
3418 if (cit != bs.end())
3421 return empty_string();
3425 bool const & BufferParams::fullAuthorList() const
3427 return documentClass().fullAuthorList();
3431 string BufferParams::getCiteAlias(string const & s) const
3433 vector<string> commands =
3434 documentClass().citeCommands(citeEngineType());
3435 // If it is a real command, don't treat it as an alias
3436 if (find(commands.begin(), commands.end(), s) != commands.end())
3438 map<string,string> aliases = documentClass().citeCommandAliases();
3439 if (aliases.find(s) != aliases.end())
3445 void BufferParams::setCiteEngine(string const & engine)
3448 addCiteEngine(engine);
3452 void BufferParams::setCiteEngine(vector<string> const & engine)
3455 addCiteEngine(engine);
3459 vector<string> BufferParams::citeCommands() const
3461 static CitationStyle const default_style;
3462 vector<string> commands =
3463 documentClass().citeCommands(citeEngineType());
3464 if (commands.empty())
3465 commands.push_back(default_style.name);
3470 vector<CitationStyle> BufferParams::citeStyles() const
3472 static CitationStyle const default_style;
3473 vector<CitationStyle> styles =
3474 documentClass().citeStyles(citeEngineType());
3476 styles.push_back(default_style);
3481 string const BufferParams::bibtexCommand() const
3483 // Return document-specific setting if available
3484 if (bibtex_command != "default")
3485 return bibtex_command;
3487 // If we have "default" in document settings, consult the prefs
3488 // 1. Japanese (uses a specific processor)
3489 if (encoding().package() == Encoding::japanese) {
3490 if (lyxrc.jbibtex_command != "automatic")
3491 // Return the specified program, if "automatic" is not set
3492 return lyxrc.jbibtex_command;
3493 else if (!useBiblatex()) {
3494 // With classic BibTeX, return pbibtex, jbibtex, bibtex
3495 if (lyxrc.jbibtex_alternatives.find("pbibtex") != lyxrc.jbibtex_alternatives.end())
3497 if (lyxrc.jbibtex_alternatives.find("jbibtex") != lyxrc.jbibtex_alternatives.end())
3502 // 2. All other languages
3503 else if (lyxrc.bibtex_command != "automatic")
3504 // Return the specified program, if "automatic" is not set
3505 return lyxrc.bibtex_command;
3507 // 3. Automatic: find the most suitable for the current cite framework
3508 if (useBiblatex()) {
3509 // For Biblatex, we prefer biber (also for Japanese)
3510 // and fall back to bibtex8 and, as last resort, bibtex
3511 if (lyxrc.bibtex_alternatives.find("biber") != lyxrc.bibtex_alternatives.end())
3513 else if (lyxrc.bibtex_alternatives.find("bibtex8") != lyxrc.bibtex_alternatives.end())
3520 bool BufferParams::useBiblatex() const
3522 return theCiteEnginesList[citeEngine().list().front()]
3523 ->getCiteFramework() == "biblatex";
3527 void BufferParams::invalidateConverterCache() const
3529 pimpl_->isExportCacheValid = false;
3530 pimpl_->isViewCacheValid = false;