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;
462 shell_escape = false;
467 // map current author
468 author_map_[pimpl_->authorlist.get(0).bufferId()] = 0;
472 docstring BufferParams::B_(string const & l10n) const
474 LASSERT(language, return from_utf8(l10n));
475 return getMessages(language->code()).get(l10n);
479 BufferParams::Package BufferParams::use_package(std::string const & p) const
481 PackageMap::const_iterator it = use_packages.find(p);
482 if (it == use_packages.end())
488 void BufferParams::use_package(std::string const & p, BufferParams::Package u)
494 map<string, string> const & BufferParams::auto_packages()
496 static map<string, string> packages;
497 if (packages.empty()) {
498 // We could have a race condition here that two threads
499 // discover an empty map at the same time and want to fill
500 // it, but that is no problem, since the same contents is
501 // filled in twice then. Having the locker inside the
502 // packages.empty() condition has the advantage that we
503 // don't need the mutex overhead for simple reading.
505 Mutex::Locker locker(&mutex);
506 // adding a package here implies a file format change!
507 packages["amsmath"] =
508 N_("The LaTeX package amsmath is only used if AMS formula types or symbols from the AMS math toolbars are inserted into formulas");
509 packages["amssymb"] =
510 N_("The LaTeX package amssymb is only used if symbols from the AMS math toolbars are inserted into formulas");
512 N_("The LaTeX package cancel is only used if \\cancel commands are used in formulas");
514 N_("The LaTeX package esint is only used if special integral symbols are inserted into formulas");
515 packages["mathdots"] =
516 N_("The LaTeX package mathdots is only used if the command \\iddots is inserted into formulas");
517 packages["mathtools"] =
518 N_("The LaTeX package mathtools is only used if some mathematical relations are inserted into formulas");
520 N_("The LaTeX package mhchem is only used if either the command \\ce or \\cf is inserted into formulas");
521 packages["stackrel"] =
522 N_("The LaTeX package stackrel is only used if the command \\stackrel with subscript is inserted into formulas");
523 packages["stmaryrd"] =
524 N_("The LaTeX package stmaryrd is only used if symbols from the St Mary's Road symbol font for theoretical computer science are inserted into formulas");
525 packages["undertilde"] =
526 N_("The LaTeX package undertilde is only used if you use the math frame decoration 'utilde'");
532 bool BufferParams::useBibtopic() const
536 return (use_bibtopic || (!multibib.empty() && multibib != "child"));
540 AuthorList & BufferParams::authors()
542 return pimpl_->authorlist;
546 AuthorList const & BufferParams::authors() const
548 return pimpl_->authorlist;
552 void BufferParams::addAuthor(Author a)
554 author_map_[a.bufferId()] = pimpl_->authorlist.record(a);
558 BranchList & BufferParams::branchlist()
560 return pimpl_->branchlist;
564 BranchList const & BufferParams::branchlist() const
566 return pimpl_->branchlist;
570 IndicesList & BufferParams::indiceslist()
572 return pimpl_->indiceslist;
576 IndicesList const & BufferParams::indiceslist() const
578 return pimpl_->indiceslist;
582 Bullet & BufferParams::temp_bullet(lyx::size_type const index)
584 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
585 return pimpl_->temp_bullets[index];
589 Bullet const & BufferParams::temp_bullet(lyx::size_type const index) const
591 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
592 return pimpl_->temp_bullets[index];
596 Bullet & BufferParams::user_defined_bullet(lyx::size_type const index)
598 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
599 return pimpl_->user_defined_bullets[index];
603 Bullet const & BufferParams::user_defined_bullet(lyx::size_type const index) const
605 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
606 return pimpl_->user_defined_bullets[index];
610 Spacing & BufferParams::spacing()
612 return pimpl_->spacing;
616 Spacing const & BufferParams::spacing() const
618 return pimpl_->spacing;
622 PDFOptions & BufferParams::pdfoptions()
624 return pimpl_->pdfoptions;
628 PDFOptions const & BufferParams::pdfoptions() const
630 return pimpl_->pdfoptions;
634 Length const & BufferParams::getMathIndent() const
636 return pimpl_->mathindent;
640 void BufferParams::setMathIndent(Length const & indent)
642 pimpl_->mathindent = indent;
646 Length const & BufferParams::getParIndent() const
648 return pimpl_->parindent;
652 void BufferParams::setParIndent(Length const & indent)
654 pimpl_->parindent = indent;
658 VSpace const & BufferParams::getDefSkip() const
660 return pimpl_->defskip;
664 void BufferParams::setDefSkip(VSpace const & vs)
666 // DEFSKIP will cause an infinite loop
667 LASSERT(vs.kind() != VSpace::DEFSKIP, return);
668 pimpl_->defskip = vs;
672 BufferParams::MathNumber BufferParams::getMathNumber() const
674 if (math_numbering_side != DEFAULT)
675 return math_numbering_side;
676 // FIXME: do not hardcode language here
677 else if (language->lang() == "arabic_arabi"
678 || documentClass().provides("leqno"))
685 string BufferParams::readToken(Lexer & lex, string const & token,
686 FileName const & filepath)
690 if (token == "\\textclass") {
692 string const classname = lex.getString();
693 // if there exists a local layout file, ignore the system one
694 // NOTE: in this case, the textclass (.cls file) is assumed to
697 LayoutFileList & bcl = LayoutFileList::get();
698 if (!filepath.empty()) {
699 // If classname is an absolute path, the document is
700 // using a local layout file which could not be accessed
701 // by a relative path. In this case the path is correct
702 // even if the document was moved to a different
703 // location. However, we will have a problem if the
704 // document was generated on a different platform.
705 bool isabsolute = FileName::isAbsolute(classname);
706 string const classpath = onlyPath(classname);
707 string const path = isabsolute ? classpath
708 : FileName(addPath(filepath.absFileName(),
709 classpath)).realPath();
710 string const oldpath = isabsolute ? string()
711 : FileName(addPath(origin, classpath)).realPath();
712 tcp = bcl.addLocalLayout(onlyFileName(classname), path, oldpath);
714 // that returns non-empty if a "local" layout file is found.
716 result = to_utf8(makeRelPath(from_utf8(onlyPath(tcp)),
717 from_utf8(filepath.absFileName())));
720 setBaseClass(onlyFileName(tcp));
722 setBaseClass(onlyFileName(classname));
723 // We assume that a tex class exists for local or unknown
724 // layouts so this warning, will only be given for system layouts.
725 if (!baseClass()->isTeXClassAvailable()) {
726 docstring const desc =
727 translateIfPossible(from_utf8(baseClass()->description()));
728 docstring const prereqs =
729 from_utf8(baseClass()->prerequisites());
730 docstring const msg =
731 bformat(_("The selected document class\n"
733 "requires external files that are not available.\n"
734 "The document class can still be used, but the\n"
735 "document cannot be compiled until the following\n"
736 "prerequisites are installed:\n"
738 "See section 3.1.2.2 (Class Availability) of the\n"
739 "User's Guide for more information."), desc, prereqs);
740 frontend::Alert::warning(_("Document class not available"),
743 } else if (token == "\\save_transient_properties") {
744 lex >> save_transient_properties;
745 } else if (token == "\\origin") {
747 origin = lex.getString();
748 string const sysdirprefix = "/systemlyxdir/";
749 if (prefixIs(origin, sysdirprefix)) {
751 if (inSystemDir(filepath, docsys))
752 origin.replace(0, sysdirprefix.length() - 1, docsys);
754 origin.replace(0, sysdirprefix.length() - 1,
755 package().system_support().absFileName());
757 } else if (token == "\\begin_preamble") {
759 } else if (token == "\\begin_local_layout") {
760 readLocalLayout(lex, false);
761 } else if (token == "\\begin_forced_local_layout") {
762 readLocalLayout(lex, true);
763 } else if (token == "\\begin_modules") {
765 } else if (token == "\\begin_removed_modules") {
766 readRemovedModules(lex);
767 } else if (token == "\\begin_includeonly") {
768 readIncludeonly(lex);
769 } else if (token == "\\maintain_unincluded_children") {
770 lex >> maintain_unincluded_children;
771 } else if (token == "\\options") {
773 options = lex.getString();
774 } else if (token == "\\use_default_options") {
775 lex >> use_default_options;
776 } else if (token == "\\master") {
778 master = lex.getString();
779 if (!filepath.empty() && FileName::isAbsolute(origin)) {
780 bool const isabs = FileName::isAbsolute(master);
781 FileName const abspath(isabs ? master : origin + master);
782 bool const moved = filepath != FileName(origin);
783 if (moved && abspath.exists()) {
784 docstring const path = isabs
786 : from_utf8(abspath.realPath());
787 docstring const refpath =
788 from_utf8(filepath.absFileName());
789 master = to_utf8(makeRelPath(path, refpath));
792 } else if (token == "\\suppress_date") {
793 lex >> suppress_date;
794 } else if (token == "\\justification") {
795 lex >> justification;
796 } else if (token == "\\language") {
798 } else if (token == "\\language_package") {
800 lang_package = lex.getString();
801 } else if (token == "\\inputencoding") {
803 } else if (token == "\\graphics") {
804 readGraphicsDriver(lex);
805 } else if (token == "\\default_output_format") {
806 lex >> default_output_format;
807 } else if (token == "\\bibtex_command") {
809 bibtex_command = lex.getString();
810 } else if (token == "\\index_command") {
812 index_command = lex.getString();
813 } else if (token == "\\fontencoding") {
815 fontenc = lex.getString();
816 } else if (token == "\\font_roman") {
817 lex >> fonts_roman[0];
818 lex >> fonts_roman[1];
819 } else if (token == "\\font_sans") {
820 lex >> fonts_sans[0];
821 lex >> fonts_sans[1];
822 } else if (token == "\\font_typewriter") {
823 lex >> fonts_typewriter[0];
824 lex >> fonts_typewriter[1];
825 } else if (token == "\\font_math") {
826 lex >> fonts_math[0];
827 lex >> fonts_math[1];
828 } else if (token == "\\font_default_family") {
829 lex >> fonts_default_family;
830 } else if (token == "\\use_non_tex_fonts") {
831 lex >> useNonTeXFonts;
832 } else if (token == "\\font_sc") {
833 lex >> fonts_expert_sc;
834 } else if (token == "\\font_osf") {
835 lex >> fonts_old_figures;
836 } else if (token == "\\font_sf_scale") {
837 lex >> fonts_sans_scale[0];
838 lex >> fonts_sans_scale[1];
839 } else if (token == "\\font_tt_scale") {
840 lex >> fonts_typewriter_scale[0];
841 lex >> fonts_typewriter_scale[1];
842 } else if (token == "\\font_cjk") {
844 } else if (token == "\\use_microtype") {
845 lex >> use_microtype;
846 } else if (token == "\\use_dash_ligatures") {
847 lex >> use_dash_ligatures;
848 } else if (token == "\\paragraph_separation") {
851 paragraph_separation = parseptranslator().find(parsep);
852 } else if (token == "\\paragraph_indentation") {
854 string parindent = lex.getString();
855 if (parindent == "default")
856 pimpl_->parindent = Length();
858 pimpl_->parindent = Length(parindent);
859 } else if (token == "\\defskip") {
861 string const defskip = lex.getString();
862 pimpl_->defskip = VSpace(defskip);
863 if (pimpl_->defskip.kind() == VSpace::DEFSKIP)
865 pimpl_->defskip = VSpace(VSpace::MEDSKIP);
866 } else if (token == "\\is_math_indent") {
867 lex >> is_math_indent;
868 } else if (token == "\\math_indentation") {
870 string mathindent = lex.getString();
871 if (mathindent == "default")
872 pimpl_->mathindent = Length();
874 pimpl_->mathindent = Length(mathindent);
875 } else if (token == "\\math_numbering_side") {
879 math_numbering_side = LEFT;
880 else if (tmp == "right")
881 math_numbering_side = RIGHT;
883 math_numbering_side = DEFAULT;
884 } else if (token == "\\quotes_style") {
887 quotes_style = quotesstyletranslator().find(qstyle);
888 } else if (token == "\\dynamic_quotes") {
889 lex >> dynamic_quotes;
890 } else if (token == "\\papersize") {
893 papersize = papersizetranslator().find(ppsize);
894 } else if (token == "\\use_geometry") {
896 } else if (token == "\\use_package") {
901 use_package(package, packagetranslator().find(use));
902 } else if (token == "\\cite_engine") {
904 vector<string> engine = getVectorFromString(lex.getString());
905 setCiteEngine(engine);
906 } else if (token == "\\cite_engine_type") {
909 cite_engine_type_ = theCiteEnginesList.getType(engine_type);
910 } else if (token == "\\biblio_style") {
912 biblio_style = lex.getString();
913 } else if (token == "\\biblio_options") {
915 biblio_opts = trim(lex.getString());
916 } else if (token == "\\biblatex_bibstyle") {
918 biblatex_bibstyle = trim(lex.getString());
919 } else if (token == "\\biblatex_citestyle") {
921 biblatex_citestyle = trim(lex.getString());
922 } else if (token == "\\use_bibtopic") {
924 } else if (token == "\\multibib") {
926 } else if (token == "\\use_indices") {
928 } else if (token == "\\tracking_changes") {
929 lex >> track_changes;
930 } else if (token == "\\output_changes") {
931 lex >> output_changes;
932 } else if (token == "\\branch") {
934 docstring branch = lex.getDocString();
935 branchlist().add(branch);
938 string const tok = lex.getString();
939 if (tok == "\\end_branch")
941 Branch * branch_ptr = branchlist().find(branch);
942 if (tok == "\\selected") {
945 branch_ptr->setSelected(lex.getInteger());
947 if (tok == "\\filename_suffix") {
950 branch_ptr->setFileNameSuffix(lex.getInteger());
952 if (tok == "\\color") {
954 string color = lex.getString();
956 branch_ptr->setColor(color);
957 // Update also the Color table:
959 color = lcolor.getX11Name(Color_background);
961 lcolor.setColor(to_utf8(branch), color);
964 } else if (token == "\\index") {
966 docstring index = lex.getDocString();
968 indiceslist().add(index);
971 string const tok = lex.getString();
972 if (tok == "\\end_index")
974 Index * index_ptr = indiceslist().find(index);
975 if (tok == "\\shortcut") {
977 shortcut = lex.getDocString();
979 index_ptr->setShortcut(shortcut);
981 if (tok == "\\color") {
983 string color = lex.getString();
985 index_ptr->setColor(color);
986 // Update also the Color table:
988 color = lcolor.getX11Name(Color_background);
990 if (!shortcut.empty())
991 lcolor.setColor(to_utf8(shortcut), color);
994 } else if (token == "\\author") {
996 istringstream ss(lex.getString());
1000 } else if (token == "\\paperorientation") {
1003 orientation = paperorientationtranslator().find(orient);
1004 } else if (token == "\\backgroundcolor") {
1006 backgroundcolor = lyx::rgbFromHexName(lex.getString());
1007 isbackgroundcolor = true;
1008 } else if (token == "\\fontcolor") {
1010 fontcolor = lyx::rgbFromHexName(lex.getString());
1012 } else if (token == "\\notefontcolor") {
1014 string color = lex.getString();
1015 notefontcolor = lyx::rgbFromHexName(color);
1016 lcolor.setColor("notefontcolor", color);
1017 } else if (token == "\\boxbgcolor") {
1019 string color = lex.getString();
1020 boxbgcolor = lyx::rgbFromHexName(color);
1021 lcolor.setColor("boxbgcolor", color);
1022 } else if (token == "\\paperwidth") {
1024 } else if (token == "\\paperheight") {
1026 } else if (token == "\\leftmargin") {
1028 } else if (token == "\\topmargin") {
1030 } else if (token == "\\rightmargin") {
1032 } else if (token == "\\bottommargin") {
1033 lex >> bottommargin;
1034 } else if (token == "\\headheight") {
1036 } else if (token == "\\headsep") {
1038 } else if (token == "\\footskip") {
1040 } else if (token == "\\columnsep") {
1042 } else if (token == "\\paperfontsize") {
1044 } else if (token == "\\papercolumns") {
1046 } else if (token == "\\listings_params") {
1049 listings_params = InsetListingsParams(par).params();
1050 } else if (token == "\\papersides") {
1053 sides = sidestranslator().find(psides);
1054 } else if (token == "\\paperpagestyle") {
1056 } else if (token == "\\bullet") {
1058 } else if (token == "\\bulletLaTeX") {
1059 readBulletsLaTeX(lex);
1060 } else if (token == "\\secnumdepth") {
1062 } else if (token == "\\tocdepth") {
1064 } else if (token == "\\spacing") {
1068 if (nspacing == "other") {
1071 spacing().set(spacetranslator().find(nspacing), tmp_val);
1072 } else if (token == "\\float_placement") {
1073 lex >> float_placement;
1075 } else if (prefixIs(token, "\\pdf_") || token == "\\use_hyperref") {
1076 string toktmp = pdfoptions().readToken(lex, token);
1077 if (!toktmp.empty()) {
1078 lyxerr << "PDFOptions::readToken(): Unknown token: " <<
1082 } else if (token == "\\html_math_output") {
1085 html_math_output = static_cast<MathOutput>(temp);
1086 } else if (token == "\\html_be_strict") {
1087 lex >> html_be_strict;
1088 } else if (token == "\\html_css_as_file") {
1089 lex >> html_css_as_file;
1090 } else if (token == "\\html_math_img_scale") {
1091 lex >> html_math_img_scale;
1092 } else if (token == "\\html_latex_start") {
1094 html_latex_start = lex.getString();
1095 } else if (token == "\\html_latex_end") {
1097 html_latex_end = lex.getString();
1098 } else if (token == "\\output_sync") {
1100 } else if (token == "\\output_sync_macro") {
1101 lex >> output_sync_macro;
1102 } else if (token == "\\use_refstyle") {
1103 lex >> use_refstyle;
1104 } else if (token == "\\use_minted") {
1107 lyxerr << "BufferParams::readToken(): Unknown token: " <<
1117 // Quote argument if it contains spaces
1118 string quoteIfNeeded(string const & str) {
1119 if (contains(str, ' '))
1120 return "\"" + str + "\"";
1126 void BufferParams::writeFile(ostream & os, Buffer const * buf) const
1128 // The top of the file is written by the buffer.
1129 // Prints out the buffer info into the .lyx file given by file
1131 os << "\\save_transient_properties "
1132 << convert<string>(save_transient_properties) << '\n';
1134 // the document directory (must end with a path separator)
1135 // realPath() is used to resolve symlinks, while addPath(..., "")
1136 // ensures a trailing path separator.
1138 string filepath = addPath(buf->fileName().onlyPath().realPath(), "");
1139 string const sysdir = inSystemDir(FileName(filepath), docsys) ? docsys
1140 : addPath(package().system_support().realPath(), "");
1141 string const relpath =
1142 to_utf8(makeRelPath(from_utf8(filepath), from_utf8(sysdir)));
1143 if (!prefixIs(relpath, "../") && !FileName::isAbsolute(relpath))
1144 filepath = addPath("/systemlyxdir", relpath);
1145 else if (!save_transient_properties || !lyxrc.save_origin)
1146 filepath = "unavailable";
1147 os << "\\origin " << quoteIfNeeded(filepath) << '\n';
1150 os << "\\textclass "
1151 << quoteIfNeeded(buf->includedFilePath(addName(buf->layoutPos(),
1152 baseClass()->name()), "layout"))
1155 // then the preamble
1156 if (!preamble.empty()) {
1157 // remove '\n' from the end of preamble
1158 docstring const tmppreamble = rtrim(preamble, "\n");
1159 os << "\\begin_preamble\n"
1160 << to_utf8(tmppreamble)
1161 << "\n\\end_preamble\n";
1165 if (!options.empty()) {
1166 os << "\\options " << options << '\n';
1169 // use the class options defined in the layout?
1170 os << "\\use_default_options "
1171 << convert<string>(use_default_options) << "\n";
1173 // the master document
1174 if (!master.empty()) {
1175 os << "\\master " << master << '\n';
1179 if (!removed_modules_.empty()) {
1180 os << "\\begin_removed_modules" << '\n';
1181 list<string>::const_iterator it = removed_modules_.begin();
1182 list<string>::const_iterator en = removed_modules_.end();
1183 for (; it != en; ++it)
1185 os << "\\end_removed_modules" << '\n';
1189 if (!layout_modules_.empty()) {
1190 os << "\\begin_modules" << '\n';
1191 LayoutModuleList::const_iterator it = layout_modules_.begin();
1192 LayoutModuleList::const_iterator en = layout_modules_.end();
1193 for (; it != en; ++it)
1195 os << "\\end_modules" << '\n';
1199 if (!included_children_.empty()) {
1200 os << "\\begin_includeonly" << '\n';
1201 list<string>::const_iterator it = included_children_.begin();
1202 list<string>::const_iterator en = included_children_.end();
1203 for (; it != en; ++it)
1205 os << "\\end_includeonly" << '\n';
1207 os << "\\maintain_unincluded_children "
1208 << convert<string>(maintain_unincluded_children) << '\n';
1210 // local layout information
1211 docstring const local_layout = getLocalLayout(false);
1212 if (!local_layout.empty()) {
1213 // remove '\n' from the end
1214 docstring const tmplocal = rtrim(local_layout, "\n");
1215 os << "\\begin_local_layout\n"
1216 << to_utf8(tmplocal)
1217 << "\n\\end_local_layout\n";
1219 docstring const forced_local_layout = getLocalLayout(true);
1220 if (!forced_local_layout.empty()) {
1221 // remove '\n' from the end
1222 docstring const tmplocal = rtrim(forced_local_layout, "\n");
1223 os << "\\begin_forced_local_layout\n"
1224 << to_utf8(tmplocal)
1225 << "\n\\end_forced_local_layout\n";
1228 // then the text parameters
1229 if (language != ignore_language)
1230 os << "\\language " << language->lang() << '\n';
1231 os << "\\language_package " << lang_package
1232 << "\n\\inputencoding " << inputenc
1233 << "\n\\fontencoding " << fontenc
1234 << "\n\\font_roman \"" << fonts_roman[0]
1235 << "\" \"" << fonts_roman[1] << '"'
1236 << "\n\\font_sans \"" << fonts_sans[0]
1237 << "\" \"" << fonts_sans[1] << '"'
1238 << "\n\\font_typewriter \"" << fonts_typewriter[0]
1239 << "\" \"" << fonts_typewriter[1] << '"'
1240 << "\n\\font_math \"" << fonts_math[0]
1241 << "\" \"" << fonts_math[1] << '"'
1242 << "\n\\font_default_family " << fonts_default_family
1243 << "\n\\use_non_tex_fonts " << convert<string>(useNonTeXFonts)
1244 << "\n\\font_sc " << convert<string>(fonts_expert_sc)
1245 << "\n\\font_osf " << convert<string>(fonts_old_figures)
1246 << "\n\\font_sf_scale " << fonts_sans_scale[0]
1247 << ' ' << fonts_sans_scale[1]
1248 << "\n\\font_tt_scale " << fonts_typewriter_scale[0]
1249 << ' ' << fonts_typewriter_scale[1]
1251 if (!fonts_cjk.empty()) {
1252 os << "\\font_cjk " << fonts_cjk << '\n';
1254 os << "\\use_microtype " << convert<string>(use_microtype) << '\n';
1255 os << "\\use_dash_ligatures " << convert<string>(use_dash_ligatures) << '\n';
1256 os << "\\graphics " << graphics_driver << '\n';
1257 os << "\\default_output_format " << default_output_format << '\n';
1258 os << "\\output_sync " << output_sync << '\n';
1259 if (!output_sync_macro.empty())
1260 os << "\\output_sync_macro \"" << output_sync_macro << "\"\n";
1261 os << "\\bibtex_command " << bibtex_command << '\n';
1262 os << "\\index_command " << index_command << '\n';
1264 if (!float_placement.empty()) {
1265 os << "\\float_placement " << float_placement << '\n';
1267 os << "\\paperfontsize " << fontsize << '\n';
1269 spacing().writeFile(os);
1270 pdfoptions().writeFile(os);
1272 os << "\\papersize " << string_papersize[papersize]
1273 << "\n\\use_geometry " << convert<string>(use_geometry);
1274 map<string, string> const & packages = auto_packages();
1275 for (map<string, string>::const_iterator it = packages.begin();
1276 it != packages.end(); ++it)
1277 os << "\n\\use_package " << it->first << ' '
1278 << use_package(it->first);
1280 os << "\n\\cite_engine ";
1282 if (!cite_engine_.empty()) {
1283 LayoutModuleList::const_iterator be = cite_engine_.begin();
1284 LayoutModuleList::const_iterator en = cite_engine_.end();
1285 for (LayoutModuleList::const_iterator it = be; it != en; ++it) {
1294 os << "\n\\cite_engine_type " << theCiteEnginesList.getTypeAsString(cite_engine_type_);
1296 if (!biblio_style.empty())
1297 os << "\n\\biblio_style " << biblio_style;
1298 if (!biblio_opts.empty())
1299 os << "\n\\biblio_options " << biblio_opts;
1300 if (!biblatex_bibstyle.empty())
1301 os << "\n\\biblatex_bibstyle " << biblatex_bibstyle;
1302 if (!biblatex_citestyle.empty())
1303 os << "\n\\biblatex_citestyle " << biblatex_citestyle;
1304 if (!multibib.empty())
1305 os << "\n\\multibib " << multibib;
1307 os << "\n\\use_bibtopic " << convert<string>(use_bibtopic)
1308 << "\n\\use_indices " << convert<string>(use_indices)
1309 << "\n\\paperorientation " << string_orientation[orientation]
1310 << "\n\\suppress_date " << convert<string>(suppress_date)
1311 << "\n\\justification " << convert<string>(justification)
1312 << "\n\\use_refstyle " << use_refstyle
1313 << "\n\\use_minted " << use_minted
1315 if (isbackgroundcolor == true)
1316 os << "\\backgroundcolor " << lyx::X11hexname(backgroundcolor) << '\n';
1317 if (isfontcolor == true)
1318 os << "\\fontcolor " << lyx::X11hexname(fontcolor) << '\n';
1319 if (notefontcolor != lyx::rgbFromHexName("#cccccc"))
1320 os << "\\notefontcolor " << lyx::X11hexname(notefontcolor) << '\n';
1321 if (boxbgcolor != lyx::rgbFromHexName("#ff0000"))
1322 os << "\\boxbgcolor " << lyx::X11hexname(boxbgcolor) << '\n';
1324 BranchList::const_iterator it = branchlist().begin();
1325 BranchList::const_iterator end = branchlist().end();
1326 for (; it != end; ++it) {
1327 os << "\\branch " << to_utf8(it->branch())
1328 << "\n\\selected " << it->isSelected()
1329 << "\n\\filename_suffix " << it->hasFileNameSuffix()
1330 << "\n\\color " << lyx::X11hexname(it->color())
1335 IndicesList::const_iterator iit = indiceslist().begin();
1336 IndicesList::const_iterator iend = indiceslist().end();
1337 for (; iit != iend; ++iit) {
1338 os << "\\index " << to_utf8(iit->index())
1339 << "\n\\shortcut " << to_utf8(iit->shortcut())
1340 << "\n\\color " << lyx::X11hexname(iit->color())
1345 if (!paperwidth.empty())
1346 os << "\\paperwidth "
1347 << VSpace(paperwidth).asLyXCommand() << '\n';
1348 if (!paperheight.empty())
1349 os << "\\paperheight "
1350 << VSpace(paperheight).asLyXCommand() << '\n';
1351 if (!leftmargin.empty())
1352 os << "\\leftmargin "
1353 << VSpace(leftmargin).asLyXCommand() << '\n';
1354 if (!topmargin.empty())
1355 os << "\\topmargin "
1356 << VSpace(topmargin).asLyXCommand() << '\n';
1357 if (!rightmargin.empty())
1358 os << "\\rightmargin "
1359 << VSpace(rightmargin).asLyXCommand() << '\n';
1360 if (!bottommargin.empty())
1361 os << "\\bottommargin "
1362 << VSpace(bottommargin).asLyXCommand() << '\n';
1363 if (!headheight.empty())
1364 os << "\\headheight "
1365 << VSpace(headheight).asLyXCommand() << '\n';
1366 if (!headsep.empty())
1368 << VSpace(headsep).asLyXCommand() << '\n';
1369 if (!footskip.empty())
1371 << VSpace(footskip).asLyXCommand() << '\n';
1372 if (!columnsep.empty())
1373 os << "\\columnsep "
1374 << VSpace(columnsep).asLyXCommand() << '\n';
1375 os << "\\secnumdepth " << secnumdepth
1376 << "\n\\tocdepth " << tocdepth
1377 << "\n\\paragraph_separation "
1378 << string_paragraph_separation[paragraph_separation];
1379 if (!paragraph_separation)
1380 os << "\n\\paragraph_indentation "
1381 << (getParIndent().empty() ? "default" : getParIndent().asString());
1383 os << "\n\\defskip " << getDefSkip().asLyXCommand();
1384 os << "\n\\is_math_indent " << is_math_indent;
1386 os << "\n\\math_indentation "
1387 << (getMathIndent().empty() ? "default" : getMathIndent().asString());
1388 os << "\n\\math_numbering_side ";
1389 switch(math_numbering_side) {
1399 os << "\n\\quotes_style "
1400 << string_quotes_style[quotes_style]
1401 << "\n\\dynamic_quotes " << dynamic_quotes
1402 << "\n\\papercolumns " << columns
1403 << "\n\\papersides " << sides
1404 << "\n\\paperpagestyle " << pagestyle << '\n';
1405 if (!listings_params.empty())
1406 os << "\\listings_params \"" <<
1407 InsetListingsParams(listings_params).encodedString() << "\"\n";
1408 for (int i = 0; i < 4; ++i) {
1409 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1410 if (user_defined_bullet(i).getFont() != -1) {
1411 os << "\\bullet " << i << " "
1412 << user_defined_bullet(i).getFont() << " "
1413 << user_defined_bullet(i).getCharacter() << " "
1414 << user_defined_bullet(i).getSize() << "\n";
1418 os << "\\bulletLaTeX " << i << " \""
1419 << lyx::to_ascii(user_defined_bullet(i).getText())
1425 os << "\\tracking_changes "
1426 << (save_transient_properties ? convert<string>(track_changes) : "false")
1429 os << "\\output_changes "
1430 << (save_transient_properties ? convert<string>(output_changes) : "false")
1433 os << "\\html_math_output " << html_math_output << '\n'
1434 << "\\html_css_as_file " << html_css_as_file << '\n'
1435 << "\\html_be_strict " << convert<string>(html_be_strict) << '\n';
1437 if (html_math_img_scale != 1.0)
1438 os << "\\html_math_img_scale " << convert<string>(html_math_img_scale) << '\n';
1439 if (!html_latex_start.empty())
1440 os << "\\html_latex_start " << html_latex_start << '\n';
1441 if (!html_latex_end.empty())
1442 os << "\\html_latex_end " << html_latex_end << '\n';
1444 os << pimpl_->authorlist;
1448 void BufferParams::validate(LaTeXFeatures & features) const
1450 features.require(documentClass().requires());
1452 if (columns > 1 && language->rightToLeft())
1453 features.require("rtloutputdblcol");
1455 if (output_changes) {
1456 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1457 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1458 LaTeXFeatures::isAvailable("xcolor");
1460 switch (features.runparams().flavor) {
1461 case OutputParams::LATEX:
1462 case OutputParams::DVILUATEX:
1464 features.require("ct-dvipost");
1465 features.require("dvipost");
1466 } else if (xcolorulem) {
1467 features.require("ct-xcolor-ulem");
1468 features.require("ulem");
1469 features.require("xcolor");
1471 features.require("ct-none");
1474 case OutputParams::LUATEX:
1475 case OutputParams::PDFLATEX:
1476 case OutputParams::XETEX:
1478 features.require("ct-xcolor-ulem");
1479 features.require("ulem");
1480 features.require("xcolor");
1481 // improves color handling in PDF output
1482 features.require("pdfcolmk");
1484 features.require("ct-none");
1492 // Floats with 'Here definitely' as default setting.
1493 if (float_placement.find('H') != string::npos)
1494 features.require("float");
1496 for (PackageMap::const_iterator it = use_packages.begin();
1497 it != use_packages.end(); ++it) {
1498 if (it->first == "amsmath") {
1499 // AMS Style is at document level
1500 if (it->second == package_on ||
1501 features.isProvided("amsmath"))
1502 features.require(it->first);
1503 } else if (it->second == package_on)
1504 features.require(it->first);
1507 // Document-level line spacing
1508 if (spacing().getSpace() != Spacing::Single && !spacing().isDefault())
1509 features.require("setspace");
1511 // the bullet shapes are buffer level not paragraph level
1512 // so they are tested here
1513 for (int i = 0; i < 4; ++i) {
1514 if (user_defined_bullet(i) == ITEMIZE_DEFAULTS[i])
1516 int const font = user_defined_bullet(i).getFont();
1518 int const c = user_defined_bullet(i).getCharacter();
1524 features.require("latexsym");
1526 } else if (font == 1) {
1527 features.require("amssymb");
1528 } else if (font >= 2 && font <= 5) {
1529 features.require("pifont");
1533 if (pdfoptions().use_hyperref) {
1534 features.require("hyperref");
1535 // due to interferences with babel and hyperref, the color package has to
1536 // be loaded after hyperref when hyperref is used with the colorlinks
1537 // option, see http://www.lyx.org/trac/ticket/5291
1538 if (pdfoptions().colorlinks)
1539 features.require("color");
1541 if (!listings_params.empty()) {
1542 // do not test validity because listings_params is
1543 // supposed to be valid
1545 InsetListingsParams(listings_params).separatedParams(true);
1546 // we can't support all packages, but we should load the color package
1547 if (par.find("\\color", 0) != string::npos)
1548 features.require("color");
1551 // some languages are only available via polyglossia
1552 if (features.hasPolyglossiaExclusiveLanguages())
1553 features.require("polyglossia");
1555 if (useNonTeXFonts && fontsMath() != "auto")
1556 features.require("unicode-math");
1559 features.require("microtype");
1561 if (!language->requires().empty())
1562 features.require(language->requires());
1566 bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
1567 FileName const & filepath) const
1569 // http://www.tug.org/texmf-dist/doc/latex/base/fixltx2e.pdf
1570 // !! To use the Fix-cm package, load it before \documentclass, and use the command
1571 // \RequirePackage to do so, rather than the normal \usepackage
1572 // Do not try to load any other package before the document class, unless you
1573 // have a thorough understanding of the LATEX internals and know exactly what you
1575 if (features.mustProvide("fix-cm"))
1576 os << "\\RequirePackage{fix-cm}\n";
1577 // Likewise for fixltx2e. If other packages conflict with this policy,
1578 // treat it as a package bug (and report it!)
1579 // See http://www.latex-project.org/cgi-bin/ltxbugs2html?pr=latex/4407
1580 if (features.mustProvide("fixltx2e"))
1581 os << "\\RequirePackage{fixltx2e}\n";
1583 os << "\\documentclass";
1585 DocumentClass const & tclass = documentClass();
1587 ostringstream clsoptions; // the document class options.
1589 if (tokenPos(tclass.opt_fontsize(),
1590 '|', fontsize) >= 0) {
1591 // only write if existing in list (and not default)
1592 clsoptions << fontsize << "pt,";
1595 // all paper sizes except of A4, A5, B5 and the US sizes need the
1597 bool nonstandard_papersize = papersize != PAPER_DEFAULT
1598 && papersize != PAPER_USLETTER
1599 && papersize != PAPER_USLEGAL
1600 && papersize != PAPER_USEXECUTIVE
1601 && papersize != PAPER_A4
1602 && papersize != PAPER_A5
1603 && papersize != PAPER_B5;
1605 if (!use_geometry) {
1606 switch (papersize) {
1608 clsoptions << "a4paper,";
1610 case PAPER_USLETTER:
1611 clsoptions << "letterpaper,";
1614 clsoptions << "a5paper,";
1617 clsoptions << "b5paper,";
1619 case PAPER_USEXECUTIVE:
1620 clsoptions << "executivepaper,";
1623 clsoptions << "legalpaper,";
1657 if (sides != tclass.sides()) {
1660 clsoptions << "oneside,";
1663 clsoptions << "twoside,";
1669 if (columns != tclass.columns()) {
1671 clsoptions << "twocolumn,";
1673 clsoptions << "onecolumn,";
1677 && orientation == ORIENTATION_LANDSCAPE)
1678 clsoptions << "landscape,";
1681 clsoptions << "fleqn,";
1683 switch(math_numbering_side) {
1685 clsoptions << "leqno,";
1688 clsoptions << "reqno,";
1689 features.require("amsmath");
1695 // language should be a parameter to \documentclass
1696 if (language->babel() == "hebrew"
1697 && default_language->babel() != "hebrew")
1698 // This seems necessary
1699 features.useLanguage(default_language);
1701 ostringstream language_options;
1702 bool const use_babel = features.useBabel() && !features.isProvided("babel");
1703 bool const use_polyglossia = features.usePolyglossia();
1704 bool const global = lyxrc.language_global_options;
1705 if (use_babel || (use_polyglossia && global)) {
1706 language_options << features.getBabelLanguages();
1707 if (!language->babel().empty()) {
1708 if (!language_options.str().empty())
1709 language_options << ',';
1710 language_options << language->babel();
1712 if (global && !features.needBabelLangOptions()
1713 && !language_options.str().empty())
1714 clsoptions << language_options.str() << ',';
1717 // the predefined options from the layout
1718 if (use_default_options && !tclass.options().empty())
1719 clsoptions << tclass.options() << ',';
1721 // the user-defined options
1722 if (!options.empty()) {
1723 clsoptions << options << ',';
1726 string strOptions(clsoptions.str());
1727 if (!strOptions.empty()) {
1728 strOptions = rtrim(strOptions, ",");
1730 os << '[' << from_utf8(strOptions) << ']';
1733 os << '{' << from_ascii(tclass.latexname()) << "}\n";
1734 // end of \documentclass defs
1736 // if we use fontspec or newtxmath, we have to load the AMS packages here
1737 string const ams = features.loadAMSPackages();
1738 bool const ot1 = (main_font_encoding() == "default" || main_font_encoding() == "OT1");
1739 bool const use_newtxmath =
1740 theLaTeXFonts().getLaTeXFont(from_ascii(fontsMath())).getUsedPackage(
1741 ot1, false, false) == "newtxmath";
1742 if ((useNonTeXFonts || use_newtxmath) && !ams.empty())
1743 os << from_ascii(ams);
1745 if (useNonTeXFonts) {
1746 if (!features.isProvided("fontspec"))
1747 os << "\\usepackage{fontspec}\n";
1748 if (features.mustProvide("unicode-math")
1749 && features.isAvailable("unicode-math"))
1750 os << "\\usepackage{unicode-math}\n";
1753 // font selection must be done before loading fontenc.sty
1754 string const fonts = loadFonts(features);
1756 os << from_utf8(fonts);
1758 if (fonts_default_family != "default")
1759 os << "\\renewcommand{\\familydefault}{\\"
1760 << from_ascii(fonts_default_family) << "}\n";
1762 // set font encoding
1763 // XeTeX and LuaTeX (with OS fonts) do not need fontenc
1764 if (!useNonTeXFonts && !features.isProvided("fontenc")
1765 && main_font_encoding() != "default") {
1766 // get main font encodings
1767 vector<string> fontencs = font_encodings();
1768 // get font encodings of secondary languages
1769 features.getFontEncodings(fontencs);
1770 if (!fontencs.empty()) {
1771 os << "\\usepackage["
1772 << from_ascii(getStringFromVector(fontencs))
1777 // handle inputenc etc.
1778 writeEncodingPreamble(os, features);
1781 if (!features.runparams().includeall && !included_children_.empty()) {
1782 os << "\\includeonly{";
1783 list<string>::const_iterator it = included_children_.begin();
1784 list<string>::const_iterator en = included_children_.end();
1786 for (; it != en; ++it) {
1787 string incfile = *it;
1788 FileName inc = makeAbsPath(incfile, filepath.absFileName());
1789 string mangled = DocFileName(changeExtension(inc.absFileName(), ".tex")).
1791 if (!features.runparams().nice)
1793 // \includeonly doesn't want an extension
1794 incfile = changeExtension(incfile, string());
1795 incfile = support::latex_path(incfile);
1796 if (!incfile.empty()) {
1799 os << from_utf8(incfile);
1806 if (!features.isProvided("geometry")
1807 && (use_geometry || nonstandard_papersize)) {
1808 odocstringstream ods;
1809 if (!getGraphicsDriver("geometry").empty())
1810 ods << getGraphicsDriver("geometry");
1811 if (orientation == ORIENTATION_LANDSCAPE)
1812 ods << ",landscape";
1813 switch (papersize) {
1815 if (!paperwidth.empty())
1816 ods << ",paperwidth="
1817 << from_ascii(paperwidth);
1818 if (!paperheight.empty())
1819 ods << ",paperheight="
1820 << from_ascii(paperheight);
1822 case PAPER_USLETTER:
1823 ods << ",letterpaper";
1826 ods << ",legalpaper";
1828 case PAPER_USEXECUTIVE:
1829 ods << ",executivepaper";
1918 docstring const g_options = trim(ods.str(), ",");
1919 os << "\\usepackage";
1920 if (!g_options.empty())
1921 os << '[' << g_options << ']';
1922 os << "{geometry}\n";
1923 // output this only if use_geometry is true
1925 os << "\\geometry{verbose";
1926 if (!topmargin.empty())
1927 os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1928 if (!bottommargin.empty())
1929 os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1930 if (!leftmargin.empty())
1931 os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1932 if (!rightmargin.empty())
1933 os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1934 if (!headheight.empty())
1935 os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1936 if (!headsep.empty())
1937 os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1938 if (!footskip.empty())
1939 os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1940 if (!columnsep.empty())
1941 os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
1944 } else if (orientation == ORIENTATION_LANDSCAPE
1945 || papersize != PAPER_DEFAULT) {
1946 features.require("papersize");
1949 if (tokenPos(tclass.opt_pagestyle(), '|', pagestyle) >= 0) {
1950 if (pagestyle == "fancy")
1951 os << "\\usepackage{fancyhdr}\n";
1952 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1955 // only output when the background color is not default
1956 if (isbackgroundcolor == true) {
1957 // only require color here, the background color will be defined
1958 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1960 features.require("color");
1961 features.require("pagecolor");
1964 // only output when the font color is not default
1965 if (isfontcolor == true) {
1966 // only require color here, the font color will be defined
1967 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1969 features.require("color");
1970 features.require("fontcolor");
1973 // Only if class has a ToC hierarchy
1974 if (tclass.hasTocLevels()) {
1975 if (secnumdepth != tclass.secnumdepth()) {
1976 os << "\\setcounter{secnumdepth}{"
1980 if (tocdepth != tclass.tocdepth()) {
1981 os << "\\setcounter{tocdepth}{"
1987 if (paragraph_separation) {
1988 // when skip separation
1989 switch (getDefSkip().kind()) {
1990 case VSpace::SMALLSKIP:
1991 os << "\\setlength{\\parskip}{\\smallskipamount}\n";
1993 case VSpace::MEDSKIP:
1994 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1996 case VSpace::BIGSKIP:
1997 os << "\\setlength{\\parskip}{\\bigskipamount}\n";
1999 case VSpace::LENGTH:
2000 os << "\\setlength{\\parskip}{"
2001 << from_utf8(getDefSkip().length().asLatexString())
2004 default: // should never happen // Then delete it.
2005 os << "\\setlength{\\parskip}{\\medskipamount}\n";
2008 os << "\\setlength{\\parindent}{0pt}\n";
2010 // when separation by indentation
2011 // only output something when a width is given
2012 if (!getParIndent().empty()) {
2013 os << "\\setlength{\\parindent}{"
2014 << from_utf8(getParIndent().asLatexString())
2019 if (is_math_indent) {
2020 // when formula indentation
2021 // only output something when it is not the default
2022 if (!getMathIndent().empty()) {
2023 os << "\\setlength{\\mathindent}{"
2024 << from_utf8(getMathIndent().asString())
2029 // Now insert the LyX specific LaTeX commands...
2030 features.resolveAlternatives();
2031 features.expandMultiples();
2034 if (!output_sync_macro.empty())
2035 os << from_utf8(output_sync_macro) +"\n";
2036 else if (features.runparams().flavor == OutputParams::LATEX)
2037 os << "\\usepackage[active]{srcltx}\n";
2038 else if (features.runparams().flavor == OutputParams::PDFLATEX)
2039 os << "\\synctex=-1\n";
2042 // The package options (via \PassOptionsToPackage)
2043 os << from_ascii(features.getPackageOptions());
2045 // due to interferences with babel and hyperref, the color package has to
2046 // be loaded (when it is not already loaded) before babel when hyperref
2047 // is used with the colorlinks option, see
2048 // http://www.lyx.org/trac/ticket/5291
2049 // we decided therefore to load color always before babel, see
2050 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
2051 os << from_ascii(features.getColorOptions());
2053 // If we use hyperref, jurabib, japanese, varioref or vietnamese,
2054 // we have to call babel before
2056 && (features.isRequired("jurabib")
2057 || features.isRequired("hyperref")
2058 || features.isRequired("varioref")
2059 || features.isRequired("vietnamese")
2060 || features.isRequired("japanese"))) {
2061 os << features.getBabelPresettings();
2063 os << from_utf8(babelCall(language_options.str(),
2064 features.needBabelLangOptions())) + '\n';
2065 os << features.getBabelPostsettings();
2068 // The optional packages;
2069 os << from_ascii(features.getPackages());
2071 // Additional Indices
2072 if (features.isRequired("splitidx")) {
2073 IndicesList::const_iterator iit = indiceslist().begin();
2074 IndicesList::const_iterator iend = indiceslist().end();
2075 for (; iit != iend; ++iit) {
2076 os << "\\newindex{";
2077 os << escape(iit->shortcut());
2083 os << from_utf8(spacing().writePreamble(features.isProvided("SetSpace")));
2086 // * Hyperref manual: "Make sure it comes last of your loaded
2087 // packages, to give it a fighting chance of not being over-written,
2088 // since its job is to redefine many LaTeX commands."
2089 // * Email from Heiko Oberdiek: "It is usually better to load babel
2090 // before hyperref. Then hyperref has a chance to detect babel.
2091 // * Has to be loaded before the "LyX specific LaTeX commands" to
2092 // avoid errors with algorithm floats.
2093 // use hyperref explicitly if it is required
2094 if (features.isRequired("hyperref")) {
2095 OutputParams tmp_params = features.runparams();
2096 pdfoptions().writeLaTeX(tmp_params, os,
2097 features.isProvided("hyperref"));
2098 // correctly break URLs with hyperref and dvi output
2099 if (features.runparams().flavor == OutputParams::LATEX
2100 && features.isAvailable("breakurl"))
2101 os << "\\usepackage{breakurl}\n";
2102 } else if (features.isRequired("nameref"))
2103 // hyperref loads this automatically
2104 os << "\\usepackage{nameref}\n";
2106 // bibtopic needs to be loaded after hyperref.
2107 // the dot provides the aux file naming which LyX can detect.
2108 if (features.mustProvide("bibtopic"))
2109 os << "\\usepackage[dot]{bibtopic}\n";
2111 // Will be surrounded by \makeatletter and \makeatother when not empty
2112 otexstringstream atlyxpreamble;
2114 // Some macros LyX will need
2116 TexString tmppreamble = features.getMacros();
2117 if (!tmppreamble.str.empty())
2118 atlyxpreamble << "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2119 "LyX specific LaTeX commands.\n"
2120 << move(tmppreamble)
2123 // the text class specific preamble
2125 docstring tmppreamble = features.getTClassPreamble();
2126 if (!tmppreamble.empty())
2127 atlyxpreamble << "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2128 "Textclass specific LaTeX commands.\n"
2132 // suppress date if selected
2133 // use \@ifundefined because we cannot be sure that every document class
2134 // has a \date command
2136 atlyxpreamble << "\\@ifundefined{date}{}{\\date{}}\n";
2138 /* the user-defined preamble */
2139 if (!containsOnly(preamble, " \n\t")) {
2141 atlyxpreamble << "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2142 "User specified LaTeX commands.\n";
2144 // Check if the user preamble contains uncodable glyphs
2145 odocstringstream user_preamble;
2146 docstring uncodable_glyphs;
2147 Encoding const * const enc = features.runparams().encoding;
2149 for (size_t n = 0; n < preamble.size(); ++n) {
2150 char_type c = preamble[n];
2151 if (!enc->encodable(c)) {
2152 docstring const glyph(1, c);
2153 LYXERR0("Uncodable character '"
2155 << "' in user preamble!");
2156 uncodable_glyphs += glyph;
2157 if (features.runparams().dryrun) {
2158 user_preamble << "<" << _("LyX Warning: ")
2159 << _("uncodable character") << " '";
2160 user_preamble.put(c);
2161 user_preamble << "'>";
2164 user_preamble.put(c);
2167 user_preamble << preamble;
2169 // On BUFFER_VIEW|UPDATE, warn user if we found uncodable glyphs
2170 if (!features.runparams().dryrun && !uncodable_glyphs.empty()) {
2171 frontend::Alert::warning(
2172 _("Uncodable character in user preamble"),
2174 _("The user preamble of your document contains glyphs "
2175 "that are unknown in the current document encoding "
2176 "(namely %1$s).\nThese glyphs are omitted "
2177 " from the output, which may result in "
2178 "incomplete output."
2179 "\n\nPlease select an appropriate "
2180 "document encoding\n"
2181 "(such as utf8) or change the "
2182 "preamble code accordingly."),
2185 atlyxpreamble << user_preamble.str() << '\n';
2188 // footmisc must be loaded after setspace
2189 // Load it here to avoid clashes with footmisc loaded in the user
2190 // preamble. For that reason we also pass the options via
2191 // \PassOptionsToPackage in getPreamble() and not here.
2192 if (features.mustProvide("footmisc"))
2193 atlyxpreamble << "\\usepackage{footmisc}\n";
2195 // subfig loads internally the LaTeX package "caption". As
2196 // caption is a very popular package, users will load it in
2197 // the preamble. Therefore we must load subfig behind the
2198 // user-defined preamble and check if the caption package was
2199 // loaded or not. For the case that caption is loaded before
2200 // subfig, there is the subfig option "caption=false". This
2201 // option also works when a koma-script class is used and
2202 // koma's own caption commands are used instead of caption. We
2203 // use \PassOptionsToPackage here because the user could have
2204 // already loaded subfig in the preamble.
2205 if (features.mustProvide("subfig"))
2206 atlyxpreamble << "\\@ifundefined{showcaptionsetup}{}{%\n"
2207 " \\PassOptionsToPackage{caption=false}{subfig}}\n"
2208 "\\usepackage{subfig}\n";
2210 // Itemize bullet settings need to be last in case the user
2211 // defines their own bullets that use a package included
2212 // in the user-defined preamble -- ARRae
2213 // Actually it has to be done much later than that
2214 // since some packages like frenchb make modifications
2215 // at \begin{document} time -- JMarc
2216 docstring bullets_def;
2217 for (int i = 0; i < 4; ++i) {
2218 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
2219 if (bullets_def.empty())
2220 bullets_def += "\\AtBeginDocument{\n";
2221 bullets_def += " \\def\\labelitemi";
2223 // `i' is one less than the item to modify
2230 bullets_def += "ii";
2236 bullets_def += '{' +
2237 user_defined_bullet(i).getText()
2242 if (!bullets_def.empty())
2243 atlyxpreamble << bullets_def << "}\n\n";
2245 if (!atlyxpreamble.empty())
2246 os << "\n\\makeatletter\n"
2247 << atlyxpreamble.release()
2248 << "\\makeatother\n\n";
2250 // We try to load babel late, in case it interferes with other packages.
2251 // Jurabib, hyperref, varioref, bicaption and listings (bug 8995) have to be
2252 // called after babel, though.
2253 if (use_babel && !features.isRequired("jurabib")
2254 && !features.isRequired("hyperref")
2255 && !features.isRequired("varioref")
2256 && !features.isRequired("vietnamese")
2257 && !features.isRequired("japanese")) {
2258 os << features.getBabelPresettings();
2260 os << from_utf8(babelCall(language_options.str(),
2261 features.needBabelLangOptions())) + '\n';
2262 os << features.getBabelPostsettings();
2264 if (features.isRequired("bicaption"))
2265 os << "\\usepackage{bicaption}\n";
2266 if (!listings_params.empty()
2267 || features.mustProvide("listings")
2268 || features.mustProvide("minted")) {
2269 if (features.mustProvide("listings"))
2270 os << "\\usepackage{listings}\n";
2272 os << "\\usepackage{minted}\n";
2274 if (!listings_params.empty()) {
2275 if (features.mustProvide("listings"))
2278 os << "\\setminted{";
2279 // do not test validity because listings_params is
2280 // supposed to be valid
2282 InsetListingsParams(listings_params).separatedParams(true);
2283 os << from_utf8(par);
2287 // xunicode only needs to be loaded if tipa is used
2288 // (the rest is obsoleted by the new TU encoding).
2289 // It needs to be loaded at least after amsmath, amssymb,
2290 // esint and the other packages that provide special glyphs
2291 if (features.mustProvide("tipa") && useNonTeXFonts) {
2292 // The package officially only supports XeTeX, but also works
2293 // with LuaTeX. Thus we work around its XeTeX test.
2294 if (features.runparams().flavor != OutputParams::XETEX) {
2295 os << "% Pretend to xunicode that we are XeTeX\n"
2296 << "\\def\\XeTeXpicfile{}\n";
2298 os << "\\usepackage{xunicode}\n";
2301 // Polyglossia must be loaded last ...
2302 if (use_polyglossia) {
2304 os << "\\usepackage{polyglossia}\n";
2305 // set the main language
2306 os << "\\setdefaultlanguage";
2307 if (!language->polyglossiaOpts().empty())
2308 os << "[" << from_ascii(language->polyglossiaOpts()) << "]";
2309 os << "{" << from_ascii(language->polyglossia()) << "}\n";
2310 // now setup the other languages
2311 set<string> const polylangs =
2312 features.getPolyglossiaLanguages();
2313 for (set<string>::const_iterator mit = polylangs.begin();
2314 mit != polylangs.end() ; ++mit) {
2315 // We do not output the options here; they are output in
2316 // the language switch commands. This is safer if multiple
2317 // varieties are used.
2318 if (*mit == language->polyglossia())
2320 os << "\\setotherlanguage";
2321 os << "{" << from_ascii(*mit) << "}\n";
2325 // ... but before biblatex (see #7065)
2326 if (features.mustProvide("biblatex")) {
2329 os << "\\usepackage";
2330 if (!biblatex_bibstyle.empty()
2331 && (biblatex_bibstyle == biblatex_citestyle)) {
2332 opts = "style=" + biblatex_bibstyle;
2335 if (!biblatex_bibstyle.empty()) {
2336 opts = "bibstyle=" + biblatex_bibstyle;
2339 if (!biblatex_citestyle.empty()) {
2340 opts += delim + "citestyle=" + biblatex_citestyle;
2344 if (!multibib.empty() && multibib != "child") {
2345 opts += delim + "refsection=" + multibib;
2348 if (bibtexCommand() == "bibtex8"
2349 || prefixIs(bibtexCommand(), "bibtex8 ")) {
2350 opts += delim + "backend=bibtex8";
2352 } else if (bibtexCommand() == "bibtex"
2353 || prefixIs(bibtexCommand(), "bibtex ")) {
2354 opts += delim + "backend=bibtex";
2357 if (!biblio_opts.empty())
2358 opts += delim + biblio_opts;
2360 os << "[" << opts << "]";
2361 os << "{biblatex}\n";
2365 // Load custom language package here
2366 if (features.langPackage() == LaTeXFeatures::LANG_PACK_CUSTOM) {
2367 if (lang_package == "default")
2368 os << from_utf8(lyxrc.language_custom_package);
2370 os << from_utf8(lang_package);
2374 docstring const i18npreamble =
2375 features.getTClassI18nPreamble(use_babel, use_polyglossia,
2377 if (!i18npreamble.empty())
2378 os << i18npreamble + '\n';
2384 void BufferParams::useClassDefaults()
2386 DocumentClass const & tclass = documentClass();
2388 sides = tclass.sides();
2389 columns = tclass.columns();
2390 pagestyle = tclass.pagestyle();
2391 use_default_options = true;
2392 // Only if class has a ToC hierarchy
2393 if (tclass.hasTocLevels()) {
2394 secnumdepth = tclass.secnumdepth();
2395 tocdepth = tclass.tocdepth();
2400 bool BufferParams::hasClassDefaults() const
2402 DocumentClass const & tclass = documentClass();
2404 return sides == tclass.sides()
2405 && columns == tclass.columns()
2406 && pagestyle == tclass.pagestyle()
2407 && use_default_options
2408 && secnumdepth == tclass.secnumdepth()
2409 && tocdepth == tclass.tocdepth();
2413 DocumentClass const & BufferParams::documentClass() const
2419 DocumentClassConstPtr BufferParams::documentClassPtr() const
2425 void BufferParams::setDocumentClass(DocumentClassConstPtr tc)
2427 // evil, but this function is evil
2428 doc_class_ = const_pointer_cast<DocumentClass>(tc);
2429 invalidateConverterCache();
2433 bool BufferParams::setBaseClass(string const & classname)
2435 LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
2436 LayoutFileList & bcl = LayoutFileList::get();
2437 if (!bcl.haveClass(classname)) {
2439 bformat(_("The layout file:\n"
2441 "could not be found. A default textclass with default\n"
2442 "layouts will be used. LyX will not be able to produce\n"
2444 from_utf8(classname));
2445 frontend::Alert::error(_("Document class not found"), s);
2446 bcl.addEmptyClass(classname);
2449 bool const success = bcl[classname].load();
2452 bformat(_("Due to some error in it, the layout file:\n"
2454 "could not be loaded. A default textclass with default\n"
2455 "layouts will be used. LyX will not be able to produce\n"
2457 from_utf8(classname));
2458 frontend::Alert::error(_("Could not load class"), s);
2459 bcl.addEmptyClass(classname);
2462 pimpl_->baseClass_ = classname;
2463 layout_modules_.adaptToBaseClass(baseClass(), removed_modules_);
2468 LayoutFile const * BufferParams::baseClass() const
2470 if (LayoutFileList::get().haveClass(pimpl_->baseClass_))
2471 return &(LayoutFileList::get()[pimpl_->baseClass_]);
2477 LayoutFileIndex const & BufferParams::baseClassID() const
2479 return pimpl_->baseClass_;
2483 void BufferParams::makeDocumentClass(bool const clone)
2488 invalidateConverterCache();
2489 LayoutModuleList mods;
2490 LayoutModuleList ces;
2491 LayoutModuleList::iterator it = layout_modules_.begin();
2492 LayoutModuleList::iterator en = layout_modules_.end();
2493 for (; it != en; ++it)
2494 mods.push_back(*it);
2496 it = cite_engine_.begin();
2497 en = cite_engine_.end();
2498 for (; it != en; ++it)
2501 doc_class_ = getDocumentClass(*baseClass(), mods, ces, clone);
2503 TextClass::ReturnValues success = TextClass::OK;
2504 if (!forced_local_layout_.empty())
2505 success = doc_class_->read(to_utf8(forced_local_layout_),
2507 if (!local_layout_.empty() &&
2508 (success == TextClass::OK || success == TextClass::OK_OLDFORMAT))
2509 success = doc_class_->read(to_utf8(local_layout_), TextClass::MODULE);
2510 if (success != TextClass::OK && success != TextClass::OK_OLDFORMAT) {
2511 docstring const msg = _("Error reading internal layout information");
2512 frontend::Alert::warning(_("Read Error"), msg);
2517 bool BufferParams::layoutModuleCanBeAdded(string const & modName) const
2519 return layout_modules_.moduleCanBeAdded(modName, baseClass());
2523 bool BufferParams::citationModuleCanBeAdded(string const & modName) const
2525 return cite_engine_.moduleCanBeAdded(modName, baseClass());
2529 docstring BufferParams::getLocalLayout(bool forced) const
2532 return from_utf8(doc_class_->forcedLayouts());
2534 return local_layout_;
2538 void BufferParams::setLocalLayout(docstring const & layout, bool forced)
2541 forced_local_layout_ = layout;
2543 local_layout_ = layout;
2547 bool BufferParams::addLayoutModule(string const & modName)
2549 LayoutModuleList::const_iterator it = layout_modules_.begin();
2550 LayoutModuleList::const_iterator end = layout_modules_.end();
2551 for (; it != end; ++it)
2554 layout_modules_.push_back(modName);
2559 string BufferParams::bufferFormat() const
2561 return documentClass().outputFormat();
2565 bool BufferParams::isExportable(string const & format, bool need_viewable) const
2567 FormatList const & formats = exportableFormats(need_viewable);
2568 FormatList::const_iterator fit = formats.begin();
2569 FormatList::const_iterator end = formats.end();
2570 for (; fit != end ; ++fit) {
2571 if ((*fit)->name() == format)
2578 FormatList const & BufferParams::exportableFormats(bool only_viewable) const
2580 FormatList & cached = only_viewable ?
2581 pimpl_->viewableFormatList : pimpl_->exportableFormatList;
2582 bool & valid = only_viewable ?
2583 pimpl_->isViewCacheValid : pimpl_->isExportCacheValid;
2587 vector<string> const backs = backends();
2588 set<string> excludes;
2589 if (useNonTeXFonts) {
2590 excludes.insert("latex");
2591 excludes.insert("pdflatex");
2594 theConverters().getReachable(backs[0], only_viewable, true, excludes);
2595 for (vector<string>::const_iterator it = backs.begin() + 1;
2596 it != backs.end(); ++it) {
2597 FormatList r = theConverters().getReachable(*it, only_viewable,
2599 result.insert(result.end(), r.begin(), r.end());
2601 sort(result.begin(), result.end(), Format::formatSorter);
2608 vector<string> BufferParams::backends() const
2611 string const buffmt = bufferFormat();
2613 // FIXME: Don't hardcode format names here, but use a flag
2614 if (buffmt == "latex") {
2615 if (encoding().package() == Encoding::japanese)
2616 v.push_back("platex");
2618 if (!useNonTeXFonts) {
2619 v.push_back("pdflatex");
2620 v.push_back("latex");
2622 v.push_back("xetex");
2623 v.push_back("luatex");
2624 v.push_back("dviluatex");
2627 v.push_back(buffmt);
2629 v.push_back("xhtml");
2630 v.push_back("text");
2636 OutputParams::FLAVOR BufferParams::getOutputFlavor(string const & format) const
2638 string const dformat = (format.empty() || format == "default") ?
2639 getDefaultOutputFormat() : format;
2640 DefaultFlavorCache::const_iterator it =
2641 default_flavors_.find(dformat);
2643 if (it != default_flavors_.end())
2646 OutputParams::FLAVOR result = OutputParams::LATEX;
2648 // FIXME It'd be better not to hardcode this, but to do
2649 // something with formats.
2650 if (dformat == "xhtml")
2651 result = OutputParams::HTML;
2652 else if (dformat == "text")
2653 result = OutputParams::TEXT;
2654 else if (dformat == "lyx")
2655 result = OutputParams::LYX;
2656 else if (dformat == "pdflatex")
2657 result = OutputParams::PDFLATEX;
2658 else if (dformat == "xetex")
2659 result = OutputParams::XETEX;
2660 else if (dformat == "luatex")
2661 result = OutputParams::LUATEX;
2662 else if (dformat == "dviluatex")
2663 result = OutputParams::DVILUATEX;
2665 // Try to determine flavor of default output format
2666 vector<string> backs = backends();
2667 if (find(backs.begin(), backs.end(), dformat) == backs.end()) {
2668 // Get shortest path to format
2669 Graph::EdgePath path;
2670 for (vector<string>::const_iterator it = backs.begin();
2671 it != backs.end(); ++it) {
2672 Graph::EdgePath p = theConverters().getPath(*it, dformat);
2673 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2678 result = theConverters().getFlavor(path);
2681 // cache this flavor
2682 default_flavors_[dformat] = result;
2687 string BufferParams::getDefaultOutputFormat() const
2689 if (!default_output_format.empty()
2690 && default_output_format != "default")
2691 return default_output_format;
2693 || encoding().package() == Encoding::japanese) {
2694 FormatList const & formats = exportableFormats(true);
2695 if (formats.empty())
2697 // return the first we find
2698 return formats.front()->name();
2701 return lyxrc.default_otf_view_format;
2702 return lyxrc.default_view_format;
2705 Font const BufferParams::getFont() const
2707 FontInfo f = documentClass().defaultfont();
2708 if (fonts_default_family == "rmdefault")
2709 f.setFamily(ROMAN_FAMILY);
2710 else if (fonts_default_family == "sfdefault")
2711 f.setFamily(SANS_FAMILY);
2712 else if (fonts_default_family == "ttdefault")
2713 f.setFamily(TYPEWRITER_FAMILY);
2714 return Font(f, language);
2718 InsetQuotesParams::QuoteStyle BufferParams::getQuoteStyle(string const & qs) const
2720 return quotesstyletranslator().find(qs);
2724 bool BufferParams::isLatex() const
2726 return documentClass().outputType() == LATEX;
2730 bool BufferParams::isLiterate() const
2732 return documentClass().outputType() == LITERATE;
2736 bool BufferParams::isDocBook() const
2738 return documentClass().outputType() == DOCBOOK;
2742 void BufferParams::readPreamble(Lexer & lex)
2744 if (lex.getString() != "\\begin_preamble")
2745 lyxerr << "Error (BufferParams::readPreamble):"
2746 "consistency check failed." << endl;
2748 preamble = lex.getLongString(from_ascii("\\end_preamble"));
2752 void BufferParams::readLocalLayout(Lexer & lex, bool forced)
2754 string const expected = forced ? "\\begin_forced_local_layout" :
2755 "\\begin_local_layout";
2756 if (lex.getString() != expected)
2757 lyxerr << "Error (BufferParams::readLocalLayout):"
2758 "consistency check failed." << endl;
2761 forced_local_layout_ =
2762 lex.getLongString(from_ascii("\\end_forced_local_layout"));
2764 local_layout_ = lex.getLongString(from_ascii("\\end_local_layout"));
2768 bool BufferParams::setLanguage(string const & lang)
2770 Language const *new_language = languages.getLanguage(lang);
2771 if (!new_language) {
2772 // Language lang was not found
2775 language = new_language;
2780 void BufferParams::readLanguage(Lexer & lex)
2782 if (!lex.next()) return;
2784 string const tmptok = lex.getString();
2786 // check if tmptok is part of tex_babel in tex-defs.h
2787 if (!setLanguage(tmptok)) {
2788 // Language tmptok was not found
2789 language = default_language;
2790 lyxerr << "Warning: Setting language `"
2791 << tmptok << "' to `" << language->lang()
2797 void BufferParams::readGraphicsDriver(Lexer & lex)
2802 string const tmptok = lex.getString();
2803 // check if tmptok is part of tex_graphics in tex_defs.h
2806 string const test = tex_graphics[n++];
2808 if (test == tmptok) {
2809 graphics_driver = tmptok;
2814 "Warning: graphics driver `$$Token' not recognized!\n"
2815 " Setting graphics driver to `default'.\n");
2816 graphics_driver = "default";
2823 void BufferParams::readBullets(Lexer & lex)
2828 int const index = lex.getInteger();
2830 int temp_int = lex.getInteger();
2831 user_defined_bullet(index).setFont(temp_int);
2832 temp_bullet(index).setFont(temp_int);
2834 user_defined_bullet(index).setCharacter(temp_int);
2835 temp_bullet(index).setCharacter(temp_int);
2837 user_defined_bullet(index).setSize(temp_int);
2838 temp_bullet(index).setSize(temp_int);
2842 void BufferParams::readBulletsLaTeX(Lexer & lex)
2844 // The bullet class should be able to read this.
2847 int const index = lex.getInteger();
2849 docstring const temp_str = lex.getDocString();
2851 user_defined_bullet(index).setText(temp_str);
2852 temp_bullet(index).setText(temp_str);
2856 void BufferParams::readModules(Lexer & lex)
2858 if (!lex.eatLine()) {
2859 lyxerr << "Error (BufferParams::readModules):"
2860 "Unexpected end of input." << endl;
2864 string mod = lex.getString();
2865 if (mod == "\\end_modules")
2867 addLayoutModule(mod);
2873 void BufferParams::readRemovedModules(Lexer & lex)
2875 if (!lex.eatLine()) {
2876 lyxerr << "Error (BufferParams::readRemovedModules):"
2877 "Unexpected end of input." << endl;
2881 string mod = lex.getString();
2882 if (mod == "\\end_removed_modules")
2884 removed_modules_.push_back(mod);
2887 // now we want to remove any removed modules that were previously
2888 // added. normally, that will be because default modules were added in
2889 // setBaseClass(), which gets called when \textclass is read at the
2890 // start of the read.
2891 list<string>::const_iterator rit = removed_modules_.begin();
2892 list<string>::const_iterator const ren = removed_modules_.end();
2893 for (; rit != ren; ++rit) {
2894 LayoutModuleList::iterator const mit = layout_modules_.begin();
2895 LayoutModuleList::iterator const men = layout_modules_.end();
2896 LayoutModuleList::iterator found = find(mit, men, *rit);
2899 layout_modules_.erase(found);
2904 void BufferParams::readIncludeonly(Lexer & lex)
2906 if (!lex.eatLine()) {
2907 lyxerr << "Error (BufferParams::readIncludeonly):"
2908 "Unexpected end of input." << endl;
2912 string child = lex.getString();
2913 if (child == "\\end_includeonly")
2915 included_children_.push_back(child);
2921 string BufferParams::paperSizeName(PapersizePurpose purpose) const
2923 switch (papersize) {
2925 // could be anything, so don't guess
2927 case PAPER_CUSTOM: {
2928 if (purpose == XDVI && !paperwidth.empty() &&
2929 !paperheight.empty()) {
2930 // heightxwidth<unit>
2931 string first = paperwidth;
2932 string second = paperheight;
2933 if (orientation == ORIENTATION_LANDSCAPE)
2936 return first.erase(first.length() - 2)
2942 // dvips and dvipdfm do not know this
2943 if (purpose == DVIPS || purpose == DVIPDFM)
2947 if (purpose == DVIPS || purpose == DVIPDFM)
2951 if (purpose == DVIPS || purpose == DVIPDFM)
2961 if (purpose == DVIPS || purpose == DVIPDFM)
2965 if (purpose == DVIPS || purpose == DVIPDFM)
2969 if (purpose == DVIPS || purpose == DVIPDFM)
2973 if (purpose == DVIPS || purpose == DVIPDFM)
2977 if (purpose == DVIPS || purpose == DVIPDFM)
2981 // dvipdfm does not know this
2982 if (purpose == DVIPDFM)
2986 if (purpose == DVIPDFM)
2990 if (purpose == DVIPS || purpose == DVIPDFM)
2994 if (purpose == DVIPS || purpose == DVIPDFM)
2998 if (purpose == DVIPS || purpose == DVIPDFM)
3002 if (purpose == DVIPS || purpose == DVIPDFM)
3006 if (purpose == DVIPS || purpose == DVIPDFM)
3010 if (purpose == DVIPS || purpose == DVIPDFM)
3014 if (purpose == DVIPS || purpose == DVIPDFM)
3018 if (purpose == DVIPS || purpose == DVIPDFM)
3022 if (purpose == DVIPS || purpose == DVIPDFM)
3026 if (purpose == DVIPS || purpose == DVIPDFM)
3030 if (purpose == DVIPS || purpose == DVIPDFM)
3034 if (purpose == DVIPS || purpose == DVIPDFM)
3038 if (purpose == DVIPS || purpose == DVIPDFM)
3042 if (purpose == DVIPS || purpose == DVIPDFM)
3046 if (purpose == DVIPS || purpose == DVIPDFM)
3049 case PAPER_USEXECUTIVE:
3050 // dvipdfm does not know this
3051 if (purpose == DVIPDFM)
3056 case PAPER_USLETTER:
3058 if (purpose == XDVI)
3065 string const BufferParams::dvips_options() const
3069 // If the class loads the geometry package, we do not know which
3070 // paper size is used, since we do not set it (bug 7013).
3071 // Therefore we must not specify any argument here.
3072 // dvips gets the correct paper size via DVI specials in this case
3073 // (if the class uses the geometry package correctly).
3074 if (documentClass().provides("geometry"))
3078 && papersize == PAPER_CUSTOM
3079 && !lyxrc.print_paper_dimension_flag.empty()
3080 && !paperwidth.empty()
3081 && !paperheight.empty()) {
3082 // using a custom papersize
3083 result = lyxrc.print_paper_dimension_flag;
3084 result += ' ' + paperwidth;
3085 result += ',' + paperheight;
3087 string const paper_option = paperSizeName(DVIPS);
3088 if (!paper_option.empty() && (paper_option != "letter" ||
3089 orientation != ORIENTATION_LANDSCAPE)) {
3090 // dvips won't accept -t letter -t landscape.
3091 // In all other cases, include the paper size
3093 result = lyxrc.print_paper_flag;
3094 result += ' ' + paper_option;
3097 if (orientation == ORIENTATION_LANDSCAPE &&
3098 papersize != PAPER_CUSTOM)
3099 result += ' ' + lyxrc.print_landscape_flag;
3104 string const BufferParams::main_font_encoding() const
3106 return font_encodings().empty() ? "default" : font_encodings().back();
3110 vector<string> const BufferParams::font_encodings() const
3112 string doc_fontenc = (fontenc == "global") ? lyxrc.fontenc : fontenc;
3114 vector<string> fontencs;
3116 // "default" means "no explicit font encoding"
3117 if (doc_fontenc != "default") {
3118 fontencs = getVectorFromString(doc_fontenc);
3119 if (!language->fontenc().empty()
3120 && ascii_lowercase(language->fontenc()) != "none") {
3121 vector<string> fencs = getVectorFromString(language->fontenc());
3122 vector<string>::const_iterator fit = fencs.begin();
3123 for (; fit != fencs.end(); ++fit) {
3124 if (find(fontencs.begin(), fontencs.end(), *fit) == fontencs.end())
3125 fontencs.push_back(*fit);
3134 string BufferParams::babelCall(string const & lang_opts, bool const langoptions) const
3136 // suppress the babel call if there is no BabelName defined
3137 // for the document language in the lib/languages file and if no
3138 // other languages are used (lang_opts is then empty)
3139 if (lang_opts.empty())
3141 // either a specific language (AsBabelOptions setting in
3142 // lib/languages) or the prefs require the languages to
3143 // be submitted to babel itself (not the class).
3145 return "\\usepackage[" + lang_opts + "]{babel}";
3146 return "\\usepackage{babel}";
3150 docstring BufferParams::getGraphicsDriver(string const & package) const
3154 if (package == "geometry") {
3155 if (graphics_driver == "dvips"
3156 || graphics_driver == "dvipdfm"
3157 || graphics_driver == "pdftex"
3158 || graphics_driver == "vtex")
3159 result = from_ascii(graphics_driver);
3160 else if (graphics_driver == "dvipdfmx")
3161 result = from_ascii("dvipdfm");
3168 void BufferParams::writeEncodingPreamble(otexstream & os,
3169 LaTeXFeatures & features) const
3171 // XeTeX/LuaTeX: (see also #9740)
3172 // With Unicode fonts we use utf8-plain without encoding package.
3173 // With TeX fonts, we cannot use utf8-plain, but "inputenc" fails.
3174 // XeTeX must use ASCII encoding (see Buffer.cpp),
3175 // for LuaTeX, we load "luainputenc" (see below).
3176 if (useNonTeXFonts || features.runparams().flavor == OutputParams::XETEX)
3179 if (inputenc == "auto") {
3180 string const doc_encoding =
3181 language->encoding()->latexName();
3182 Encoding::Package const package =
3183 language->encoding()->package();
3185 // Create list of inputenc options:
3186 set<string> encodings;
3187 // luainputenc fails with more than one encoding
3188 if (!features.runparams().isFullUnicode()) // if we reach this point, this means LuaTeX with TeX fonts
3189 // list all input encodings used in the document
3190 encodings = features.getEncodingSet(doc_encoding);
3192 // If the "japanese" package (i.e. pLaTeX) is used,
3193 // inputenc must be omitted.
3194 // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
3195 if ((!encodings.empty() || package == Encoding::inputenc)
3196 && !features.isRequired("japanese")
3197 && !features.isProvided("inputenc")) {
3198 os << "\\usepackage[";
3199 set<string>::const_iterator it = encodings.begin();
3200 set<string>::const_iterator const end = encodings.end();
3202 os << from_ascii(*it);
3205 for (; it != end; ++it)
3206 os << ',' << from_ascii(*it);
3207 if (package == Encoding::inputenc) {
3208 if (!encodings.empty())
3210 os << from_ascii(doc_encoding);
3212 if (features.runparams().flavor == OutputParams::LUATEX
3213 || features.runparams().flavor == OutputParams::DVILUATEX)
3214 os << "]{luainputenc}\n";
3216 os << "]{inputenc}\n";
3218 if (package == Encoding::CJK || features.mustProvide("CJK")) {
3219 if (language->encoding()->name() == "utf8-cjk"
3220 && LaTeXFeatures::isAvailable("CJKutf8"))
3221 os << "\\usepackage{CJKutf8}\n";
3223 os << "\\usepackage{CJK}\n";
3225 } else if (inputenc != "default") {
3226 switch (encoding().package()) {
3227 case Encoding::none:
3228 case Encoding::japanese:
3230 case Encoding::inputenc:
3231 // do not load inputenc if japanese is used
3232 // or if the class provides inputenc
3233 if (features.isRequired("japanese")
3234 || features.isProvided("inputenc"))
3236 os << "\\usepackage[" << from_ascii(encoding().latexName());
3237 if (features.runparams().flavor == OutputParams::LUATEX
3238 || features.runparams().flavor == OutputParams::DVILUATEX)
3239 os << "]{luainputenc}\n";
3241 os << "]{inputenc}\n";
3244 if (encoding().name() == "utf8-cjk"
3245 && LaTeXFeatures::isAvailable("CJKutf8"))
3246 os << "\\usepackage{CJKutf8}\n";
3248 os << "\\usepackage{CJK}\n";
3251 // Load the CJK package if needed by a secondary language.
3252 // If the main encoding is some variant of UTF8, use CJKutf8.
3253 if (encoding().package() != Encoding::CJK && features.mustProvide("CJK")) {
3254 if (encoding().iconvName() == "UTF-8"
3255 && LaTeXFeatures::isAvailable("CJKutf8"))
3256 os << "\\usepackage{CJKutf8}\n";
3258 os << "\\usepackage{CJK}\n";
3264 string const BufferParams::parseFontName(string const & name) const
3266 string mangled = name;
3267 size_t const idx = mangled.find('[');
3268 if (idx == string::npos || idx == 0)
3271 return mangled.substr(0, idx - 1);
3275 string const BufferParams::loadFonts(LaTeXFeatures & features) const
3277 if (fontsRoman() == "default" && fontsSans() == "default"
3278 && fontsTypewriter() == "default"
3279 && (fontsMath() == "default" || fontsMath() == "auto"))
3285 /* Fontspec (XeTeX, LuaTeX): we provide GUI support for oldstyle
3286 * numbers (Numbers=OldStyle) and sf/tt scaling. The Ligatures=TeX/
3287 * Mapping=tex-text option assures TeX ligatures (such as "--")
3288 * are resolved. Note that tt does not use these ligatures.
3290 * -- add more GUI options?
3291 * -- add more fonts (fonts for other scripts)
3292 * -- if there's a way to find out if a font really supports
3293 * OldStyle, enable/disable the widget accordingly.
3295 if (useNonTeXFonts && features.isAvailable("fontspec")) {
3296 // "Mapping=tex-text" and "Ligatures=TeX" are equivalent.
3297 // However, until v.2 (2010/07/11) fontspec only knew
3298 // Mapping=tex-text (for XeTeX only); then "Ligatures=TeX"
3299 // was introduced for both XeTeX and LuaTeX (LuaTeX
3300 // didn't understand "Mapping=tex-text", while XeTeX
3301 // understood both. With most recent versions, both
3302 // variants are understood by both engines. However,
3303 // we want to provide support for at least TeXLive 2009
3304 // (for XeTeX; LuaTeX is only supported as of v.2)
3305 string const texmapping =
3306 (features.runparams().flavor == OutputParams::XETEX) ?
3307 "Mapping=tex-text" : "Ligatures=TeX";
3308 if (fontsRoman() != "default") {
3309 os << "\\setmainfont[" << texmapping;
3310 if (fonts_old_figures)
3311 os << ",Numbers=OldStyle";
3312 os << "]{" << parseFontName(fontsRoman()) << "}\n";
3314 if (fontsSans() != "default") {
3315 string const sans = parseFontName(fontsSans());
3316 if (fontsSansScale() != 100)
3317 os << "\\setsansfont[Scale="
3318 << float(fontsSansScale()) / 100
3319 << "," << texmapping << "]{"
3322 os << "\\setsansfont[" << texmapping << "]{"
3325 if (fontsTypewriter() != "default") {
3326 string const mono = parseFontName(fontsTypewriter());
3327 if (fontsTypewriterScale() != 100)
3328 os << "\\setmonofont[Scale="
3329 << float(fontsTypewriterScale()) / 100
3333 os << "\\setmonofont{"
3340 bool const ot1 = (main_font_encoding() == "default" || main_font_encoding() == "OT1");
3341 bool const dryrun = features.runparams().dryrun;
3342 bool const complete = (fontsSans() == "default" && fontsTypewriter() == "default");
3343 bool const nomath = (fontsMath() == "default");
3346 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsRoman())).getLaTeXCode(
3347 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3351 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsSans())).getLaTeXCode(
3352 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3353 nomath, fontsSansScale());
3355 // MONOSPACED/TYPEWRITER
3356 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsTypewriter())).getLaTeXCode(
3357 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3358 nomath, fontsTypewriterScale());
3361 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsMath())).getLaTeXCode(
3362 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3369 Encoding const & BufferParams::encoding() const
3371 // Main encoding for LaTeX output.
3373 // Exception: XeTeX with 8-bit TeX fonts requires ASCII (see #9740).
3374 // As the "flavor" is only known once export started, this
3375 // cannot be handled here. Instead, runparams.encoding is set
3376 // to ASCII in Buffer::makeLaTeXFile (for export)
3377 // and Buffer::writeLaTeXSource (for preview).
3379 return *(encodings.fromLyXName("utf8-plain"));
3380 if (inputenc == "auto" || inputenc == "default")
3381 return *language->encoding();
3382 Encoding const * const enc = encodings.fromLyXName(inputenc);
3385 LYXERR0("Unknown inputenc value `" << inputenc
3386 << "'. Using `auto' instead.");
3387 return *language->encoding();
3391 bool BufferParams::addCiteEngine(string const & engine)
3393 LayoutModuleList::const_iterator it = cite_engine_.begin();
3394 LayoutModuleList::const_iterator en = cite_engine_.end();
3395 for (; it != en; ++it)
3398 cite_engine_.push_back(engine);
3403 bool BufferParams::addCiteEngine(vector<string> const & engine)
3405 vector<string>::const_iterator it = engine.begin();
3406 vector<string>::const_iterator en = engine.end();
3408 for (; it != en; ++it)
3409 if (!addCiteEngine(*it))
3415 string const & BufferParams::defaultBiblioStyle() const
3417 map<string, string> const & bs = documentClass().defaultBiblioStyle();
3418 auto cit = bs.find(theCiteEnginesList.getTypeAsString(citeEngineType()));
3419 if (cit != bs.end())
3422 return empty_string();
3426 bool const & BufferParams::fullAuthorList() const
3428 return documentClass().fullAuthorList();
3432 string BufferParams::getCiteAlias(string const & s) const
3434 vector<string> commands =
3435 documentClass().citeCommands(citeEngineType());
3436 // If it is a real command, don't treat it as an alias
3437 if (find(commands.begin(), commands.end(), s) != commands.end())
3439 map<string,string> aliases = documentClass().citeCommandAliases();
3440 if (aliases.find(s) != aliases.end())
3446 void BufferParams::setCiteEngine(string const & engine)
3449 addCiteEngine(engine);
3453 void BufferParams::setCiteEngine(vector<string> const & engine)
3456 addCiteEngine(engine);
3460 vector<string> BufferParams::citeCommands() const
3462 static CitationStyle const default_style;
3463 vector<string> commands =
3464 documentClass().citeCommands(citeEngineType());
3465 if (commands.empty())
3466 commands.push_back(default_style.name);
3471 vector<CitationStyle> BufferParams::citeStyles() const
3473 static CitationStyle const default_style;
3474 vector<CitationStyle> styles =
3475 documentClass().citeStyles(citeEngineType());
3477 styles.push_back(default_style);
3482 string const BufferParams::bibtexCommand() const
3484 // Return document-specific setting if available
3485 if (bibtex_command != "default")
3486 return bibtex_command;
3488 // If we have "default" in document settings, consult the prefs
3489 // 1. Japanese (uses a specific processor)
3490 if (encoding().package() == Encoding::japanese) {
3491 if (lyxrc.jbibtex_command != "automatic")
3492 // Return the specified program, if "automatic" is not set
3493 return lyxrc.jbibtex_command;
3494 else if (!useBiblatex()) {
3495 // With classic BibTeX, return pbibtex, jbibtex, bibtex
3496 if (lyxrc.jbibtex_alternatives.find("pbibtex") != lyxrc.jbibtex_alternatives.end())
3498 if (lyxrc.jbibtex_alternatives.find("jbibtex") != lyxrc.jbibtex_alternatives.end())
3503 // 2. All other languages
3504 else if (lyxrc.bibtex_command != "automatic")
3505 // Return the specified program, if "automatic" is not set
3506 return lyxrc.bibtex_command;
3508 // 3. Automatic: find the most suitable for the current cite framework
3509 if (useBiblatex()) {
3510 // For Biblatex, we prefer biber (also for Japanese)
3511 // and fall back to bibtex8 and, as last resort, bibtex
3512 if (lyxrc.bibtex_alternatives.find("biber") != lyxrc.bibtex_alternatives.end())
3514 else if (lyxrc.bibtex_alternatives.find("bibtex8") != lyxrc.bibtex_alternatives.end())
3521 bool BufferParams::useBiblatex() const
3523 return theCiteEnginesList[citeEngine().list().front()]
3524 ->getCiteFramework() == "biblatex";
3528 void BufferParams::invalidateConverterCache() const
3530 pimpl_->isExportCacheValid = false;
3531 pimpl_->isViewCacheValid = false;