2 * \file BufferParams.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Alfredo Braunstein
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
10 * \author André Pönitz
11 * \author Martin Vermeer
13 * Full author contact details are available in file CREDITS.
18 #include "BufferParams.h"
21 #include "LayoutFile.h"
22 #include "BranchList.h"
24 #include "buffer_funcs.h"
26 #include "CiteEnginesList.h"
29 #include "Converter.h"
31 #include "IndicesList.h"
33 #include "LaTeXFeatures.h"
34 #include "LaTeXFonts.h"
36 #include "ModuleList.h"
40 #include "OutputParams.h"
42 #include "texstream.h"
45 #include "PDFOptions.h"
47 #include "frontends/alert.h"
49 #include "insets/InsetListingsParams.h"
51 #include "support/convert.h"
52 #include "support/debug.h"
53 #include "support/docstream.h"
54 #include "support/FileName.h"
55 #include "support/filetools.h"
56 #include "support/gettext.h"
57 #include "support/Messages.h"
58 #include "support/mutex.h"
59 #include "support/Package.h"
60 #include "support/Translator.h"
61 #include "support/lstrings.h"
67 using namespace lyx::support;
70 static char const * const string_paragraph_separation[] = {
75 static char const * const string_quotes_style[] = {
76 "english", "swedish", "german", "polish", "swiss", "danish", "plain",
77 "british", "swedishg", "french", "frenchin", "russian", "cjk", "cjkangle", ""
81 static char const * const string_papersize[] = {
82 "default", "custom", "letterpaper", "legalpaper", "executivepaper",
83 "a0paper", "a1paper", "a2paper", "a3paper", "a4paper", "a5paper",
84 "a6paper", "b0paper", "b1paper", "b2paper","b3paper", "b4paper",
85 "b5paper", "b6paper", "c0paper", "c1paper", "c2paper", "c3paper",
86 "c4paper", "c5paper", "c6paper", "b0j", "b1j", "b2j", "b3j", "b4j", "b5j",
91 static char const * const string_orientation[] = {
92 "portrait", "landscape", ""
96 static char const * const tex_graphics[] = {
97 "default", "dvialw", "dvilaser", "dvipdf", "dvipdfm", "dvipdfmx",
98 "dvips", "dvipsone", "dvitops", "dviwin", "dviwindo", "dvi2ps", "emtex",
99 "ln", "oztex", "pctexhp", "pctexps", "pctexwin", "pctex32", "pdftex",
100 "psprint", "pubps", "tcidvi", "textures", "truetex", "vtex", "xdvi",
111 // Paragraph separation
112 typedef Translator<string, BufferParams::ParagraphSeparation> ParSepTranslator;
115 ParSepTranslator const init_parseptranslator()
117 ParSepTranslator translator
118 (string_paragraph_separation[0], BufferParams::ParagraphIndentSeparation);
119 translator.addPair(string_paragraph_separation[1], BufferParams::ParagraphSkipSeparation);
124 ParSepTranslator const & parseptranslator()
126 static ParSepTranslator const translator =
127 init_parseptranslator();
133 typedef Translator<string, InsetQuotesParams::QuoteStyle> QuotesStyleTranslator;
136 QuotesStyleTranslator const init_quotesstyletranslator()
138 QuotesStyleTranslator translator
139 (string_quotes_style[0], InsetQuotesParams::EnglishQuotes);
140 translator.addPair(string_quotes_style[1], InsetQuotesParams::SwedishQuotes);
141 translator.addPair(string_quotes_style[2], InsetQuotesParams::GermanQuotes);
142 translator.addPair(string_quotes_style[3], InsetQuotesParams::PolishQuotes);
143 translator.addPair(string_quotes_style[4], InsetQuotesParams::SwissQuotes);
144 translator.addPair(string_quotes_style[5], InsetQuotesParams::DanishQuotes);
145 translator.addPair(string_quotes_style[6], InsetQuotesParams::PlainQuotes);
146 translator.addPair(string_quotes_style[7], InsetQuotesParams::BritishQuotes);
147 translator.addPair(string_quotes_style[8], InsetQuotesParams::SwedishGQuotes);
148 translator.addPair(string_quotes_style[9], InsetQuotesParams::FrenchQuotes);
149 translator.addPair(string_quotes_style[10], InsetQuotesParams::FrenchINQuotes);
150 translator.addPair(string_quotes_style[11], InsetQuotesParams::RussianQuotes);
151 translator.addPair(string_quotes_style[12], InsetQuotesParams::CJKQuotes);
152 translator.addPair(string_quotes_style[13], InsetQuotesParams::CJKAngleQuotes);
157 QuotesStyleTranslator const & quotesstyletranslator()
159 static QuotesStyleTranslator const translator =
160 init_quotesstyletranslator();
166 typedef Translator<string, PAPER_SIZE> PaperSizeTranslator;
169 static PaperSizeTranslator initPaperSizeTranslator()
171 PaperSizeTranslator translator(string_papersize[0], PAPER_DEFAULT);
172 translator.addPair(string_papersize[1], PAPER_CUSTOM);
173 translator.addPair(string_papersize[2], PAPER_USLETTER);
174 translator.addPair(string_papersize[3], PAPER_USLEGAL);
175 translator.addPair(string_papersize[4], PAPER_USEXECUTIVE);
176 translator.addPair(string_papersize[5], PAPER_A0);
177 translator.addPair(string_papersize[6], PAPER_A1);
178 translator.addPair(string_papersize[7], PAPER_A2);
179 translator.addPair(string_papersize[8], PAPER_A3);
180 translator.addPair(string_papersize[9], PAPER_A4);
181 translator.addPair(string_papersize[10], PAPER_A5);
182 translator.addPair(string_papersize[11], PAPER_A6);
183 translator.addPair(string_papersize[12], PAPER_B0);
184 translator.addPair(string_papersize[13], PAPER_B1);
185 translator.addPair(string_papersize[14], PAPER_B2);
186 translator.addPair(string_papersize[15], PAPER_B3);
187 translator.addPair(string_papersize[16], PAPER_B4);
188 translator.addPair(string_papersize[17], PAPER_B5);
189 translator.addPair(string_papersize[18], PAPER_B6);
190 translator.addPair(string_papersize[19], PAPER_C0);
191 translator.addPair(string_papersize[20], PAPER_C1);
192 translator.addPair(string_papersize[21], PAPER_C2);
193 translator.addPair(string_papersize[22], PAPER_C3);
194 translator.addPair(string_papersize[23], PAPER_C4);
195 translator.addPair(string_papersize[24], PAPER_C5);
196 translator.addPair(string_papersize[25], PAPER_C6);
197 translator.addPair(string_papersize[26], PAPER_JISB0);
198 translator.addPair(string_papersize[27], PAPER_JISB1);
199 translator.addPair(string_papersize[28], PAPER_JISB2);
200 translator.addPair(string_papersize[29], PAPER_JISB3);
201 translator.addPair(string_papersize[30], PAPER_JISB4);
202 translator.addPair(string_papersize[31], PAPER_JISB5);
203 translator.addPair(string_papersize[32], PAPER_JISB6);
208 PaperSizeTranslator const & papersizetranslator()
210 static PaperSizeTranslator const translator =
211 initPaperSizeTranslator();
217 typedef Translator<string, PAPER_ORIENTATION> PaperOrientationTranslator;
220 PaperOrientationTranslator const init_paperorientationtranslator()
222 PaperOrientationTranslator translator(string_orientation[0], ORIENTATION_PORTRAIT);
223 translator.addPair(string_orientation[1], ORIENTATION_LANDSCAPE);
228 PaperOrientationTranslator const & paperorientationtranslator()
230 static PaperOrientationTranslator const translator =
231 init_paperorientationtranslator();
237 typedef Translator<int, PageSides> SidesTranslator;
240 SidesTranslator const init_sidestranslator()
242 SidesTranslator translator(1, OneSide);
243 translator.addPair(2, TwoSides);
248 SidesTranslator const & sidestranslator()
250 static SidesTranslator const translator = init_sidestranslator();
256 typedef Translator<int, BufferParams::Package> PackageTranslator;
259 PackageTranslator const init_packagetranslator()
261 PackageTranslator translator(0, BufferParams::package_off);
262 translator.addPair(1, BufferParams::package_auto);
263 translator.addPair(2, BufferParams::package_on);
268 PackageTranslator const & packagetranslator()
270 static PackageTranslator const translator =
271 init_packagetranslator();
277 typedef Translator<string, Spacing::Space> SpaceTranslator;
280 SpaceTranslator const init_spacetranslator()
282 SpaceTranslator translator("default", Spacing::Default);
283 translator.addPair("single", Spacing::Single);
284 translator.addPair("onehalf", Spacing::Onehalf);
285 translator.addPair("double", Spacing::Double);
286 translator.addPair("other", Spacing::Other);
291 SpaceTranslator const & spacetranslator()
293 static SpaceTranslator const translator = init_spacetranslator();
298 bool inSystemDir(FileName const & document_dir, string & system_dir)
300 // A document is assumed to be in a system LyX directory (not
301 // necessarily the system directory of the running instance)
302 // if both "configure.py" and "chkconfig.ltx" are found in
303 // either document_dir/../ or document_dir/../../.
304 // If true, the system directory path is returned in system_dir
305 // with a trailing path separator.
307 string const msg = "Checking whether document is in a system dir...";
309 string dir = document_dir.absFileName();
311 for (int i = 0; i < 2; ++i) {
312 dir = addPath(dir, "..");
313 if (!fileSearch(dir, "configure.py").empty() &&
314 !fileSearch(dir, "chkconfig.ltx").empty()) {
315 LYXERR(Debug::FILES, msg << " yes");
316 system_dir = addPath(FileName(dir).realPath(), "");
321 LYXERR(Debug::FILES, msg << " no");
322 system_dir = string();
329 class BufferParams::Impl
334 AuthorList authorlist;
335 BranchList branchlist;
336 Bullet temp_bullets[4];
337 Bullet user_defined_bullets[4];
338 IndicesList indiceslist;
342 /** This is the amount of space used for paragraph_separation "skip",
343 * and for detached paragraphs in "indented" documents.
346 PDFOptions pdfoptions;
347 LayoutFileIndex baseClass_;
348 FormatList exportableFormatList;
349 FormatList viewableFormatList;
350 bool isViewCacheValid;
351 bool isExportCacheValid;
355 BufferParams::Impl::Impl()
356 : defskip(VSpace::MEDSKIP), baseClass_(string("")),
357 isViewCacheValid(false), isExportCacheValid(false)
359 // set initial author
361 authorlist.record(Author(from_utf8(lyxrc.user_name), from_utf8(lyxrc.user_email)));
366 BufferParams::MemoryTraits::clone(BufferParams::Impl const * ptr)
369 return new BufferParams::Impl(*ptr);
373 void BufferParams::MemoryTraits::destroy(BufferParams::Impl * ptr)
379 BufferParams::BufferParams()
382 setBaseClass(defaultBaseclass());
383 cite_engine_.push_back("basic");
384 cite_engine_type_ = ENGINE_TYPE_DEFAULT;
386 paragraph_separation = ParagraphIndentSeparation;
387 is_math_indent = false;
388 math_number_before = "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;
465 // map current author
466 author_map_[pimpl_->authorlist.get(0).bufferId()] = 0;
470 docstring BufferParams::B_(string const & l10n) const
472 LASSERT(language, return from_utf8(l10n));
473 return getMessages(language->code()).get(l10n);
477 BufferParams::Package BufferParams::use_package(std::string const & p) const
479 PackageMap::const_iterator it = use_packages.find(p);
480 if (it == use_packages.end())
486 void BufferParams::use_package(std::string const & p, BufferParams::Package u)
492 map<string, string> const & BufferParams::auto_packages()
494 static map<string, string> packages;
495 if (packages.empty()) {
496 // We could have a race condition here that two threads
497 // discover an empty map at the same time and want to fill
498 // it, but that is no problem, since the same contents is
499 // filled in twice then. Having the locker inside the
500 // packages.empty() condition has the advantage that we
501 // don't need the mutex overhead for simple reading.
503 Mutex::Locker locker(&mutex);
504 // adding a package here implies a file format change!
505 packages["amsmath"] =
506 N_("The LaTeX package amsmath is only used if AMS formula types or symbols from the AMS math toolbars are inserted into formulas");
507 packages["amssymb"] =
508 N_("The LaTeX package amssymb is only used if symbols from the AMS math toolbars are inserted into formulas");
510 N_("The LaTeX package cancel is only used if \\cancel commands are used in formulas");
512 N_("The LaTeX package esint is only used if special integral symbols are inserted into formulas");
513 packages["mathdots"] =
514 N_("The LaTeX package mathdots is only used if the command \\iddots is inserted into formulas");
515 packages["mathtools"] =
516 N_("The LaTeX package mathtools is only used if some mathematical relations are inserted into formulas");
518 N_("The LaTeX package mhchem is only used if either the command \\ce or \\cf is inserted into formulas");
519 packages["stackrel"] =
520 N_("The LaTeX package stackrel is only used if the command \\stackrel with subscript is inserted into formulas");
521 packages["stmaryrd"] =
522 N_("The LaTeX package stmaryrd is only used if symbols from the St Mary's Road symbol font for theoretical computer science are inserted into formulas");
523 packages["undertilde"] =
524 N_("The LaTeX package undertilde is only used if you use the math frame decoration 'utilde'");
530 bool BufferParams::useBibtopic() const
534 return (use_bibtopic || (!multibib.empty() && multibib != "child"));
538 AuthorList & BufferParams::authors()
540 return pimpl_->authorlist;
544 AuthorList const & BufferParams::authors() const
546 return pimpl_->authorlist;
550 void BufferParams::addAuthor(Author a)
552 author_map_[a.bufferId()] = pimpl_->authorlist.record(a);
556 BranchList & BufferParams::branchlist()
558 return pimpl_->branchlist;
562 BranchList const & BufferParams::branchlist() const
564 return pimpl_->branchlist;
568 IndicesList & BufferParams::indiceslist()
570 return pimpl_->indiceslist;
574 IndicesList const & BufferParams::indiceslist() const
576 return pimpl_->indiceslist;
580 Bullet & BufferParams::temp_bullet(lyx::size_type const index)
582 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
583 return pimpl_->temp_bullets[index];
587 Bullet const & BufferParams::temp_bullet(lyx::size_type const index) const
589 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
590 return pimpl_->temp_bullets[index];
594 Bullet & BufferParams::user_defined_bullet(lyx::size_type const index)
596 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
597 return pimpl_->user_defined_bullets[index];
601 Bullet const & BufferParams::user_defined_bullet(lyx::size_type const index) const
603 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
604 return pimpl_->user_defined_bullets[index];
608 Spacing & BufferParams::spacing()
610 return pimpl_->spacing;
614 Spacing const & BufferParams::spacing() const
616 return pimpl_->spacing;
620 PDFOptions & BufferParams::pdfoptions()
622 return pimpl_->pdfoptions;
626 PDFOptions const & BufferParams::pdfoptions() const
628 return pimpl_->pdfoptions;
632 Length const & BufferParams::getMathIndent() const
634 return pimpl_->mathindent;
638 void BufferParams::setMathIndent(Length const & indent)
640 pimpl_->mathindent = indent;
644 Length const & BufferParams::getParIndent() const
646 return pimpl_->parindent;
650 void BufferParams::setParIndent(Length const & indent)
652 pimpl_->parindent = indent;
656 VSpace const & BufferParams::getDefSkip() const
658 return pimpl_->defskip;
662 void BufferParams::setDefSkip(VSpace const & vs)
664 // DEFSKIP will cause an infinite loop
665 LASSERT(vs.kind() != VSpace::DEFSKIP, return);
666 pimpl_->defskip = vs;
670 string BufferParams::readToken(Lexer & lex, string const & token,
671 FileName const & filepath)
675 if (token == "\\textclass") {
677 string const classname = lex.getString();
678 // if there exists a local layout file, ignore the system one
679 // NOTE: in this case, the textclass (.cls file) is assumed to
682 LayoutFileList & bcl = LayoutFileList::get();
683 if (!filepath.empty()) {
684 // If classname is an absolute path, the document is
685 // using a local layout file which could not be accessed
686 // by a relative path. In this case the path is correct
687 // even if the document was moved to a different
688 // location. However, we will have a problem if the
689 // document was generated on a different platform.
690 bool isabsolute = FileName::isAbsolute(classname);
691 string const classpath = onlyPath(classname);
692 string const path = isabsolute ? classpath
693 : FileName(addPath(filepath.absFileName(),
694 classpath)).realPath();
695 string const oldpath = isabsolute ? string()
696 : FileName(addPath(origin, classpath)).realPath();
697 tcp = bcl.addLocalLayout(onlyFileName(classname), path, oldpath);
699 // that returns non-empty if a "local" layout file is found.
701 result = to_utf8(makeRelPath(from_utf8(onlyPath(tcp)),
702 from_utf8(filepath.absFileName())));
705 setBaseClass(onlyFileName(tcp));
707 setBaseClass(onlyFileName(classname));
708 // We assume that a tex class exists for local or unknown
709 // layouts so this warning, will only be given for system layouts.
710 if (!baseClass()->isTeXClassAvailable()) {
711 docstring const desc =
712 translateIfPossible(from_utf8(baseClass()->description()));
713 docstring const prereqs =
714 from_utf8(baseClass()->prerequisites());
715 docstring const msg =
716 bformat(_("The selected document class\n"
718 "requires external files that are not available.\n"
719 "The document class can still be used, but the\n"
720 "document cannot be compiled until the following\n"
721 "prerequisites are installed:\n"
723 "See section 3.1.2.2 (Class Availability) of the\n"
724 "User's Guide for more information."), desc, prereqs);
725 frontend::Alert::warning(_("Document class not available"),
728 } else if (token == "\\save_transient_properties") {
729 lex >> save_transient_properties;
730 } else if (token == "\\origin") {
732 origin = lex.getString();
733 string const sysdirprefix = "/systemlyxdir/";
734 if (prefixIs(origin, sysdirprefix)) {
736 if (inSystemDir(filepath, docsys))
737 origin.replace(0, sysdirprefix.length() - 1, docsys);
739 origin.replace(0, sysdirprefix.length() - 1,
740 package().system_support().absFileName());
742 } else if (token == "\\begin_preamble") {
744 } else if (token == "\\begin_local_layout") {
745 readLocalLayout(lex, false);
746 } else if (token == "\\begin_forced_local_layout") {
747 readLocalLayout(lex, true);
748 } else if (token == "\\begin_modules") {
750 } else if (token == "\\begin_removed_modules") {
751 readRemovedModules(lex);
752 } else if (token == "\\begin_includeonly") {
753 readIncludeonly(lex);
754 } else if (token == "\\maintain_unincluded_children") {
755 lex >> maintain_unincluded_children;
756 } else if (token == "\\options") {
758 options = lex.getString();
759 } else if (token == "\\use_default_options") {
760 lex >> use_default_options;
761 } else if (token == "\\master") {
763 master = lex.getString();
764 if (!filepath.empty() && FileName::isAbsolute(origin)) {
765 bool const isabs = FileName::isAbsolute(master);
766 FileName const abspath(isabs ? master : origin + master);
767 bool const moved = filepath != FileName(origin);
768 if (moved && abspath.exists()) {
769 docstring const path = isabs
771 : from_utf8(abspath.realPath());
772 docstring const refpath =
773 from_utf8(filepath.absFileName());
774 master = to_utf8(makeRelPath(path, refpath));
777 } else if (token == "\\suppress_date") {
778 lex >> suppress_date;
779 } else if (token == "\\justification") {
780 lex >> justification;
781 } else if (token == "\\language") {
783 } else if (token == "\\language_package") {
785 lang_package = lex.getString();
786 } else if (token == "\\inputencoding") {
788 } else if (token == "\\graphics") {
789 readGraphicsDriver(lex);
790 } else if (token == "\\default_output_format") {
791 lex >> default_output_format;
792 } else if (token == "\\bibtex_command") {
794 bibtex_command = lex.getString();
795 } else if (token == "\\index_command") {
797 index_command = lex.getString();
798 } else if (token == "\\fontencoding") {
800 fontenc = lex.getString();
801 } else if (token == "\\font_roman") {
802 lex >> fonts_roman[0];
803 lex >> fonts_roman[1];
804 } else if (token == "\\font_sans") {
805 lex >> fonts_sans[0];
806 lex >> fonts_sans[1];
807 } else if (token == "\\font_typewriter") {
808 lex >> fonts_typewriter[0];
809 lex >> fonts_typewriter[1];
810 } else if (token == "\\font_math") {
811 lex >> fonts_math[0];
812 lex >> fonts_math[1];
813 } else if (token == "\\font_default_family") {
814 lex >> fonts_default_family;
815 } else if (token == "\\use_non_tex_fonts") {
816 lex >> useNonTeXFonts;
817 } else if (token == "\\font_sc") {
818 lex >> fonts_expert_sc;
819 } else if (token == "\\font_osf") {
820 lex >> fonts_old_figures;
821 } else if (token == "\\font_sf_scale") {
822 lex >> fonts_sans_scale[0];
823 lex >> fonts_sans_scale[1];
824 } else if (token == "\\font_tt_scale") {
825 lex >> fonts_typewriter_scale[0];
826 lex >> fonts_typewriter_scale[1];
827 } else if (token == "\\font_cjk") {
829 } else if (token == "\\use_microtype") {
830 lex >> use_microtype;
831 } else if (token == "\\use_dash_ligatures") {
832 lex >> use_dash_ligatures;
833 } else if (token == "\\paragraph_separation") {
836 paragraph_separation = parseptranslator().find(parsep);
837 } else if (token == "\\paragraph_indentation") {
839 string parindent = lex.getString();
840 if (parindent == "default")
841 pimpl_->parindent = Length();
843 pimpl_->parindent = Length(parindent);
844 } else if (token == "\\defskip") {
846 string const defskip = lex.getString();
847 pimpl_->defskip = VSpace(defskip);
848 if (pimpl_->defskip.kind() == VSpace::DEFSKIP)
850 pimpl_->defskip = VSpace(VSpace::MEDSKIP);
851 } else if (token == "\\is_math_indent") {
852 lex >> is_math_indent;
853 } else if (token == "\\math_indentation") {
855 pimpl_->mathindent = Length(lex.getString());
856 } else if (token == "\\math_number_before") {
857 lex >> math_number_before;
858 } else if (token == "\\quotes_style") {
861 quotes_style = quotesstyletranslator().find(qstyle);
862 } else if (token == "\\dynamic_quotes") {
863 lex >> dynamic_quotes;
864 } else if (token == "\\papersize") {
867 papersize = papersizetranslator().find(ppsize);
868 } else if (token == "\\use_geometry") {
870 } else if (token == "\\use_package") {
875 use_package(package, packagetranslator().find(use));
876 } else if (token == "\\cite_engine") {
878 vector<string> engine = getVectorFromString(lex.getString());
879 setCiteEngine(engine);
880 } else if (token == "\\cite_engine_type") {
883 cite_engine_type_ = theCiteEnginesList.getType(engine_type);
884 } else if (token == "\\biblio_style") {
886 biblio_style = lex.getString();
887 } else if (token == "\\biblio_options") {
889 biblio_opts = trim(lex.getString());
890 } else if (token == "\\biblatex_bibstyle") {
892 biblatex_bibstyle = trim(lex.getString());
893 } else if (token == "\\biblatex_citestyle") {
895 biblatex_citestyle = trim(lex.getString());
896 } else if (token == "\\use_bibtopic") {
898 } else if (token == "\\multibib") {
900 } else if (token == "\\use_indices") {
902 } else if (token == "\\tracking_changes") {
903 lex >> track_changes;
904 } else if (token == "\\output_changes") {
905 lex >> output_changes;
906 } else if (token == "\\branch") {
908 docstring branch = lex.getDocString();
909 branchlist().add(branch);
912 string const tok = lex.getString();
913 if (tok == "\\end_branch")
915 Branch * branch_ptr = branchlist().find(branch);
916 if (tok == "\\selected") {
919 branch_ptr->setSelected(lex.getInteger());
921 if (tok == "\\filename_suffix") {
924 branch_ptr->setFileNameSuffix(lex.getInteger());
926 if (tok == "\\color") {
928 string color = lex.getString();
930 branch_ptr->setColor(color);
931 // Update also the Color table:
933 color = lcolor.getX11Name(Color_background);
935 lcolor.setColor(to_utf8(branch), color);
938 } else if (token == "\\index") {
940 docstring index = lex.getDocString();
942 indiceslist().add(index);
945 string const tok = lex.getString();
946 if (tok == "\\end_index")
948 Index * index_ptr = indiceslist().find(index);
949 if (tok == "\\shortcut") {
951 shortcut = lex.getDocString();
953 index_ptr->setShortcut(shortcut);
955 if (tok == "\\color") {
957 string color = lex.getString();
959 index_ptr->setColor(color);
960 // Update also the Color table:
962 color = lcolor.getX11Name(Color_background);
964 if (!shortcut.empty())
965 lcolor.setColor(to_utf8(shortcut), color);
968 } else if (token == "\\author") {
970 istringstream ss(lex.getString());
974 } else if (token == "\\paperorientation") {
977 orientation = paperorientationtranslator().find(orient);
978 } else if (token == "\\backgroundcolor") {
980 backgroundcolor = lyx::rgbFromHexName(lex.getString());
981 isbackgroundcolor = true;
982 } else if (token == "\\fontcolor") {
984 fontcolor = lyx::rgbFromHexName(lex.getString());
986 } else if (token == "\\notefontcolor") {
988 string color = lex.getString();
989 notefontcolor = lyx::rgbFromHexName(color);
990 lcolor.setColor("notefontcolor", color);
991 } else if (token == "\\boxbgcolor") {
993 string color = lex.getString();
994 boxbgcolor = lyx::rgbFromHexName(color);
995 lcolor.setColor("boxbgcolor", color);
996 } else if (token == "\\paperwidth") {
998 } else if (token == "\\paperheight") {
1000 } else if (token == "\\leftmargin") {
1002 } else if (token == "\\topmargin") {
1004 } else if (token == "\\rightmargin") {
1006 } else if (token == "\\bottommargin") {
1007 lex >> bottommargin;
1008 } else if (token == "\\headheight") {
1010 } else if (token == "\\headsep") {
1012 } else if (token == "\\footskip") {
1014 } else if (token == "\\columnsep") {
1016 } else if (token == "\\paperfontsize") {
1018 } else if (token == "\\papercolumns") {
1020 } else if (token == "\\listings_params") {
1023 listings_params = InsetListingsParams(par).params();
1024 } else if (token == "\\papersides") {
1027 sides = sidestranslator().find(psides);
1028 } else if (token == "\\paperpagestyle") {
1030 } else if (token == "\\bullet") {
1032 } else if (token == "\\bulletLaTeX") {
1033 readBulletsLaTeX(lex);
1034 } else if (token == "\\secnumdepth") {
1036 } else if (token == "\\tocdepth") {
1038 } else if (token == "\\spacing") {
1042 if (nspacing == "other") {
1045 spacing().set(spacetranslator().find(nspacing), tmp_val);
1046 } else if (token == "\\float_placement") {
1047 lex >> float_placement;
1049 } else if (prefixIs(token, "\\pdf_") || token == "\\use_hyperref") {
1050 string toktmp = pdfoptions().readToken(lex, token);
1051 if (!toktmp.empty()) {
1052 lyxerr << "PDFOptions::readToken(): Unknown token: " <<
1056 } else if (token == "\\html_math_output") {
1059 html_math_output = static_cast<MathOutput>(temp);
1060 } else if (token == "\\html_be_strict") {
1061 lex >> html_be_strict;
1062 } else if (token == "\\html_css_as_file") {
1063 lex >> html_css_as_file;
1064 } else if (token == "\\html_math_img_scale") {
1065 lex >> html_math_img_scale;
1066 } else if (token == "\\html_latex_start") {
1068 html_latex_start = lex.getString();
1069 } else if (token == "\\html_latex_end") {
1071 html_latex_end = lex.getString();
1072 } else if (token == "\\output_sync") {
1074 } else if (token == "\\output_sync_macro") {
1075 lex >> output_sync_macro;
1076 } else if (token == "\\use_refstyle") {
1077 lex >> use_refstyle;
1079 lyxerr << "BufferParams::readToken(): Unknown token: " <<
1089 // Quote argument if it contains spaces
1090 string quoteIfNeeded(string const & str) {
1091 if (contains(str, ' '))
1092 return "\"" + str + "\"";
1098 void BufferParams::writeFile(ostream & os, Buffer const * buf) const
1100 // The top of the file is written by the buffer.
1101 // Prints out the buffer info into the .lyx file given by file
1103 os << "\\save_transient_properties "
1104 << convert<string>(save_transient_properties) << '\n';
1106 // the document directory (must end with a path separator)
1107 // realPath() is used to resolve symlinks, while addPath(..., "")
1108 // ensures a trailing path separator.
1110 string filepath = addPath(buf->fileName().onlyPath().realPath(), "");
1111 string const sysdir = inSystemDir(FileName(filepath), docsys) ? docsys
1112 : addPath(package().system_support().realPath(), "");
1113 string const relpath =
1114 to_utf8(makeRelPath(from_utf8(filepath), from_utf8(sysdir)));
1115 if (!prefixIs(relpath, "../") && !FileName::isAbsolute(relpath))
1116 filepath = addPath("/systemlyxdir", relpath);
1117 else if (!save_transient_properties || !lyxrc.save_origin)
1118 filepath = "unavailable";
1119 os << "\\origin " << quoteIfNeeded(filepath) << '\n';
1122 os << "\\textclass "
1123 << quoteIfNeeded(buf->includedFilePath(addName(buf->layoutPos(),
1124 baseClass()->name()), "layout"))
1127 // then the preamble
1128 if (!preamble.empty()) {
1129 // remove '\n' from the end of preamble
1130 docstring const tmppreamble = rtrim(preamble, "\n");
1131 os << "\\begin_preamble\n"
1132 << to_utf8(tmppreamble)
1133 << "\n\\end_preamble\n";
1137 if (!options.empty()) {
1138 os << "\\options " << options << '\n';
1141 // use the class options defined in the layout?
1142 os << "\\use_default_options "
1143 << convert<string>(use_default_options) << "\n";
1145 // the master document
1146 if (!master.empty()) {
1147 os << "\\master " << master << '\n';
1151 if (!removed_modules_.empty()) {
1152 os << "\\begin_removed_modules" << '\n';
1153 list<string>::const_iterator it = removed_modules_.begin();
1154 list<string>::const_iterator en = removed_modules_.end();
1155 for (; it != en; ++it)
1157 os << "\\end_removed_modules" << '\n';
1161 if (!layout_modules_.empty()) {
1162 os << "\\begin_modules" << '\n';
1163 LayoutModuleList::const_iterator it = layout_modules_.begin();
1164 LayoutModuleList::const_iterator en = layout_modules_.end();
1165 for (; it != en; ++it)
1167 os << "\\end_modules" << '\n';
1171 if (!included_children_.empty()) {
1172 os << "\\begin_includeonly" << '\n';
1173 list<string>::const_iterator it = included_children_.begin();
1174 list<string>::const_iterator en = included_children_.end();
1175 for (; it != en; ++it)
1177 os << "\\end_includeonly" << '\n';
1179 os << "\\maintain_unincluded_children "
1180 << convert<string>(maintain_unincluded_children) << '\n';
1182 // local layout information
1183 docstring const local_layout = getLocalLayout(false);
1184 if (!local_layout.empty()) {
1185 // remove '\n' from the end
1186 docstring const tmplocal = rtrim(local_layout, "\n");
1187 os << "\\begin_local_layout\n"
1188 << to_utf8(tmplocal)
1189 << "\n\\end_local_layout\n";
1191 docstring const forced_local_layout = getLocalLayout(true);
1192 if (!forced_local_layout.empty()) {
1193 // remove '\n' from the end
1194 docstring const tmplocal = rtrim(forced_local_layout, "\n");
1195 os << "\\begin_forced_local_layout\n"
1196 << to_utf8(tmplocal)
1197 << "\n\\end_forced_local_layout\n";
1200 // then the text parameters
1201 if (language != ignore_language)
1202 os << "\\language " << language->lang() << '\n';
1203 os << "\\language_package " << lang_package
1204 << "\n\\inputencoding " << inputenc
1205 << "\n\\fontencoding " << fontenc
1206 << "\n\\font_roman \"" << fonts_roman[0]
1207 << "\" \"" << fonts_roman[1] << '"'
1208 << "\n\\font_sans \"" << fonts_sans[0]
1209 << "\" \"" << fonts_sans[1] << '"'
1210 << "\n\\font_typewriter \"" << fonts_typewriter[0]
1211 << "\" \"" << fonts_typewriter[1] << '"'
1212 << "\n\\font_math \"" << fonts_math[0]
1213 << "\" \"" << fonts_math[1] << '"'
1214 << "\n\\font_default_family " << fonts_default_family
1215 << "\n\\use_non_tex_fonts " << convert<string>(useNonTeXFonts)
1216 << "\n\\font_sc " << convert<string>(fonts_expert_sc)
1217 << "\n\\font_osf " << convert<string>(fonts_old_figures)
1218 << "\n\\font_sf_scale " << fonts_sans_scale[0]
1219 << ' ' << fonts_sans_scale[1]
1220 << "\n\\font_tt_scale " << fonts_typewriter_scale[0]
1221 << ' ' << fonts_typewriter_scale[1]
1223 if (!fonts_cjk.empty()) {
1224 os << "\\font_cjk " << fonts_cjk << '\n';
1226 os << "\\use_microtype " << convert<string>(use_microtype) << '\n';
1227 os << "\\use_dash_ligatures " << convert<string>(use_dash_ligatures) << '\n';
1228 os << "\\graphics " << graphics_driver << '\n';
1229 os << "\\default_output_format " << default_output_format << '\n';
1230 os << "\\output_sync " << output_sync << '\n';
1231 if (!output_sync_macro.empty())
1232 os << "\\output_sync_macro \"" << output_sync_macro << "\"\n";
1233 os << "\\bibtex_command " << bibtex_command << '\n';
1234 os << "\\index_command " << index_command << '\n';
1236 if (!float_placement.empty()) {
1237 os << "\\float_placement " << float_placement << '\n';
1239 os << "\\paperfontsize " << fontsize << '\n';
1241 spacing().writeFile(os);
1242 pdfoptions().writeFile(os);
1244 os << "\\papersize " << string_papersize[papersize]
1245 << "\n\\use_geometry " << convert<string>(use_geometry);
1246 map<string, string> const & packages = auto_packages();
1247 for (map<string, string>::const_iterator it = packages.begin();
1248 it != packages.end(); ++it)
1249 os << "\n\\use_package " << it->first << ' '
1250 << use_package(it->first);
1252 os << "\n\\cite_engine ";
1254 if (!cite_engine_.empty()) {
1255 LayoutModuleList::const_iterator be = cite_engine_.begin();
1256 LayoutModuleList::const_iterator en = cite_engine_.end();
1257 for (LayoutModuleList::const_iterator it = be; it != en; ++it) {
1266 os << "\n\\cite_engine_type " << theCiteEnginesList.getTypeAsString(cite_engine_type_);
1268 if (!biblio_style.empty())
1269 os << "\n\\biblio_style " << biblio_style;
1270 if (!biblio_opts.empty())
1271 os << "\n\\biblio_options " << biblio_opts;
1272 if (!biblatex_bibstyle.empty())
1273 os << "\n\\biblatex_bibstyle " << biblatex_bibstyle;
1274 if (!biblatex_citestyle.empty())
1275 os << "\n\\biblatex_citestyle " << biblatex_citestyle;
1276 if (!multibib.empty())
1277 os << "\n\\multibib " << multibib;
1279 os << "\n\\use_bibtopic " << convert<string>(use_bibtopic)
1280 << "\n\\use_indices " << convert<string>(use_indices)
1281 << "\n\\paperorientation " << string_orientation[orientation]
1282 << "\n\\suppress_date " << convert<string>(suppress_date)
1283 << "\n\\justification " << convert<string>(justification)
1284 << "\n\\use_refstyle " << use_refstyle
1286 if (isbackgroundcolor == true)
1287 os << "\\backgroundcolor " << lyx::X11hexname(backgroundcolor) << '\n';
1288 if (isfontcolor == true)
1289 os << "\\fontcolor " << lyx::X11hexname(fontcolor) << '\n';
1290 if (notefontcolor != lyx::rgbFromHexName("#cccccc"))
1291 os << "\\notefontcolor " << lyx::X11hexname(notefontcolor) << '\n';
1292 if (boxbgcolor != lyx::rgbFromHexName("#ff0000"))
1293 os << "\\boxbgcolor " << lyx::X11hexname(boxbgcolor) << '\n';
1295 BranchList::const_iterator it = branchlist().begin();
1296 BranchList::const_iterator end = branchlist().end();
1297 for (; it != end; ++it) {
1298 os << "\\branch " << to_utf8(it->branch())
1299 << "\n\\selected " << it->isSelected()
1300 << "\n\\filename_suffix " << it->hasFileNameSuffix()
1301 << "\n\\color " << lyx::X11hexname(it->color())
1306 IndicesList::const_iterator iit = indiceslist().begin();
1307 IndicesList::const_iterator iend = indiceslist().end();
1308 for (; iit != iend; ++iit) {
1309 os << "\\index " << to_utf8(iit->index())
1310 << "\n\\shortcut " << to_utf8(iit->shortcut())
1311 << "\n\\color " << lyx::X11hexname(iit->color())
1316 if (!paperwidth.empty())
1317 os << "\\paperwidth "
1318 << VSpace(paperwidth).asLyXCommand() << '\n';
1319 if (!paperheight.empty())
1320 os << "\\paperheight "
1321 << VSpace(paperheight).asLyXCommand() << '\n';
1322 if (!leftmargin.empty())
1323 os << "\\leftmargin "
1324 << VSpace(leftmargin).asLyXCommand() << '\n';
1325 if (!topmargin.empty())
1326 os << "\\topmargin "
1327 << VSpace(topmargin).asLyXCommand() << '\n';
1328 if (!rightmargin.empty())
1329 os << "\\rightmargin "
1330 << VSpace(rightmargin).asLyXCommand() << '\n';
1331 if (!bottommargin.empty())
1332 os << "\\bottommargin "
1333 << VSpace(bottommargin).asLyXCommand() << '\n';
1334 if (!headheight.empty())
1335 os << "\\headheight "
1336 << VSpace(headheight).asLyXCommand() << '\n';
1337 if (!headsep.empty())
1339 << VSpace(headsep).asLyXCommand() << '\n';
1340 if (!footskip.empty())
1342 << VSpace(footskip).asLyXCommand() << '\n';
1343 if (!columnsep.empty())
1344 os << "\\columnsep "
1345 << VSpace(columnsep).asLyXCommand() << '\n';
1346 os << "\\secnumdepth " << secnumdepth
1347 << "\n\\tocdepth " << tocdepth
1348 << "\n\\paragraph_separation "
1349 << string_paragraph_separation[paragraph_separation];
1350 if (!paragraph_separation)
1351 os << "\n\\paragraph_indentation "
1352 << (getParIndent().empty() ? "default" : getParIndent().asString());
1354 os << "\n\\defskip " << getDefSkip().asLyXCommand();
1355 os << "\n\\is_math_indent " << is_math_indent;
1356 if (is_math_indent && !getMathIndent().empty())
1357 os << "\n\\math_indentation " << getMathIndent().asString();
1358 os << "\n\\math_number_before " << math_number_before;
1359 os << "\n\\quotes_style "
1360 << string_quotes_style[quotes_style]
1361 << "\n\\dynamic_quotes " << dynamic_quotes
1362 << "\n\\papercolumns " << columns
1363 << "\n\\papersides " << sides
1364 << "\n\\paperpagestyle " << pagestyle << '\n';
1365 if (!listings_params.empty())
1366 os << "\\listings_params \"" <<
1367 InsetListingsParams(listings_params).encodedString() << "\"\n";
1368 for (int i = 0; i < 4; ++i) {
1369 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1370 if (user_defined_bullet(i).getFont() != -1) {
1371 os << "\\bullet " << i << " "
1372 << user_defined_bullet(i).getFont() << " "
1373 << user_defined_bullet(i).getCharacter() << " "
1374 << user_defined_bullet(i).getSize() << "\n";
1378 os << "\\bulletLaTeX " << i << " \""
1379 << lyx::to_ascii(user_defined_bullet(i).getText())
1385 os << "\\tracking_changes "
1386 << (save_transient_properties ? convert<string>(track_changes) : "false")
1389 os << "\\output_changes "
1390 << (save_transient_properties ? convert<string>(output_changes) : "false")
1393 os << "\\html_math_output " << html_math_output << '\n'
1394 << "\\html_css_as_file " << html_css_as_file << '\n'
1395 << "\\html_be_strict " << convert<string>(html_be_strict) << '\n';
1397 if (html_math_img_scale != 1.0)
1398 os << "\\html_math_img_scale " << convert<string>(html_math_img_scale) << '\n';
1399 if (!html_latex_start.empty())
1400 os << "\\html_latex_start " << html_latex_start << '\n';
1401 if (!html_latex_end.empty())
1402 os << "\\html_latex_end " << html_latex_end << '\n';
1404 os << pimpl_->authorlist;
1408 void BufferParams::validate(LaTeXFeatures & features) const
1410 features.require(documentClass().requires());
1412 if (columns > 1 && language->rightToLeft())
1413 features.require("rtloutputdblcol");
1415 if (output_changes) {
1416 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1417 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1418 LaTeXFeatures::isAvailable("xcolor");
1420 switch (features.runparams().flavor) {
1421 case OutputParams::LATEX:
1422 case OutputParams::DVILUATEX:
1424 features.require("ct-dvipost");
1425 features.require("dvipost");
1426 } else if (xcolorulem) {
1427 features.require("ct-xcolor-ulem");
1428 features.require("ulem");
1429 features.require("xcolor");
1431 features.require("ct-none");
1434 case OutputParams::LUATEX:
1435 case OutputParams::PDFLATEX:
1436 case OutputParams::XETEX:
1438 features.require("ct-xcolor-ulem");
1439 features.require("ulem");
1440 features.require("xcolor");
1441 // improves color handling in PDF output
1442 features.require("pdfcolmk");
1444 features.require("ct-none");
1452 // Floats with 'Here definitely' as default setting.
1453 if (float_placement.find('H') != string::npos)
1454 features.require("float");
1456 for (PackageMap::const_iterator it = use_packages.begin();
1457 it != use_packages.end(); ++it) {
1458 if (it->first == "amsmath") {
1459 // AMS Style is at document level
1460 if (it->second == package_on ||
1461 features.isProvided("amsmath"))
1462 features.require(it->first);
1463 } else if (it->second == package_on)
1464 features.require(it->first);
1467 // Document-level line spacing
1468 if (spacing().getSpace() != Spacing::Single && !spacing().isDefault())
1469 features.require("setspace");
1471 // the bullet shapes are buffer level not paragraph level
1472 // so they are tested here
1473 for (int i = 0; i < 4; ++i) {
1474 if (user_defined_bullet(i) == ITEMIZE_DEFAULTS[i])
1476 int const font = user_defined_bullet(i).getFont();
1478 int const c = user_defined_bullet(i).getCharacter();
1484 features.require("latexsym");
1486 } else if (font == 1) {
1487 features.require("amssymb");
1488 } else if (font >= 2 && font <= 5) {
1489 features.require("pifont");
1493 if (pdfoptions().use_hyperref) {
1494 features.require("hyperref");
1495 // due to interferences with babel and hyperref, the color package has to
1496 // be loaded after hyperref when hyperref is used with the colorlinks
1497 // option, see http://www.lyx.org/trac/ticket/5291
1498 if (pdfoptions().colorlinks)
1499 features.require("color");
1501 if (!listings_params.empty()) {
1502 // do not test validity because listings_params is
1503 // supposed to be valid
1505 InsetListingsParams(listings_params).separatedParams(true);
1506 // we can't support all packages, but we should load the color package
1507 if (par.find("\\color", 0) != string::npos)
1508 features.require("color");
1511 // some languages are only available via polyglossia
1512 if (features.hasPolyglossiaExclusiveLanguages())
1513 features.require("polyglossia");
1515 if (useNonTeXFonts && fontsMath() != "auto")
1516 features.require("unicode-math");
1519 features.require("microtype");
1521 if (!language->requires().empty())
1522 features.require(language->requires());
1526 bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
1527 FileName const & filepath) const
1529 // http://www.tug.org/texmf-dist/doc/latex/base/fixltx2e.pdf
1530 // !! To use the Fix-cm package, load it before \documentclass, and use the command
1531 // \RequirePackage to do so, rather than the normal \usepackage
1532 // Do not try to load any other package before the document class, unless you
1533 // have a thorough understanding of the LATEX internals and know exactly what you
1535 if (features.mustProvide("fix-cm"))
1536 os << "\\RequirePackage{fix-cm}\n";
1537 // Likewise for fixltx2e. If other packages conflict with this policy,
1538 // treat it as a package bug (and report it!)
1539 // See http://www.latex-project.org/cgi-bin/ltxbugs2html?pr=latex/4407
1540 if (features.mustProvide("fixltx2e"))
1541 os << "\\RequirePackage{fixltx2e}\n";
1543 os << "\\documentclass";
1545 DocumentClass const & tclass = documentClass();
1547 ostringstream clsoptions; // the document class options.
1549 if (tokenPos(tclass.opt_fontsize(),
1550 '|', fontsize) >= 0) {
1551 // only write if existing in list (and not default)
1552 clsoptions << fontsize << "pt,";
1555 // all paper sizes except of A4, A5, B5 and the US sizes need the
1557 bool nonstandard_papersize = papersize != PAPER_DEFAULT
1558 && papersize != PAPER_USLETTER
1559 && papersize != PAPER_USLEGAL
1560 && papersize != PAPER_USEXECUTIVE
1561 && papersize != PAPER_A4
1562 && papersize != PAPER_A5
1563 && papersize != PAPER_B5;
1565 if (!use_geometry) {
1566 switch (papersize) {
1568 clsoptions << "a4paper,";
1570 case PAPER_USLETTER:
1571 clsoptions << "letterpaper,";
1574 clsoptions << "a5paper,";
1577 clsoptions << "b5paper,";
1579 case PAPER_USEXECUTIVE:
1580 clsoptions << "executivepaper,";
1583 clsoptions << "legalpaper,";
1617 if (sides != tclass.sides()) {
1620 clsoptions << "oneside,";
1623 clsoptions << "twoside,";
1629 if (columns != tclass.columns()) {
1631 clsoptions << "twocolumn,";
1633 clsoptions << "onecolumn,";
1637 && orientation == ORIENTATION_LANDSCAPE)
1638 clsoptions << "landscape,";
1641 clsoptions << "fleqn,";
1643 if (math_number_before == "true")
1644 clsoptions << "leqno,";
1645 else if (math_number_before == "false") {
1646 clsoptions << "reqno,";
1647 features.require("amsmath");
1650 // language should be a parameter to \documentclass
1651 if (language->babel() == "hebrew"
1652 && default_language->babel() != "hebrew")
1653 // This seems necessary
1654 features.useLanguage(default_language);
1656 ostringstream language_options;
1657 bool const use_babel = features.useBabel() && !features.isProvided("babel");
1658 bool const use_polyglossia = features.usePolyglossia();
1659 bool const global = lyxrc.language_global_options;
1660 if (use_babel || (use_polyglossia && global)) {
1661 language_options << features.getBabelLanguages();
1662 if (!language->babel().empty()) {
1663 if (!language_options.str().empty())
1664 language_options << ',';
1665 language_options << language->babel();
1667 if (global && !features.needBabelLangOptions()
1668 && !language_options.str().empty())
1669 clsoptions << language_options.str() << ',';
1672 // the predefined options from the layout
1673 if (use_default_options && !tclass.options().empty())
1674 clsoptions << tclass.options() << ',';
1676 // the user-defined options
1677 if (!options.empty()) {
1678 clsoptions << options << ',';
1681 string strOptions(clsoptions.str());
1682 if (!strOptions.empty()) {
1683 strOptions = rtrim(strOptions, ",");
1685 os << '[' << from_utf8(strOptions) << ']';
1688 os << '{' << from_ascii(tclass.latexname()) << "}\n";
1689 // end of \documentclass defs
1691 // if we use fontspec or newtxmath, we have to load the AMS packages here
1692 string const ams = features.loadAMSPackages();
1693 bool const ot1 = (main_font_encoding() == "default" || main_font_encoding() == "OT1");
1694 bool const use_newtxmath =
1695 theLaTeXFonts().getLaTeXFont(from_ascii(fontsMath())).getUsedPackage(
1696 ot1, false, false) == "newtxmath";
1697 if ((useNonTeXFonts || use_newtxmath) && !ams.empty())
1698 os << from_ascii(ams);
1700 if (useNonTeXFonts) {
1701 if (!features.isProvided("fontspec"))
1702 os << "\\usepackage{fontspec}\n";
1703 if (features.mustProvide("unicode-math")
1704 && features.isAvailable("unicode-math"))
1705 os << "\\usepackage{unicode-math}\n";
1708 // font selection must be done before loading fontenc.sty
1709 string const fonts = loadFonts(features);
1711 os << from_utf8(fonts);
1713 if (fonts_default_family != "default")
1714 os << "\\renewcommand{\\familydefault}{\\"
1715 << from_ascii(fonts_default_family) << "}\n";
1717 // set font encoding
1718 // XeTeX and LuaTeX (with OS fonts) do not need fontenc
1719 if (!useNonTeXFonts && !features.isProvided("fontenc")
1720 && main_font_encoding() != "default") {
1721 // get main font encodings
1722 vector<string> fontencs = font_encodings();
1723 // get font encodings of secondary languages
1724 features.getFontEncodings(fontencs);
1725 if (!fontencs.empty()) {
1726 os << "\\usepackage["
1727 << from_ascii(getStringFromVector(fontencs))
1732 // handle inputenc etc.
1733 writeEncodingPreamble(os, features);
1736 if (!features.runparams().includeall && !included_children_.empty()) {
1737 os << "\\includeonly{";
1738 list<string>::const_iterator it = included_children_.begin();
1739 list<string>::const_iterator en = included_children_.end();
1741 for (; it != en; ++it) {
1742 string incfile = *it;
1743 FileName inc = makeAbsPath(incfile, filepath.absFileName());
1744 string mangled = DocFileName(changeExtension(inc.absFileName(), ".tex")).
1746 if (!features.runparams().nice)
1748 // \includeonly doesn't want an extension
1749 incfile = changeExtension(incfile, string());
1750 incfile = support::latex_path(incfile);
1751 if (!incfile.empty()) {
1754 os << from_utf8(incfile);
1761 if (!features.isProvided("geometry")
1762 && (use_geometry || nonstandard_papersize)) {
1763 odocstringstream ods;
1764 if (!getGraphicsDriver("geometry").empty())
1765 ods << getGraphicsDriver("geometry");
1766 if (orientation == ORIENTATION_LANDSCAPE)
1767 ods << ",landscape";
1768 switch (papersize) {
1770 if (!paperwidth.empty())
1771 ods << ",paperwidth="
1772 << from_ascii(paperwidth);
1773 if (!paperheight.empty())
1774 ods << ",paperheight="
1775 << from_ascii(paperheight);
1777 case PAPER_USLETTER:
1778 ods << ",letterpaper";
1781 ods << ",legalpaper";
1783 case PAPER_USEXECUTIVE:
1784 ods << ",executivepaper";
1873 docstring const g_options = trim(ods.str(), ",");
1874 os << "\\usepackage";
1875 if (!g_options.empty())
1876 os << '[' << g_options << ']';
1877 os << "{geometry}\n";
1878 // output this only if use_geometry is true
1880 os << "\\geometry{verbose";
1881 if (!topmargin.empty())
1882 os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1883 if (!bottommargin.empty())
1884 os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1885 if (!leftmargin.empty())
1886 os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1887 if (!rightmargin.empty())
1888 os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1889 if (!headheight.empty())
1890 os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1891 if (!headsep.empty())
1892 os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1893 if (!footskip.empty())
1894 os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1895 if (!columnsep.empty())
1896 os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
1899 } else if (orientation == ORIENTATION_LANDSCAPE
1900 || papersize != PAPER_DEFAULT) {
1901 features.require("papersize");
1904 if (tokenPos(tclass.opt_pagestyle(), '|', pagestyle) >= 0) {
1905 if (pagestyle == "fancy")
1906 os << "\\usepackage{fancyhdr}\n";
1907 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1910 // only output when the background color is not default
1911 if (isbackgroundcolor == true) {
1912 // only require color here, the background color will be defined
1913 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1915 features.require("color");
1916 features.require("pagecolor");
1919 // only output when the font color is not default
1920 if (isfontcolor == true) {
1921 // only require color here, the font color will be defined
1922 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1924 features.require("color");
1925 features.require("fontcolor");
1928 // Only if class has a ToC hierarchy
1929 if (tclass.hasTocLevels()) {
1930 if (secnumdepth != tclass.secnumdepth()) {
1931 os << "\\setcounter{secnumdepth}{"
1935 if (tocdepth != tclass.tocdepth()) {
1936 os << "\\setcounter{tocdepth}{"
1942 if (paragraph_separation) {
1943 // when skip separation
1944 switch (getDefSkip().kind()) {
1945 case VSpace::SMALLSKIP:
1946 os << "\\setlength{\\parskip}{\\smallskipamount}\n";
1948 case VSpace::MEDSKIP:
1949 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1951 case VSpace::BIGSKIP:
1952 os << "\\setlength{\\parskip}{\\bigskipamount}\n";
1954 case VSpace::LENGTH:
1955 os << "\\setlength{\\parskip}{"
1956 << from_utf8(getDefSkip().length().asLatexString())
1959 default: // should never happen // Then delete it.
1960 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1963 os << "\\setlength{\\parindent}{0pt}\n";
1965 // when separation by indentation
1966 // only output something when a width is given
1967 if (!getParIndent().empty()) {
1968 os << "\\setlength{\\parindent}{"
1969 << from_utf8(getParIndent().asLatexString())
1974 if (is_math_indent) {
1975 // when formula indentation
1976 // only output something when it is not the default
1977 if (!getMathIndent().empty()) {
1978 os << "\\setlength{\\mathindent}{"
1979 << from_utf8(getMathIndent().asString())
1984 // Now insert the LyX specific LaTeX commands...
1985 features.resolveAlternatives();
1986 features.expandMultiples();
1989 if (!output_sync_macro.empty())
1990 os << from_utf8(output_sync_macro) +"\n";
1991 else if (features.runparams().flavor == OutputParams::LATEX)
1992 os << "\\usepackage[active]{srcltx}\n";
1993 else if (features.runparams().flavor == OutputParams::PDFLATEX)
1994 os << "\\synctex=-1\n";
1997 // The package options (via \PassOptionsToPackage)
1998 os << from_ascii(features.getPackageOptions());
2000 // due to interferences with babel and hyperref, the color package has to
2001 // be loaded (when it is not already loaded) before babel when hyperref
2002 // is used with the colorlinks option, see
2003 // http://www.lyx.org/trac/ticket/5291
2004 // we decided therefore to load color always before babel, see
2005 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
2006 os << from_ascii(features.getColorOptions());
2008 // If we use hyperref, jurabib, japanese, varioref or vietnamese,
2009 // we have to call babel before
2011 && (features.isRequired("jurabib")
2012 || features.isRequired("hyperref")
2013 || features.isRequired("varioref")
2014 || features.isRequired("vietnamese")
2015 || features.isRequired("japanese"))) {
2016 os << features.getBabelPresettings();
2018 os << from_utf8(babelCall(language_options.str(),
2019 features.needBabelLangOptions())) + '\n';
2020 os << features.getBabelPostsettings();
2023 // The optional packages;
2024 os << from_ascii(features.getPackages());
2026 // Additional Indices
2027 if (features.isRequired("splitidx")) {
2028 IndicesList::const_iterator iit = indiceslist().begin();
2029 IndicesList::const_iterator iend = indiceslist().end();
2030 for (; iit != iend; ++iit) {
2031 os << "\\newindex{";
2032 os << escape(iit->shortcut());
2038 os << from_utf8(spacing().writePreamble(features.isProvided("SetSpace")));
2041 // * Hyperref manual: "Make sure it comes last of your loaded
2042 // packages, to give it a fighting chance of not being over-written,
2043 // since its job is to redefine many LaTeX commands."
2044 // * Email from Heiko Oberdiek: "It is usually better to load babel
2045 // before hyperref. Then hyperref has a chance to detect babel.
2046 // * Has to be loaded before the "LyX specific LaTeX commands" to
2047 // avoid errors with algorithm floats.
2048 // use hyperref explicitly if it is required
2049 if (features.isRequired("hyperref")) {
2050 OutputParams tmp_params = features.runparams();
2051 pdfoptions().writeLaTeX(tmp_params, os,
2052 features.isProvided("hyperref"));
2053 // correctly break URLs with hyperref and dvi output
2054 if (features.runparams().flavor == OutputParams::LATEX
2055 && features.isAvailable("breakurl"))
2056 os << "\\usepackage{breakurl}\n";
2057 } else if (features.isRequired("nameref"))
2058 // hyperref loads this automatically
2059 os << "\\usepackage{nameref}\n";
2061 // bibtopic needs to be loaded after hyperref.
2062 // the dot provides the aux file naming which LyX can detect.
2063 if (features.mustProvide("bibtopic"))
2064 os << "\\usepackage[dot]{bibtopic}\n";
2066 // Will be surrounded by \makeatletter and \makeatother when not empty
2067 otexstringstream atlyxpreamble;
2069 // Some macros LyX will need
2071 TexString tmppreamble = features.getMacros();
2072 if (!tmppreamble.str.empty())
2073 atlyxpreamble << "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2074 "LyX specific LaTeX commands.\n"
2075 << move(tmppreamble)
2078 // the text class specific preamble
2080 docstring tmppreamble = features.getTClassPreamble();
2081 if (!tmppreamble.empty())
2082 atlyxpreamble << "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2083 "Textclass specific LaTeX commands.\n"
2087 // suppress date if selected
2088 // use \@ifundefined because we cannot be sure that every document class
2089 // has a \date command
2091 atlyxpreamble << "\\@ifundefined{date}{}{\\date{}}\n";
2093 /* the user-defined preamble */
2094 if (!containsOnly(preamble, " \n\t")) {
2096 atlyxpreamble << "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2097 "User specified LaTeX commands.\n";
2099 // Check if the user preamble contains uncodable glyphs
2100 odocstringstream user_preamble;
2101 docstring uncodable_glyphs;
2102 Encoding const * const enc = features.runparams().encoding;
2104 for (size_t n = 0; n < preamble.size(); ++n) {
2105 char_type c = preamble[n];
2106 if (!enc->encodable(c)) {
2107 docstring const glyph(1, c);
2108 LYXERR0("Uncodable character '"
2110 << "' in user preamble!");
2111 uncodable_glyphs += glyph;
2112 if (features.runparams().dryrun) {
2113 user_preamble << "<" << _("LyX Warning: ")
2114 << _("uncodable character") << " '";
2115 user_preamble.put(c);
2116 user_preamble << "'>";
2119 user_preamble.put(c);
2122 user_preamble << preamble;
2124 // On BUFFER_VIEW|UPDATE, warn user if we found uncodable glyphs
2125 if (!features.runparams().dryrun && !uncodable_glyphs.empty()) {
2126 frontend::Alert::warning(
2127 _("Uncodable character in user preamble"),
2129 _("The user preamble of your document contains glyphs "
2130 "that are unknown in the current document encoding "
2131 "(namely %1$s).\nThese glyphs are omitted "
2132 " from the output, which may result in "
2133 "incomplete output."
2134 "\n\nPlease select an appropriate "
2135 "document encoding\n"
2136 "(such as utf8) or change the "
2137 "preamble code accordingly."),
2140 atlyxpreamble << user_preamble.str() << '\n';
2143 // footmisc must be loaded after setspace
2144 // Load it here to avoid clashes with footmisc loaded in the user
2145 // preamble. For that reason we also pass the options via
2146 // \PassOptionsToPackage in getPreamble() and not here.
2147 if (features.mustProvide("footmisc"))
2148 atlyxpreamble << "\\usepackage{footmisc}\n";
2150 // subfig loads internally the LaTeX package "caption". As
2151 // caption is a very popular package, users will load it in
2152 // the preamble. Therefore we must load subfig behind the
2153 // user-defined preamble and check if the caption package was
2154 // loaded or not. For the case that caption is loaded before
2155 // subfig, there is the subfig option "caption=false". This
2156 // option also works when a koma-script class is used and
2157 // koma's own caption commands are used instead of caption. We
2158 // use \PassOptionsToPackage here because the user could have
2159 // already loaded subfig in the preamble.
2160 if (features.mustProvide("subfig"))
2161 atlyxpreamble << "\\@ifundefined{showcaptionsetup}{}{%\n"
2162 " \\PassOptionsToPackage{caption=false}{subfig}}\n"
2163 "\\usepackage{subfig}\n";
2165 // Itemize bullet settings need to be last in case the user
2166 // defines their own bullets that use a package included
2167 // in the user-defined preamble -- ARRae
2168 // Actually it has to be done much later than that
2169 // since some packages like frenchb make modifications
2170 // at \begin{document} time -- JMarc
2171 docstring bullets_def;
2172 for (int i = 0; i < 4; ++i) {
2173 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
2174 if (bullets_def.empty())
2175 bullets_def += "\\AtBeginDocument{\n";
2176 bullets_def += " \\def\\labelitemi";
2178 // `i' is one less than the item to modify
2185 bullets_def += "ii";
2191 bullets_def += '{' +
2192 user_defined_bullet(i).getText()
2197 if (!bullets_def.empty())
2198 atlyxpreamble << bullets_def << "}\n\n";
2200 if (!atlyxpreamble.empty())
2201 os << "\n\\makeatletter\n"
2202 << atlyxpreamble.release()
2203 << "\\makeatother\n\n";
2205 // We try to load babel late, in case it interferes with other packages.
2206 // Jurabib, hyperref, varioref, bicaption and listings (bug 8995) have to be
2207 // called after babel, though.
2208 if (use_babel && !features.isRequired("jurabib")
2209 && !features.isRequired("hyperref")
2210 && !features.isRequired("varioref")
2211 && !features.isRequired("vietnamese")
2212 && !features.isRequired("japanese")) {
2213 os << features.getBabelPresettings();
2215 os << from_utf8(babelCall(language_options.str(),
2216 features.needBabelLangOptions())) + '\n';
2217 os << features.getBabelPostsettings();
2219 if (features.isRequired("bicaption"))
2220 os << "\\usepackage{bicaption}\n";
2221 if (!listings_params.empty() || features.mustProvide("listings"))
2222 os << "\\usepackage{listings}\n";
2223 if (!listings_params.empty()) {
2225 // do not test validity because listings_params is
2226 // supposed to be valid
2228 InsetListingsParams(listings_params).separatedParams(true);
2229 os << from_utf8(par);
2233 // xunicode only needs to be loaded if tipa is used
2234 // (the rest is obsoleted by the new TU encoding).
2235 // It needs to be loaded at least after amsmath, amssymb,
2236 // esint and the other packages that provide special glyphs
2237 if (features.mustProvide("tipa") && useNonTeXFonts) {
2238 // The package officially only supports XeTeX, but also works
2239 // with LuaTeX. Thus we work around its XeTeX test.
2240 if (features.runparams().flavor != OutputParams::XETEX) {
2241 os << "% Pretend to xunicode that we are XeTeX\n"
2242 << "\\def\\XeTeXpicfile{}\n";
2244 os << "\\usepackage{xunicode}\n";
2247 // Polyglossia must be loaded last ...
2248 if (use_polyglossia) {
2250 os << "\\usepackage{polyglossia}\n";
2251 // set the main language
2252 os << "\\setdefaultlanguage";
2253 if (!language->polyglossiaOpts().empty())
2254 os << "[" << from_ascii(language->polyglossiaOpts()) << "]";
2255 os << "{" << from_ascii(language->polyglossia()) << "}\n";
2256 // now setup the other languages
2257 set<string> const polylangs =
2258 features.getPolyglossiaLanguages();
2259 for (set<string>::const_iterator mit = polylangs.begin();
2260 mit != polylangs.end() ; ++mit) {
2261 // We do not output the options here; they are output in
2262 // the language switch commands. This is safer if multiple
2263 // varieties are used.
2264 if (*mit == language->polyglossia())
2266 os << "\\setotherlanguage";
2267 os << "{" << from_ascii(*mit) << "}\n";
2271 // ... but before biblatex (see #7065)
2272 if (features.mustProvide("biblatex")) {
2275 os << "\\usepackage";
2276 if (!biblatex_bibstyle.empty()
2277 && (biblatex_bibstyle == biblatex_citestyle)) {
2278 opts = "style=" + biblatex_bibstyle;
2281 if (!biblatex_bibstyle.empty()) {
2282 opts = "bibstyle=" + biblatex_bibstyle;
2285 if (!biblatex_citestyle.empty()) {
2286 opts += delim + "citestyle=" + biblatex_citestyle;
2290 if (!multibib.empty() && multibib != "child") {
2291 opts += delim + "refsection=" + multibib;
2294 if (bibtexCommand() == "bibtex8"
2295 || prefixIs(bibtexCommand(), "bibtex8 ")) {
2296 opts += delim + "backend=bibtex8";
2298 } else if (bibtexCommand() == "bibtex"
2299 || prefixIs(bibtexCommand(), "bibtex ")) {
2300 opts += delim + "backend=bibtex";
2303 if (!biblio_opts.empty())
2304 opts += delim + biblio_opts;
2306 os << "[" << opts << "]";
2307 os << "{biblatex}\n";
2311 // Load custom language package here
2312 if (features.langPackage() == LaTeXFeatures::LANG_PACK_CUSTOM) {
2313 if (lang_package == "default")
2314 os << from_utf8(lyxrc.language_custom_package);
2316 os << from_utf8(lang_package);
2320 docstring const i18npreamble =
2321 features.getTClassI18nPreamble(use_babel, use_polyglossia);
2322 if (!i18npreamble.empty())
2323 os << i18npreamble + '\n';
2329 void BufferParams::useClassDefaults()
2331 DocumentClass const & tclass = documentClass();
2333 sides = tclass.sides();
2334 columns = tclass.columns();
2335 pagestyle = tclass.pagestyle();
2336 use_default_options = true;
2337 // Only if class has a ToC hierarchy
2338 if (tclass.hasTocLevels()) {
2339 secnumdepth = tclass.secnumdepth();
2340 tocdepth = tclass.tocdepth();
2345 bool BufferParams::hasClassDefaults() const
2347 DocumentClass const & tclass = documentClass();
2349 return sides == tclass.sides()
2350 && columns == tclass.columns()
2351 && pagestyle == tclass.pagestyle()
2352 && use_default_options
2353 && secnumdepth == tclass.secnumdepth()
2354 && tocdepth == tclass.tocdepth();
2358 DocumentClass const & BufferParams::documentClass() const
2364 DocumentClassConstPtr BufferParams::documentClassPtr() const
2370 void BufferParams::setDocumentClass(DocumentClassConstPtr tc)
2372 // evil, but this function is evil
2373 doc_class_ = const_pointer_cast<DocumentClass>(tc);
2374 invalidateConverterCache();
2378 bool BufferParams::setBaseClass(string const & classname)
2380 LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
2381 LayoutFileList & bcl = LayoutFileList::get();
2382 if (!bcl.haveClass(classname)) {
2384 bformat(_("The layout file:\n"
2386 "could not be found. A default textclass with default\n"
2387 "layouts will be used. LyX will not be able to produce\n"
2389 from_utf8(classname));
2390 frontend::Alert::error(_("Document class not found"), s);
2391 bcl.addEmptyClass(classname);
2394 bool const success = bcl[classname].load();
2397 bformat(_("Due to some error in it, the layout file:\n"
2399 "could not be loaded. A default textclass with default\n"
2400 "layouts will be used. LyX will not be able to produce\n"
2402 from_utf8(classname));
2403 frontend::Alert::error(_("Could not load class"), s);
2404 bcl.addEmptyClass(classname);
2407 pimpl_->baseClass_ = classname;
2408 layout_modules_.adaptToBaseClass(baseClass(), removed_modules_);
2413 LayoutFile const * BufferParams::baseClass() const
2415 if (LayoutFileList::get().haveClass(pimpl_->baseClass_))
2416 return &(LayoutFileList::get()[pimpl_->baseClass_]);
2422 LayoutFileIndex const & BufferParams::baseClassID() const
2424 return pimpl_->baseClass_;
2428 void BufferParams::makeDocumentClass(bool const clone)
2433 invalidateConverterCache();
2434 LayoutModuleList mods;
2435 LayoutModuleList ces;
2436 LayoutModuleList::iterator it = layout_modules_.begin();
2437 LayoutModuleList::iterator en = layout_modules_.end();
2438 for (; it != en; ++it)
2439 mods.push_back(*it);
2441 it = cite_engine_.begin();
2442 en = cite_engine_.end();
2443 for (; it != en; ++it)
2446 doc_class_ = getDocumentClass(*baseClass(), mods, ces, clone);
2448 TextClass::ReturnValues success = TextClass::OK;
2449 if (!forced_local_layout_.empty())
2450 success = doc_class_->read(to_utf8(forced_local_layout_),
2452 if (!local_layout_.empty() &&
2453 (success == TextClass::OK || success == TextClass::OK_OLDFORMAT))
2454 success = doc_class_->read(to_utf8(local_layout_), TextClass::MODULE);
2455 if (success != TextClass::OK && success != TextClass::OK_OLDFORMAT) {
2456 docstring const msg = _("Error reading internal layout information");
2457 frontend::Alert::warning(_("Read Error"), msg);
2462 bool BufferParams::layoutModuleCanBeAdded(string const & modName) const
2464 return layout_modules_.moduleCanBeAdded(modName, baseClass());
2468 bool BufferParams::citationModuleCanBeAdded(string const & modName) const
2470 return cite_engine_.moduleCanBeAdded(modName, baseClass());
2474 docstring BufferParams::getLocalLayout(bool forced) const
2477 return from_utf8(doc_class_->forcedLayouts());
2479 return local_layout_;
2483 void BufferParams::setLocalLayout(docstring const & layout, bool forced)
2486 forced_local_layout_ = layout;
2488 local_layout_ = layout;
2492 bool BufferParams::addLayoutModule(string const & modName)
2494 LayoutModuleList::const_iterator it = layout_modules_.begin();
2495 LayoutModuleList::const_iterator end = layout_modules_.end();
2496 for (; it != end; ++it)
2499 layout_modules_.push_back(modName);
2504 string BufferParams::bufferFormat() const
2506 return documentClass().outputFormat();
2510 bool BufferParams::isExportable(string const & format, bool need_viewable) const
2512 FormatList const & formats = exportableFormats(need_viewable);
2513 FormatList::const_iterator fit = formats.begin();
2514 FormatList::const_iterator end = formats.end();
2515 for (; fit != end ; ++fit) {
2516 if ((*fit)->name() == format)
2523 FormatList const & BufferParams::exportableFormats(bool only_viewable) const
2525 FormatList & cached = only_viewable ?
2526 pimpl_->viewableFormatList : pimpl_->exportableFormatList;
2527 bool & valid = only_viewable ?
2528 pimpl_->isViewCacheValid : pimpl_->isExportCacheValid;
2532 vector<string> const backs = backends();
2533 set<string> excludes;
2534 if (useNonTeXFonts) {
2535 excludes.insert("latex");
2536 excludes.insert("pdflatex");
2539 theConverters().getReachable(backs[0], only_viewable, true, excludes);
2540 for (vector<string>::const_iterator it = backs.begin() + 1;
2541 it != backs.end(); ++it) {
2542 FormatList r = theConverters().getReachable(*it, only_viewable,
2544 result.insert(result.end(), r.begin(), r.end());
2546 sort(result.begin(), result.end(), Format::formatSorter);
2553 vector<string> BufferParams::backends() const
2556 string const buffmt = bufferFormat();
2558 // FIXME: Don't hardcode format names here, but use a flag
2559 if (buffmt == "latex") {
2560 if (encoding().package() == Encoding::japanese)
2561 v.push_back("platex");
2563 if (!useNonTeXFonts) {
2564 v.push_back("pdflatex");
2565 v.push_back("latex");
2567 v.push_back("xetex");
2568 v.push_back("luatex");
2569 v.push_back("dviluatex");
2572 v.push_back(buffmt);
2574 v.push_back("xhtml");
2575 v.push_back("text");
2581 OutputParams::FLAVOR BufferParams::getOutputFlavor(string const & format) const
2583 string const dformat = (format.empty() || format == "default") ?
2584 getDefaultOutputFormat() : format;
2585 DefaultFlavorCache::const_iterator it =
2586 default_flavors_.find(dformat);
2588 if (it != default_flavors_.end())
2591 OutputParams::FLAVOR result = OutputParams::LATEX;
2593 // FIXME It'd be better not to hardcode this, but to do
2594 // something with formats.
2595 if (dformat == "xhtml")
2596 result = OutputParams::HTML;
2597 else if (dformat == "text")
2598 result = OutputParams::TEXT;
2599 else if (dformat == "lyx")
2600 result = OutputParams::LYX;
2601 else if (dformat == "pdflatex")
2602 result = OutputParams::PDFLATEX;
2603 else if (dformat == "xetex")
2604 result = OutputParams::XETEX;
2605 else if (dformat == "luatex")
2606 result = OutputParams::LUATEX;
2607 else if (dformat == "dviluatex")
2608 result = OutputParams::DVILUATEX;
2610 // Try to determine flavor of default output format
2611 vector<string> backs = backends();
2612 if (find(backs.begin(), backs.end(), dformat) == backs.end()) {
2613 // Get shortest path to format
2614 Graph::EdgePath path;
2615 for (vector<string>::const_iterator it = backs.begin();
2616 it != backs.end(); ++it) {
2617 Graph::EdgePath p = theConverters().getPath(*it, dformat);
2618 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2623 result = theConverters().getFlavor(path);
2626 // cache this flavor
2627 default_flavors_[dformat] = result;
2632 string BufferParams::getDefaultOutputFormat() const
2634 if (!default_output_format.empty()
2635 && default_output_format != "default")
2636 return default_output_format;
2638 || encoding().package() == Encoding::japanese) {
2639 FormatList const & formats = exportableFormats(true);
2640 if (formats.empty())
2642 // return the first we find
2643 return formats.front()->name();
2646 return lyxrc.default_otf_view_format;
2647 return lyxrc.default_view_format;
2650 Font const BufferParams::getFont() const
2652 FontInfo f = documentClass().defaultfont();
2653 if (fonts_default_family == "rmdefault")
2654 f.setFamily(ROMAN_FAMILY);
2655 else if (fonts_default_family == "sfdefault")
2656 f.setFamily(SANS_FAMILY);
2657 else if (fonts_default_family == "ttdefault")
2658 f.setFamily(TYPEWRITER_FAMILY);
2659 return Font(f, language);
2663 InsetQuotesParams::QuoteStyle BufferParams::getQuoteStyle(string const & qs) const
2665 return quotesstyletranslator().find(qs);
2669 bool BufferParams::isLatex() const
2671 return documentClass().outputType() == LATEX;
2675 bool BufferParams::isLiterate() const
2677 return documentClass().outputType() == LITERATE;
2681 bool BufferParams::isDocBook() const
2683 return documentClass().outputType() == DOCBOOK;
2687 void BufferParams::readPreamble(Lexer & lex)
2689 if (lex.getString() != "\\begin_preamble")
2690 lyxerr << "Error (BufferParams::readPreamble):"
2691 "consistency check failed." << endl;
2693 preamble = lex.getLongString(from_ascii("\\end_preamble"));
2697 void BufferParams::readLocalLayout(Lexer & lex, bool forced)
2699 string const expected = forced ? "\\begin_forced_local_layout" :
2700 "\\begin_local_layout";
2701 if (lex.getString() != expected)
2702 lyxerr << "Error (BufferParams::readLocalLayout):"
2703 "consistency check failed." << endl;
2706 forced_local_layout_ =
2707 lex.getLongString(from_ascii("\\end_forced_local_layout"));
2709 local_layout_ = lex.getLongString(from_ascii("\\end_local_layout"));
2713 bool BufferParams::setLanguage(string const & lang)
2715 Language const *new_language = languages.getLanguage(lang);
2716 if (!new_language) {
2717 // Language lang was not found
2720 language = new_language;
2725 void BufferParams::readLanguage(Lexer & lex)
2727 if (!lex.next()) return;
2729 string const tmptok = lex.getString();
2731 // check if tmptok is part of tex_babel in tex-defs.h
2732 if (!setLanguage(tmptok)) {
2733 // Language tmptok was not found
2734 language = default_language;
2735 lyxerr << "Warning: Setting language `"
2736 << tmptok << "' to `" << language->lang()
2742 void BufferParams::readGraphicsDriver(Lexer & lex)
2747 string const tmptok = lex.getString();
2748 // check if tmptok is part of tex_graphics in tex_defs.h
2751 string const test = tex_graphics[n++];
2753 if (test == tmptok) {
2754 graphics_driver = tmptok;
2759 "Warning: graphics driver `$$Token' not recognized!\n"
2760 " Setting graphics driver to `default'.\n");
2761 graphics_driver = "default";
2768 void BufferParams::readBullets(Lexer & lex)
2773 int const index = lex.getInteger();
2775 int temp_int = lex.getInteger();
2776 user_defined_bullet(index).setFont(temp_int);
2777 temp_bullet(index).setFont(temp_int);
2779 user_defined_bullet(index).setCharacter(temp_int);
2780 temp_bullet(index).setCharacter(temp_int);
2782 user_defined_bullet(index).setSize(temp_int);
2783 temp_bullet(index).setSize(temp_int);
2787 void BufferParams::readBulletsLaTeX(Lexer & lex)
2789 // The bullet class should be able to read this.
2792 int const index = lex.getInteger();
2794 docstring const temp_str = lex.getDocString();
2796 user_defined_bullet(index).setText(temp_str);
2797 temp_bullet(index).setText(temp_str);
2801 void BufferParams::readModules(Lexer & lex)
2803 if (!lex.eatLine()) {
2804 lyxerr << "Error (BufferParams::readModules):"
2805 "Unexpected end of input." << endl;
2809 string mod = lex.getString();
2810 if (mod == "\\end_modules")
2812 addLayoutModule(mod);
2818 void BufferParams::readRemovedModules(Lexer & lex)
2820 if (!lex.eatLine()) {
2821 lyxerr << "Error (BufferParams::readRemovedModules):"
2822 "Unexpected end of input." << endl;
2826 string mod = lex.getString();
2827 if (mod == "\\end_removed_modules")
2829 removed_modules_.push_back(mod);
2832 // now we want to remove any removed modules that were previously
2833 // added. normally, that will be because default modules were added in
2834 // setBaseClass(), which gets called when \textclass is read at the
2835 // start of the read.
2836 list<string>::const_iterator rit = removed_modules_.begin();
2837 list<string>::const_iterator const ren = removed_modules_.end();
2838 for (; rit != ren; ++rit) {
2839 LayoutModuleList::iterator const mit = layout_modules_.begin();
2840 LayoutModuleList::iterator const men = layout_modules_.end();
2841 LayoutModuleList::iterator found = find(mit, men, *rit);
2844 layout_modules_.erase(found);
2849 void BufferParams::readIncludeonly(Lexer & lex)
2851 if (!lex.eatLine()) {
2852 lyxerr << "Error (BufferParams::readIncludeonly):"
2853 "Unexpected end of input." << endl;
2857 string child = lex.getString();
2858 if (child == "\\end_includeonly")
2860 included_children_.push_back(child);
2866 string BufferParams::paperSizeName(PapersizePurpose purpose) const
2868 switch (papersize) {
2870 // could be anything, so don't guess
2872 case PAPER_CUSTOM: {
2873 if (purpose == XDVI && !paperwidth.empty() &&
2874 !paperheight.empty()) {
2875 // heightxwidth<unit>
2876 string first = paperwidth;
2877 string second = paperheight;
2878 if (orientation == ORIENTATION_LANDSCAPE)
2881 return first.erase(first.length() - 2)
2887 // dvips and dvipdfm do not know this
2888 if (purpose == DVIPS || purpose == DVIPDFM)
2892 if (purpose == DVIPS || purpose == DVIPDFM)
2896 if (purpose == DVIPS || purpose == DVIPDFM)
2906 if (purpose == DVIPS || purpose == DVIPDFM)
2910 if (purpose == DVIPS || purpose == DVIPDFM)
2914 if (purpose == DVIPS || purpose == DVIPDFM)
2918 if (purpose == DVIPS || purpose == DVIPDFM)
2922 if (purpose == DVIPS || purpose == DVIPDFM)
2926 // dvipdfm does not know this
2927 if (purpose == DVIPDFM)
2931 if (purpose == DVIPDFM)
2935 if (purpose == DVIPS || purpose == DVIPDFM)
2939 if (purpose == DVIPS || purpose == DVIPDFM)
2943 if (purpose == DVIPS || purpose == DVIPDFM)
2947 if (purpose == DVIPS || purpose == DVIPDFM)
2951 if (purpose == DVIPS || purpose == DVIPDFM)
2955 if (purpose == DVIPS || purpose == DVIPDFM)
2959 if (purpose == DVIPS || purpose == DVIPDFM)
2963 if (purpose == DVIPS || purpose == DVIPDFM)
2967 if (purpose == DVIPS || purpose == DVIPDFM)
2971 if (purpose == DVIPS || purpose == DVIPDFM)
2975 if (purpose == DVIPS || purpose == DVIPDFM)
2979 if (purpose == DVIPS || purpose == DVIPDFM)
2983 if (purpose == DVIPS || purpose == DVIPDFM)
2987 if (purpose == DVIPS || purpose == DVIPDFM)
2991 if (purpose == DVIPS || purpose == DVIPDFM)
2994 case PAPER_USEXECUTIVE:
2995 // dvipdfm does not know this
2996 if (purpose == DVIPDFM)
3001 case PAPER_USLETTER:
3003 if (purpose == XDVI)
3010 string const BufferParams::dvips_options() const
3014 // If the class loads the geometry package, we do not know which
3015 // paper size is used, since we do not set it (bug 7013).
3016 // Therefore we must not specify any argument here.
3017 // dvips gets the correct paper size via DVI specials in this case
3018 // (if the class uses the geometry package correctly).
3019 if (documentClass().provides("geometry"))
3023 && papersize == PAPER_CUSTOM
3024 && !lyxrc.print_paper_dimension_flag.empty()
3025 && !paperwidth.empty()
3026 && !paperheight.empty()) {
3027 // using a custom papersize
3028 result = lyxrc.print_paper_dimension_flag;
3029 result += ' ' + paperwidth;
3030 result += ',' + paperheight;
3032 string const paper_option = paperSizeName(DVIPS);
3033 if (!paper_option.empty() && (paper_option != "letter" ||
3034 orientation != ORIENTATION_LANDSCAPE)) {
3035 // dvips won't accept -t letter -t landscape.
3036 // In all other cases, include the paper size
3038 result = lyxrc.print_paper_flag;
3039 result += ' ' + paper_option;
3042 if (orientation == ORIENTATION_LANDSCAPE &&
3043 papersize != PAPER_CUSTOM)
3044 result += ' ' + lyxrc.print_landscape_flag;
3049 string const BufferParams::main_font_encoding() const
3051 return font_encodings().empty() ? "default" : font_encodings().back();
3055 vector<string> const BufferParams::font_encodings() const
3057 string doc_fontenc = (fontenc == "global") ? lyxrc.fontenc : fontenc;
3059 vector<string> fontencs;
3061 // "default" means "no explicit font encoding"
3062 if (doc_fontenc != "default") {
3063 fontencs = getVectorFromString(doc_fontenc);
3064 if (!language->fontenc().empty()
3065 && ascii_lowercase(language->fontenc()) != "none") {
3066 vector<string> fencs = getVectorFromString(language->fontenc());
3067 vector<string>::const_iterator fit = fencs.begin();
3068 for (; fit != fencs.end(); ++fit) {
3069 if (find(fontencs.begin(), fontencs.end(), *fit) == fontencs.end())
3070 fontencs.push_back(*fit);
3079 string BufferParams::babelCall(string const & lang_opts, bool const langoptions) const
3081 // suppress the babel call if there is no BabelName defined
3082 // for the document language in the lib/languages file and if no
3083 // other languages are used (lang_opts is then empty)
3084 if (lang_opts.empty())
3086 // either a specific language (AsBabelOptions setting in
3087 // lib/languages) or the prefs require the languages to
3088 // be submitted to babel itself (not the class).
3090 return "\\usepackage[" + lang_opts + "]{babel}";
3091 return "\\usepackage{babel}";
3095 docstring BufferParams::getGraphicsDriver(string const & package) const
3099 if (package == "geometry") {
3100 if (graphics_driver == "dvips"
3101 || graphics_driver == "dvipdfm"
3102 || graphics_driver == "pdftex"
3103 || graphics_driver == "vtex")
3104 result = from_ascii(graphics_driver);
3105 else if (graphics_driver == "dvipdfmx")
3106 result = from_ascii("dvipdfm");
3113 void BufferParams::writeEncodingPreamble(otexstream & os,
3114 LaTeXFeatures & features) const
3116 // XeTeX/LuaTeX: (see also #9740)
3117 // With Unicode fonts we use utf8-plain without encoding package.
3118 // With TeX fonts, we cannot use utf8-plain, but "inputenc" fails.
3119 // XeTeX must use ASCII encoding (see Buffer.cpp),
3120 // for LuaTeX, we load "luainputenc" (see below).
3121 if (useNonTeXFonts || features.runparams().flavor == OutputParams::XETEX)
3124 if (inputenc == "auto") {
3125 string const doc_encoding =
3126 language->encoding()->latexName();
3127 Encoding::Package const package =
3128 language->encoding()->package();
3130 // Create list of inputenc options:
3131 set<string> encodings;
3132 // luainputenc fails with more than one encoding
3133 if (!features.runparams().isFullUnicode()) // if we reach this point, this means LuaTeX with TeX fonts
3134 // list all input encodings used in the document
3135 encodings = features.getEncodingSet(doc_encoding);
3137 // If the "japanese" package (i.e. pLaTeX) is used,
3138 // inputenc must be omitted.
3139 // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
3140 if ((!encodings.empty() || package == Encoding::inputenc)
3141 && !features.isRequired("japanese")
3142 && !features.isProvided("inputenc")) {
3143 os << "\\usepackage[";
3144 set<string>::const_iterator it = encodings.begin();
3145 set<string>::const_iterator const end = encodings.end();
3147 os << from_ascii(*it);
3150 for (; it != end; ++it)
3151 os << ',' << from_ascii(*it);
3152 if (package == Encoding::inputenc) {
3153 if (!encodings.empty())
3155 os << from_ascii(doc_encoding);
3157 if (features.runparams().flavor == OutputParams::LUATEX
3158 || features.runparams().flavor == OutputParams::DVILUATEX)
3159 os << "]{luainputenc}\n";
3161 os << "]{inputenc}\n";
3163 if (package == Encoding::CJK || features.mustProvide("CJK")) {
3164 if (language->encoding()->name() == "utf8-cjk"
3165 && LaTeXFeatures::isAvailable("CJKutf8"))
3166 os << "\\usepackage{CJKutf8}\n";
3168 os << "\\usepackage{CJK}\n";
3170 } else if (inputenc != "default") {
3171 switch (encoding().package()) {
3172 case Encoding::none:
3173 case Encoding::japanese:
3175 case Encoding::inputenc:
3176 // do not load inputenc if japanese is used
3177 // or if the class provides inputenc
3178 if (features.isRequired("japanese")
3179 || features.isProvided("inputenc"))
3181 os << "\\usepackage[" << from_ascii(encoding().latexName());
3182 if (features.runparams().flavor == OutputParams::LUATEX
3183 || features.runparams().flavor == OutputParams::DVILUATEX)
3184 os << "]{luainputenc}\n";
3186 os << "]{inputenc}\n";
3189 if (encoding().name() == "utf8-cjk"
3190 && LaTeXFeatures::isAvailable("CJKutf8"))
3191 os << "\\usepackage{CJKutf8}\n";
3193 os << "\\usepackage{CJK}\n";
3196 // Load the CJK package if needed by a secondary language.
3197 // If the main encoding is some variant of UTF8, use CJKutf8.
3198 if (encoding().package() != Encoding::CJK && features.mustProvide("CJK")) {
3199 if (encoding().iconvName() == "UTF-8"
3200 && LaTeXFeatures::isAvailable("CJKutf8"))
3201 os << "\\usepackage{CJKutf8}\n";
3203 os << "\\usepackage{CJK}\n";
3209 string const BufferParams::parseFontName(string const & name) const
3211 string mangled = name;
3212 size_t const idx = mangled.find('[');
3213 if (idx == string::npos || idx == 0)
3216 return mangled.substr(0, idx - 1);
3220 string const BufferParams::loadFonts(LaTeXFeatures & features) const
3222 if (fontsRoman() == "default" && fontsSans() == "default"
3223 && fontsTypewriter() == "default"
3224 && (fontsMath() == "default" || fontsMath() == "auto"))
3230 /* Fontspec (XeTeX, LuaTeX): we provide GUI support for oldstyle
3231 * numbers (Numbers=OldStyle) and sf/tt scaling. The Ligatures=TeX/
3232 * Mapping=tex-text option assures TeX ligatures (such as "--")
3233 * are resolved. Note that tt does not use these ligatures.
3235 * -- add more GUI options?
3236 * -- add more fonts (fonts for other scripts)
3237 * -- if there's a way to find out if a font really supports
3238 * OldStyle, enable/disable the widget accordingly.
3240 if (useNonTeXFonts && features.isAvailable("fontspec")) {
3241 // "Mapping=tex-text" and "Ligatures=TeX" are equivalent.
3242 // However, until v.2 (2010/07/11) fontspec only knew
3243 // Mapping=tex-text (for XeTeX only); then "Ligatures=TeX"
3244 // was introduced for both XeTeX and LuaTeX (LuaTeX
3245 // didn't understand "Mapping=tex-text", while XeTeX
3246 // understood both. With most recent versions, both
3247 // variants are understood by both engines. However,
3248 // we want to provide support for at least TeXLive 2009
3249 // (for XeTeX; LuaTeX is only supported as of v.2)
3250 string const texmapping =
3251 (features.runparams().flavor == OutputParams::XETEX) ?
3252 "Mapping=tex-text" : "Ligatures=TeX";
3253 if (fontsRoman() != "default") {
3254 os << "\\setmainfont[" << texmapping;
3255 if (fonts_old_figures)
3256 os << ",Numbers=OldStyle";
3257 os << "]{" << parseFontName(fontsRoman()) << "}\n";
3259 if (fontsSans() != "default") {
3260 string const sans = parseFontName(fontsSans());
3261 if (fontsSansScale() != 100)
3262 os << "\\setsansfont[Scale="
3263 << float(fontsSansScale()) / 100
3264 << "," << texmapping << "]{"
3267 os << "\\setsansfont[" << texmapping << "]{"
3270 if (fontsTypewriter() != "default") {
3271 string const mono = parseFontName(fontsTypewriter());
3272 if (fontsTypewriterScale() != 100)
3273 os << "\\setmonofont[Scale="
3274 << float(fontsTypewriterScale()) / 100
3278 os << "\\setmonofont{"
3285 bool const ot1 = (main_font_encoding() == "default" || main_font_encoding() == "OT1");
3286 bool const dryrun = features.runparams().dryrun;
3287 bool const complete = (fontsSans() == "default" && fontsTypewriter() == "default");
3288 bool const nomath = (fontsMath() == "default");
3291 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsRoman())).getLaTeXCode(
3292 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3296 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsSans())).getLaTeXCode(
3297 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3298 nomath, fontsSansScale());
3300 // MONOSPACED/TYPEWRITER
3301 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsTypewriter())).getLaTeXCode(
3302 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3303 nomath, fontsTypewriterScale());
3306 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsMath())).getLaTeXCode(
3307 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3314 Encoding const & BufferParams::encoding() const
3316 // Main encoding for LaTeX output.
3318 // Exception: XeTeX with 8-bit TeX fonts requires ASCII (see #9740).
3319 // As the "flavor" is only known once export started, this
3320 // cannot be handled here. Instead, runparams.encoding is set
3321 // to ASCII in Buffer::makeLaTeXFile (for export)
3322 // and Buffer::writeLaTeXSource (for preview).
3324 return *(encodings.fromLyXName("utf8-plain"));
3325 if (inputenc == "auto" || inputenc == "default")
3326 return *language->encoding();
3327 Encoding const * const enc = encodings.fromLyXName(inputenc);
3330 LYXERR0("Unknown inputenc value `" << inputenc
3331 << "'. Using `auto' instead.");
3332 return *language->encoding();
3336 bool BufferParams::addCiteEngine(string const & engine)
3338 LayoutModuleList::const_iterator it = cite_engine_.begin();
3339 LayoutModuleList::const_iterator en = cite_engine_.end();
3340 for (; it != en; ++it)
3343 cite_engine_.push_back(engine);
3348 bool BufferParams::addCiteEngine(vector<string> const & engine)
3350 vector<string>::const_iterator it = engine.begin();
3351 vector<string>::const_iterator en = engine.end();
3353 for (; it != en; ++it)
3354 if (!addCiteEngine(*it))
3360 string const & BufferParams::defaultBiblioStyle() const
3362 map<string, string> const & bs = documentClass().defaultBiblioStyle();
3363 auto cit = bs.find(theCiteEnginesList.getTypeAsString(citeEngineType()));
3364 if (cit != bs.end())
3367 return empty_string();
3371 bool const & BufferParams::fullAuthorList() const
3373 return documentClass().fullAuthorList();
3377 string BufferParams::getCiteAlias(string const & s) const
3379 vector<string> commands =
3380 documentClass().citeCommands(citeEngineType());
3381 // If it is a real command, don't treat it as an alias
3382 if (find(commands.begin(), commands.end(), s) != commands.end())
3384 map<string,string> aliases = documentClass().citeCommandAliases();
3385 if (aliases.find(s) != aliases.end())
3391 void BufferParams::setCiteEngine(string const & engine)
3394 addCiteEngine(engine);
3398 void BufferParams::setCiteEngine(vector<string> const & engine)
3401 addCiteEngine(engine);
3405 vector<string> BufferParams::citeCommands() const
3407 static CitationStyle const default_style;
3408 vector<string> commands =
3409 documentClass().citeCommands(citeEngineType());
3410 if (commands.empty())
3411 commands.push_back(default_style.name);
3416 vector<CitationStyle> BufferParams::citeStyles() const
3418 static CitationStyle const default_style;
3419 vector<CitationStyle> styles =
3420 documentClass().citeStyles(citeEngineType());
3422 styles.push_back(default_style);
3427 string const BufferParams::bibtexCommand() const
3429 // Return document-specific setting if available
3430 if (bibtex_command != "default")
3431 return bibtex_command;
3433 // If we have "default" in document settings, consult the prefs
3434 // 1. Japanese (uses a specific processor)
3435 if (encoding().package() == Encoding::japanese) {
3436 if (lyxrc.jbibtex_command != "automatic")
3437 // Return the specified program, if "automatic" is not set
3438 return lyxrc.jbibtex_command;
3439 else if (!useBiblatex()) {
3440 // With classic BibTeX, return pbibtex, jbibtex, bibtex
3441 if (lyxrc.jbibtex_alternatives.find("pbibtex") != lyxrc.jbibtex_alternatives.end())
3443 if (lyxrc.jbibtex_alternatives.find("jbibtex") != lyxrc.jbibtex_alternatives.end())
3448 // 2. All other languages
3449 else if (lyxrc.bibtex_command != "automatic")
3450 // Return the specified program, if "automatic" is not set
3451 return lyxrc.bibtex_command;
3453 // 3. Automatic: find the most suitable for the current cite framework
3454 if (useBiblatex()) {
3455 // For Biblatex, we prefer biber (also for Japanese)
3456 // and fall back to bibtex8 and, as last resort, bibtex
3457 if (lyxrc.bibtex_alternatives.find("biber") != lyxrc.bibtex_alternatives.end())
3459 else if (lyxrc.bibtex_alternatives.find("bibtex8") != lyxrc.bibtex_alternatives.end())
3466 bool BufferParams::useBiblatex() const
3468 return theCiteEnginesList[citeEngine().list().front()]
3469 ->getCiteFramework() == "biblatex";
3473 void BufferParams::invalidateConverterCache() const
3475 pimpl_->isExportCacheValid = false;
3476 pimpl_->isViewCacheValid = false;