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 = 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") {
861 else if (tmp == "false")
864 math_number = DEFAULT;
865 } else if (token == "\\quotes_style") {
868 quotes_style = quotesstyletranslator().find(qstyle);
869 } else if (token == "\\dynamic_quotes") {
870 lex >> dynamic_quotes;
871 } else if (token == "\\papersize") {
874 papersize = papersizetranslator().find(ppsize);
875 } else if (token == "\\use_geometry") {
877 } else if (token == "\\use_package") {
882 use_package(package, packagetranslator().find(use));
883 } else if (token == "\\cite_engine") {
885 vector<string> engine = getVectorFromString(lex.getString());
886 setCiteEngine(engine);
887 } else if (token == "\\cite_engine_type") {
890 cite_engine_type_ = theCiteEnginesList.getType(engine_type);
891 } else if (token == "\\biblio_style") {
893 biblio_style = lex.getString();
894 } else if (token == "\\biblio_options") {
896 biblio_opts = trim(lex.getString());
897 } else if (token == "\\biblatex_bibstyle") {
899 biblatex_bibstyle = trim(lex.getString());
900 } else if (token == "\\biblatex_citestyle") {
902 biblatex_citestyle = trim(lex.getString());
903 } else if (token == "\\use_bibtopic") {
905 } else if (token == "\\multibib") {
907 } else if (token == "\\use_indices") {
909 } else if (token == "\\tracking_changes") {
910 lex >> track_changes;
911 } else if (token == "\\output_changes") {
912 lex >> output_changes;
913 } else if (token == "\\branch") {
915 docstring branch = lex.getDocString();
916 branchlist().add(branch);
919 string const tok = lex.getString();
920 if (tok == "\\end_branch")
922 Branch * branch_ptr = branchlist().find(branch);
923 if (tok == "\\selected") {
926 branch_ptr->setSelected(lex.getInteger());
928 if (tok == "\\filename_suffix") {
931 branch_ptr->setFileNameSuffix(lex.getInteger());
933 if (tok == "\\color") {
935 string color = lex.getString();
937 branch_ptr->setColor(color);
938 // Update also the Color table:
940 color = lcolor.getX11Name(Color_background);
942 lcolor.setColor(to_utf8(branch), color);
945 } else if (token == "\\index") {
947 docstring index = lex.getDocString();
949 indiceslist().add(index);
952 string const tok = lex.getString();
953 if (tok == "\\end_index")
955 Index * index_ptr = indiceslist().find(index);
956 if (tok == "\\shortcut") {
958 shortcut = lex.getDocString();
960 index_ptr->setShortcut(shortcut);
962 if (tok == "\\color") {
964 string color = lex.getString();
966 index_ptr->setColor(color);
967 // Update also the Color table:
969 color = lcolor.getX11Name(Color_background);
971 if (!shortcut.empty())
972 lcolor.setColor(to_utf8(shortcut), color);
975 } else if (token == "\\author") {
977 istringstream ss(lex.getString());
981 } else if (token == "\\paperorientation") {
984 orientation = paperorientationtranslator().find(orient);
985 } else if (token == "\\backgroundcolor") {
987 backgroundcolor = lyx::rgbFromHexName(lex.getString());
988 isbackgroundcolor = true;
989 } else if (token == "\\fontcolor") {
991 fontcolor = lyx::rgbFromHexName(lex.getString());
993 } else if (token == "\\notefontcolor") {
995 string color = lex.getString();
996 notefontcolor = lyx::rgbFromHexName(color);
997 lcolor.setColor("notefontcolor", color);
998 } else if (token == "\\boxbgcolor") {
1000 string color = lex.getString();
1001 boxbgcolor = lyx::rgbFromHexName(color);
1002 lcolor.setColor("boxbgcolor", color);
1003 } else if (token == "\\paperwidth") {
1005 } else if (token == "\\paperheight") {
1007 } else if (token == "\\leftmargin") {
1009 } else if (token == "\\topmargin") {
1011 } else if (token == "\\rightmargin") {
1013 } else if (token == "\\bottommargin") {
1014 lex >> bottommargin;
1015 } else if (token == "\\headheight") {
1017 } else if (token == "\\headsep") {
1019 } else if (token == "\\footskip") {
1021 } else if (token == "\\columnsep") {
1023 } else if (token == "\\paperfontsize") {
1025 } else if (token == "\\papercolumns") {
1027 } else if (token == "\\listings_params") {
1030 listings_params = InsetListingsParams(par).params();
1031 } else if (token == "\\papersides") {
1034 sides = sidestranslator().find(psides);
1035 } else if (token == "\\paperpagestyle") {
1037 } else if (token == "\\bullet") {
1039 } else if (token == "\\bulletLaTeX") {
1040 readBulletsLaTeX(lex);
1041 } else if (token == "\\secnumdepth") {
1043 } else if (token == "\\tocdepth") {
1045 } else if (token == "\\spacing") {
1049 if (nspacing == "other") {
1052 spacing().set(spacetranslator().find(nspacing), tmp_val);
1053 } else if (token == "\\float_placement") {
1054 lex >> float_placement;
1056 } else if (prefixIs(token, "\\pdf_") || token == "\\use_hyperref") {
1057 string toktmp = pdfoptions().readToken(lex, token);
1058 if (!toktmp.empty()) {
1059 lyxerr << "PDFOptions::readToken(): Unknown token: " <<
1063 } else if (token == "\\html_math_output") {
1066 html_math_output = static_cast<MathOutput>(temp);
1067 } else if (token == "\\html_be_strict") {
1068 lex >> html_be_strict;
1069 } else if (token == "\\html_css_as_file") {
1070 lex >> html_css_as_file;
1071 } else if (token == "\\html_math_img_scale") {
1072 lex >> html_math_img_scale;
1073 } else if (token == "\\html_latex_start") {
1075 html_latex_start = lex.getString();
1076 } else if (token == "\\html_latex_end") {
1078 html_latex_end = lex.getString();
1079 } else if (token == "\\output_sync") {
1081 } else if (token == "\\output_sync_macro") {
1082 lex >> output_sync_macro;
1083 } else if (token == "\\use_refstyle") {
1084 lex >> use_refstyle;
1086 lyxerr << "BufferParams::readToken(): Unknown token: " <<
1096 // Quote argument if it contains spaces
1097 string quoteIfNeeded(string const & str) {
1098 if (contains(str, ' '))
1099 return "\"" + str + "\"";
1105 void BufferParams::writeFile(ostream & os, Buffer const * buf) const
1107 // The top of the file is written by the buffer.
1108 // Prints out the buffer info into the .lyx file given by file
1110 os << "\\save_transient_properties "
1111 << convert<string>(save_transient_properties) << '\n';
1113 // the document directory (must end with a path separator)
1114 // realPath() is used to resolve symlinks, while addPath(..., "")
1115 // ensures a trailing path separator.
1117 string filepath = addPath(buf->fileName().onlyPath().realPath(), "");
1118 string const sysdir = inSystemDir(FileName(filepath), docsys) ? docsys
1119 : addPath(package().system_support().realPath(), "");
1120 string const relpath =
1121 to_utf8(makeRelPath(from_utf8(filepath), from_utf8(sysdir)));
1122 if (!prefixIs(relpath, "../") && !FileName::isAbsolute(relpath))
1123 filepath = addPath("/systemlyxdir", relpath);
1124 else if (!save_transient_properties || !lyxrc.save_origin)
1125 filepath = "unavailable";
1126 os << "\\origin " << quoteIfNeeded(filepath) << '\n';
1129 os << "\\textclass "
1130 << quoteIfNeeded(buf->includedFilePath(addName(buf->layoutPos(),
1131 baseClass()->name()), "layout"))
1134 // then the preamble
1135 if (!preamble.empty()) {
1136 // remove '\n' from the end of preamble
1137 docstring const tmppreamble = rtrim(preamble, "\n");
1138 os << "\\begin_preamble\n"
1139 << to_utf8(tmppreamble)
1140 << "\n\\end_preamble\n";
1144 if (!options.empty()) {
1145 os << "\\options " << options << '\n';
1148 // use the class options defined in the layout?
1149 os << "\\use_default_options "
1150 << convert<string>(use_default_options) << "\n";
1152 // the master document
1153 if (!master.empty()) {
1154 os << "\\master " << master << '\n';
1158 if (!removed_modules_.empty()) {
1159 os << "\\begin_removed_modules" << '\n';
1160 list<string>::const_iterator it = removed_modules_.begin();
1161 list<string>::const_iterator en = removed_modules_.end();
1162 for (; it != en; ++it)
1164 os << "\\end_removed_modules" << '\n';
1168 if (!layout_modules_.empty()) {
1169 os << "\\begin_modules" << '\n';
1170 LayoutModuleList::const_iterator it = layout_modules_.begin();
1171 LayoutModuleList::const_iterator en = layout_modules_.end();
1172 for (; it != en; ++it)
1174 os << "\\end_modules" << '\n';
1178 if (!included_children_.empty()) {
1179 os << "\\begin_includeonly" << '\n';
1180 list<string>::const_iterator it = included_children_.begin();
1181 list<string>::const_iterator en = included_children_.end();
1182 for (; it != en; ++it)
1184 os << "\\end_includeonly" << '\n';
1186 os << "\\maintain_unincluded_children "
1187 << convert<string>(maintain_unincluded_children) << '\n';
1189 // local layout information
1190 docstring const local_layout = getLocalLayout(false);
1191 if (!local_layout.empty()) {
1192 // remove '\n' from the end
1193 docstring const tmplocal = rtrim(local_layout, "\n");
1194 os << "\\begin_local_layout\n"
1195 << to_utf8(tmplocal)
1196 << "\n\\end_local_layout\n";
1198 docstring const forced_local_layout = getLocalLayout(true);
1199 if (!forced_local_layout.empty()) {
1200 // remove '\n' from the end
1201 docstring const tmplocal = rtrim(forced_local_layout, "\n");
1202 os << "\\begin_forced_local_layout\n"
1203 << to_utf8(tmplocal)
1204 << "\n\\end_forced_local_layout\n";
1207 // then the text parameters
1208 if (language != ignore_language)
1209 os << "\\language " << language->lang() << '\n';
1210 os << "\\language_package " << lang_package
1211 << "\n\\inputencoding " << inputenc
1212 << "\n\\fontencoding " << fontenc
1213 << "\n\\font_roman \"" << fonts_roman[0]
1214 << "\" \"" << fonts_roman[1] << '"'
1215 << "\n\\font_sans \"" << fonts_sans[0]
1216 << "\" \"" << fonts_sans[1] << '"'
1217 << "\n\\font_typewriter \"" << fonts_typewriter[0]
1218 << "\" \"" << fonts_typewriter[1] << '"'
1219 << "\n\\font_math \"" << fonts_math[0]
1220 << "\" \"" << fonts_math[1] << '"'
1221 << "\n\\font_default_family " << fonts_default_family
1222 << "\n\\use_non_tex_fonts " << convert<string>(useNonTeXFonts)
1223 << "\n\\font_sc " << convert<string>(fonts_expert_sc)
1224 << "\n\\font_osf " << convert<string>(fonts_old_figures)
1225 << "\n\\font_sf_scale " << fonts_sans_scale[0]
1226 << ' ' << fonts_sans_scale[1]
1227 << "\n\\font_tt_scale " << fonts_typewriter_scale[0]
1228 << ' ' << fonts_typewriter_scale[1]
1230 if (!fonts_cjk.empty()) {
1231 os << "\\font_cjk " << fonts_cjk << '\n';
1233 os << "\\use_microtype " << convert<string>(use_microtype) << '\n';
1234 os << "\\use_dash_ligatures " << convert<string>(use_dash_ligatures) << '\n';
1235 os << "\\graphics " << graphics_driver << '\n';
1236 os << "\\default_output_format " << default_output_format << '\n';
1237 os << "\\output_sync " << output_sync << '\n';
1238 if (!output_sync_macro.empty())
1239 os << "\\output_sync_macro \"" << output_sync_macro << "\"\n";
1240 os << "\\bibtex_command " << bibtex_command << '\n';
1241 os << "\\index_command " << index_command << '\n';
1243 if (!float_placement.empty()) {
1244 os << "\\float_placement " << float_placement << '\n';
1246 os << "\\paperfontsize " << fontsize << '\n';
1248 spacing().writeFile(os);
1249 pdfoptions().writeFile(os);
1251 os << "\\papersize " << string_papersize[papersize]
1252 << "\n\\use_geometry " << convert<string>(use_geometry);
1253 map<string, string> const & packages = auto_packages();
1254 for (map<string, string>::const_iterator it = packages.begin();
1255 it != packages.end(); ++it)
1256 os << "\n\\use_package " << it->first << ' '
1257 << use_package(it->first);
1259 os << "\n\\cite_engine ";
1261 if (!cite_engine_.empty()) {
1262 LayoutModuleList::const_iterator be = cite_engine_.begin();
1263 LayoutModuleList::const_iterator en = cite_engine_.end();
1264 for (LayoutModuleList::const_iterator it = be; it != en; ++it) {
1273 os << "\n\\cite_engine_type " << theCiteEnginesList.getTypeAsString(cite_engine_type_);
1275 if (!biblio_style.empty())
1276 os << "\n\\biblio_style " << biblio_style;
1277 if (!biblio_opts.empty())
1278 os << "\n\\biblio_options " << biblio_opts;
1279 if (!biblatex_bibstyle.empty())
1280 os << "\n\\biblatex_bibstyle " << biblatex_bibstyle;
1281 if (!biblatex_citestyle.empty())
1282 os << "\n\\biblatex_citestyle " << biblatex_citestyle;
1283 if (!multibib.empty())
1284 os << "\n\\multibib " << multibib;
1286 os << "\n\\use_bibtopic " << convert<string>(use_bibtopic)
1287 << "\n\\use_indices " << convert<string>(use_indices)
1288 << "\n\\paperorientation " << string_orientation[orientation]
1289 << "\n\\suppress_date " << convert<string>(suppress_date)
1290 << "\n\\justification " << convert<string>(justification)
1291 << "\n\\use_refstyle " << use_refstyle
1293 if (isbackgroundcolor == true)
1294 os << "\\backgroundcolor " << lyx::X11hexname(backgroundcolor) << '\n';
1295 if (isfontcolor == true)
1296 os << "\\fontcolor " << lyx::X11hexname(fontcolor) << '\n';
1297 if (notefontcolor != lyx::rgbFromHexName("#cccccc"))
1298 os << "\\notefontcolor " << lyx::X11hexname(notefontcolor) << '\n';
1299 if (boxbgcolor != lyx::rgbFromHexName("#ff0000"))
1300 os << "\\boxbgcolor " << lyx::X11hexname(boxbgcolor) << '\n';
1302 BranchList::const_iterator it = branchlist().begin();
1303 BranchList::const_iterator end = branchlist().end();
1304 for (; it != end; ++it) {
1305 os << "\\branch " << to_utf8(it->branch())
1306 << "\n\\selected " << it->isSelected()
1307 << "\n\\filename_suffix " << it->hasFileNameSuffix()
1308 << "\n\\color " << lyx::X11hexname(it->color())
1313 IndicesList::const_iterator iit = indiceslist().begin();
1314 IndicesList::const_iterator iend = indiceslist().end();
1315 for (; iit != iend; ++iit) {
1316 os << "\\index " << to_utf8(iit->index())
1317 << "\n\\shortcut " << to_utf8(iit->shortcut())
1318 << "\n\\color " << lyx::X11hexname(iit->color())
1323 if (!paperwidth.empty())
1324 os << "\\paperwidth "
1325 << VSpace(paperwidth).asLyXCommand() << '\n';
1326 if (!paperheight.empty())
1327 os << "\\paperheight "
1328 << VSpace(paperheight).asLyXCommand() << '\n';
1329 if (!leftmargin.empty())
1330 os << "\\leftmargin "
1331 << VSpace(leftmargin).asLyXCommand() << '\n';
1332 if (!topmargin.empty())
1333 os << "\\topmargin "
1334 << VSpace(topmargin).asLyXCommand() << '\n';
1335 if (!rightmargin.empty())
1336 os << "\\rightmargin "
1337 << VSpace(rightmargin).asLyXCommand() << '\n';
1338 if (!bottommargin.empty())
1339 os << "\\bottommargin "
1340 << VSpace(bottommargin).asLyXCommand() << '\n';
1341 if (!headheight.empty())
1342 os << "\\headheight "
1343 << VSpace(headheight).asLyXCommand() << '\n';
1344 if (!headsep.empty())
1346 << VSpace(headsep).asLyXCommand() << '\n';
1347 if (!footskip.empty())
1349 << VSpace(footskip).asLyXCommand() << '\n';
1350 if (!columnsep.empty())
1351 os << "\\columnsep "
1352 << VSpace(columnsep).asLyXCommand() << '\n';
1353 os << "\\secnumdepth " << secnumdepth
1354 << "\n\\tocdepth " << tocdepth
1355 << "\n\\paragraph_separation "
1356 << string_paragraph_separation[paragraph_separation];
1357 if (!paragraph_separation)
1358 os << "\n\\paragraph_indentation "
1359 << (getParIndent().empty() ? "default" : getParIndent().asString());
1361 os << "\n\\defskip " << getDefSkip().asLyXCommand();
1362 os << "\n\\is_math_indent " << is_math_indent;
1363 if (is_math_indent && !getMathIndent().empty())
1364 os << "\n\\math_indentation " << getMathIndent().asString();
1365 os << "\n\\math_number_before ";
1366 switch(math_number) {
1376 os << "\n\\quotes_style "
1377 << string_quotes_style[quotes_style]
1378 << "\n\\dynamic_quotes " << dynamic_quotes
1379 << "\n\\papercolumns " << columns
1380 << "\n\\papersides " << sides
1381 << "\n\\paperpagestyle " << pagestyle << '\n';
1382 if (!listings_params.empty())
1383 os << "\\listings_params \"" <<
1384 InsetListingsParams(listings_params).encodedString() << "\"\n";
1385 for (int i = 0; i < 4; ++i) {
1386 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1387 if (user_defined_bullet(i).getFont() != -1) {
1388 os << "\\bullet " << i << " "
1389 << user_defined_bullet(i).getFont() << " "
1390 << user_defined_bullet(i).getCharacter() << " "
1391 << user_defined_bullet(i).getSize() << "\n";
1395 os << "\\bulletLaTeX " << i << " \""
1396 << lyx::to_ascii(user_defined_bullet(i).getText())
1402 os << "\\tracking_changes "
1403 << (save_transient_properties ? convert<string>(track_changes) : "false")
1406 os << "\\output_changes "
1407 << (save_transient_properties ? convert<string>(output_changes) : "false")
1410 os << "\\html_math_output " << html_math_output << '\n'
1411 << "\\html_css_as_file " << html_css_as_file << '\n'
1412 << "\\html_be_strict " << convert<string>(html_be_strict) << '\n';
1414 if (html_math_img_scale != 1.0)
1415 os << "\\html_math_img_scale " << convert<string>(html_math_img_scale) << '\n';
1416 if (!html_latex_start.empty())
1417 os << "\\html_latex_start " << html_latex_start << '\n';
1418 if (!html_latex_end.empty())
1419 os << "\\html_latex_end " << html_latex_end << '\n';
1421 os << pimpl_->authorlist;
1425 void BufferParams::validate(LaTeXFeatures & features) const
1427 features.require(documentClass().requires());
1429 if (columns > 1 && language->rightToLeft())
1430 features.require("rtloutputdblcol");
1432 if (output_changes) {
1433 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1434 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1435 LaTeXFeatures::isAvailable("xcolor");
1437 switch (features.runparams().flavor) {
1438 case OutputParams::LATEX:
1439 case OutputParams::DVILUATEX:
1441 features.require("ct-dvipost");
1442 features.require("dvipost");
1443 } else if (xcolorulem) {
1444 features.require("ct-xcolor-ulem");
1445 features.require("ulem");
1446 features.require("xcolor");
1448 features.require("ct-none");
1451 case OutputParams::LUATEX:
1452 case OutputParams::PDFLATEX:
1453 case OutputParams::XETEX:
1455 features.require("ct-xcolor-ulem");
1456 features.require("ulem");
1457 features.require("xcolor");
1458 // improves color handling in PDF output
1459 features.require("pdfcolmk");
1461 features.require("ct-none");
1469 // Floats with 'Here definitely' as default setting.
1470 if (float_placement.find('H') != string::npos)
1471 features.require("float");
1473 for (PackageMap::const_iterator it = use_packages.begin();
1474 it != use_packages.end(); ++it) {
1475 if (it->first == "amsmath") {
1476 // AMS Style is at document level
1477 if (it->second == package_on ||
1478 features.isProvided("amsmath"))
1479 features.require(it->first);
1480 } else if (it->second == package_on)
1481 features.require(it->first);
1484 // Document-level line spacing
1485 if (spacing().getSpace() != Spacing::Single && !spacing().isDefault())
1486 features.require("setspace");
1488 // the bullet shapes are buffer level not paragraph level
1489 // so they are tested here
1490 for (int i = 0; i < 4; ++i) {
1491 if (user_defined_bullet(i) == ITEMIZE_DEFAULTS[i])
1493 int const font = user_defined_bullet(i).getFont();
1495 int const c = user_defined_bullet(i).getCharacter();
1501 features.require("latexsym");
1503 } else if (font == 1) {
1504 features.require("amssymb");
1505 } else if (font >= 2 && font <= 5) {
1506 features.require("pifont");
1510 if (pdfoptions().use_hyperref) {
1511 features.require("hyperref");
1512 // due to interferences with babel and hyperref, the color package has to
1513 // be loaded after hyperref when hyperref is used with the colorlinks
1514 // option, see http://www.lyx.org/trac/ticket/5291
1515 if (pdfoptions().colorlinks)
1516 features.require("color");
1518 if (!listings_params.empty()) {
1519 // do not test validity because listings_params is
1520 // supposed to be valid
1522 InsetListingsParams(listings_params).separatedParams(true);
1523 // we can't support all packages, but we should load the color package
1524 if (par.find("\\color", 0) != string::npos)
1525 features.require("color");
1528 // some languages are only available via polyglossia
1529 if (features.hasPolyglossiaExclusiveLanguages())
1530 features.require("polyglossia");
1532 if (useNonTeXFonts && fontsMath() != "auto")
1533 features.require("unicode-math");
1536 features.require("microtype");
1538 if (!language->requires().empty())
1539 features.require(language->requires());
1543 bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
1544 FileName const & filepath) const
1546 // http://www.tug.org/texmf-dist/doc/latex/base/fixltx2e.pdf
1547 // !! To use the Fix-cm package, load it before \documentclass, and use the command
1548 // \RequirePackage to do so, rather than the normal \usepackage
1549 // Do not try to load any other package before the document class, unless you
1550 // have a thorough understanding of the LATEX internals and know exactly what you
1552 if (features.mustProvide("fix-cm"))
1553 os << "\\RequirePackage{fix-cm}\n";
1554 // Likewise for fixltx2e. If other packages conflict with this policy,
1555 // treat it as a package bug (and report it!)
1556 // See http://www.latex-project.org/cgi-bin/ltxbugs2html?pr=latex/4407
1557 if (features.mustProvide("fixltx2e"))
1558 os << "\\RequirePackage{fixltx2e}\n";
1560 os << "\\documentclass";
1562 DocumentClass const & tclass = documentClass();
1564 ostringstream clsoptions; // the document class options.
1566 if (tokenPos(tclass.opt_fontsize(),
1567 '|', fontsize) >= 0) {
1568 // only write if existing in list (and not default)
1569 clsoptions << fontsize << "pt,";
1572 // all paper sizes except of A4, A5, B5 and the US sizes need the
1574 bool nonstandard_papersize = papersize != PAPER_DEFAULT
1575 && papersize != PAPER_USLETTER
1576 && papersize != PAPER_USLEGAL
1577 && papersize != PAPER_USEXECUTIVE
1578 && papersize != PAPER_A4
1579 && papersize != PAPER_A5
1580 && papersize != PAPER_B5;
1582 if (!use_geometry) {
1583 switch (papersize) {
1585 clsoptions << "a4paper,";
1587 case PAPER_USLETTER:
1588 clsoptions << "letterpaper,";
1591 clsoptions << "a5paper,";
1594 clsoptions << "b5paper,";
1596 case PAPER_USEXECUTIVE:
1597 clsoptions << "executivepaper,";
1600 clsoptions << "legalpaper,";
1634 if (sides != tclass.sides()) {
1637 clsoptions << "oneside,";
1640 clsoptions << "twoside,";
1646 if (columns != tclass.columns()) {
1648 clsoptions << "twocolumn,";
1650 clsoptions << "onecolumn,";
1654 && orientation == ORIENTATION_LANDSCAPE)
1655 clsoptions << "landscape,";
1658 clsoptions << "fleqn,";
1660 switch(math_number) {
1662 clsoptions << "leqno,";
1665 clsoptions << "reqno,";
1666 features.require("amsmath");
1672 // language should be a parameter to \documentclass
1673 if (language->babel() == "hebrew"
1674 && default_language->babel() != "hebrew")
1675 // This seems necessary
1676 features.useLanguage(default_language);
1678 ostringstream language_options;
1679 bool const use_babel = features.useBabel() && !features.isProvided("babel");
1680 bool const use_polyglossia = features.usePolyglossia();
1681 bool const global = lyxrc.language_global_options;
1682 if (use_babel || (use_polyglossia && global)) {
1683 language_options << features.getBabelLanguages();
1684 if (!language->babel().empty()) {
1685 if (!language_options.str().empty())
1686 language_options << ',';
1687 language_options << language->babel();
1689 if (global && !features.needBabelLangOptions()
1690 && !language_options.str().empty())
1691 clsoptions << language_options.str() << ',';
1694 // the predefined options from the layout
1695 if (use_default_options && !tclass.options().empty())
1696 clsoptions << tclass.options() << ',';
1698 // the user-defined options
1699 if (!options.empty()) {
1700 clsoptions << options << ',';
1703 string strOptions(clsoptions.str());
1704 if (!strOptions.empty()) {
1705 strOptions = rtrim(strOptions, ",");
1707 os << '[' << from_utf8(strOptions) << ']';
1710 os << '{' << from_ascii(tclass.latexname()) << "}\n";
1711 // end of \documentclass defs
1713 // if we use fontspec or newtxmath, we have to load the AMS packages here
1714 string const ams = features.loadAMSPackages();
1715 bool const ot1 = (main_font_encoding() == "default" || main_font_encoding() == "OT1");
1716 bool const use_newtxmath =
1717 theLaTeXFonts().getLaTeXFont(from_ascii(fontsMath())).getUsedPackage(
1718 ot1, false, false) == "newtxmath";
1719 if ((useNonTeXFonts || use_newtxmath) && !ams.empty())
1720 os << from_ascii(ams);
1722 if (useNonTeXFonts) {
1723 if (!features.isProvided("fontspec"))
1724 os << "\\usepackage{fontspec}\n";
1725 if (features.mustProvide("unicode-math")
1726 && features.isAvailable("unicode-math"))
1727 os << "\\usepackage{unicode-math}\n";
1730 // font selection must be done before loading fontenc.sty
1731 string const fonts = loadFonts(features);
1733 os << from_utf8(fonts);
1735 if (fonts_default_family != "default")
1736 os << "\\renewcommand{\\familydefault}{\\"
1737 << from_ascii(fonts_default_family) << "}\n";
1739 // set font encoding
1740 // XeTeX and LuaTeX (with OS fonts) do not need fontenc
1741 if (!useNonTeXFonts && !features.isProvided("fontenc")
1742 && main_font_encoding() != "default") {
1743 // get main font encodings
1744 vector<string> fontencs = font_encodings();
1745 // get font encodings of secondary languages
1746 features.getFontEncodings(fontencs);
1747 if (!fontencs.empty()) {
1748 os << "\\usepackage["
1749 << from_ascii(getStringFromVector(fontencs))
1754 // handle inputenc etc.
1755 writeEncodingPreamble(os, features);
1758 if (!features.runparams().includeall && !included_children_.empty()) {
1759 os << "\\includeonly{";
1760 list<string>::const_iterator it = included_children_.begin();
1761 list<string>::const_iterator en = included_children_.end();
1763 for (; it != en; ++it) {
1764 string incfile = *it;
1765 FileName inc = makeAbsPath(incfile, filepath.absFileName());
1766 string mangled = DocFileName(changeExtension(inc.absFileName(), ".tex")).
1768 if (!features.runparams().nice)
1770 // \includeonly doesn't want an extension
1771 incfile = changeExtension(incfile, string());
1772 incfile = support::latex_path(incfile);
1773 if (!incfile.empty()) {
1776 os << from_utf8(incfile);
1783 if (!features.isProvided("geometry")
1784 && (use_geometry || nonstandard_papersize)) {
1785 odocstringstream ods;
1786 if (!getGraphicsDriver("geometry").empty())
1787 ods << getGraphicsDriver("geometry");
1788 if (orientation == ORIENTATION_LANDSCAPE)
1789 ods << ",landscape";
1790 switch (papersize) {
1792 if (!paperwidth.empty())
1793 ods << ",paperwidth="
1794 << from_ascii(paperwidth);
1795 if (!paperheight.empty())
1796 ods << ",paperheight="
1797 << from_ascii(paperheight);
1799 case PAPER_USLETTER:
1800 ods << ",letterpaper";
1803 ods << ",legalpaper";
1805 case PAPER_USEXECUTIVE:
1806 ods << ",executivepaper";
1895 docstring const g_options = trim(ods.str(), ",");
1896 os << "\\usepackage";
1897 if (!g_options.empty())
1898 os << '[' << g_options << ']';
1899 os << "{geometry}\n";
1900 // output this only if use_geometry is true
1902 os << "\\geometry{verbose";
1903 if (!topmargin.empty())
1904 os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1905 if (!bottommargin.empty())
1906 os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1907 if (!leftmargin.empty())
1908 os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1909 if (!rightmargin.empty())
1910 os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1911 if (!headheight.empty())
1912 os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1913 if (!headsep.empty())
1914 os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1915 if (!footskip.empty())
1916 os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1917 if (!columnsep.empty())
1918 os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
1921 } else if (orientation == ORIENTATION_LANDSCAPE
1922 || papersize != PAPER_DEFAULT) {
1923 features.require("papersize");
1926 if (tokenPos(tclass.opt_pagestyle(), '|', pagestyle) >= 0) {
1927 if (pagestyle == "fancy")
1928 os << "\\usepackage{fancyhdr}\n";
1929 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1932 // only output when the background color is not default
1933 if (isbackgroundcolor == true) {
1934 // only require color here, the background color will be defined
1935 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1937 features.require("color");
1938 features.require("pagecolor");
1941 // only output when the font color is not default
1942 if (isfontcolor == true) {
1943 // only require color here, the font color will be defined
1944 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1946 features.require("color");
1947 features.require("fontcolor");
1950 // Only if class has a ToC hierarchy
1951 if (tclass.hasTocLevels()) {
1952 if (secnumdepth != tclass.secnumdepth()) {
1953 os << "\\setcounter{secnumdepth}{"
1957 if (tocdepth != tclass.tocdepth()) {
1958 os << "\\setcounter{tocdepth}{"
1964 if (paragraph_separation) {
1965 // when skip separation
1966 switch (getDefSkip().kind()) {
1967 case VSpace::SMALLSKIP:
1968 os << "\\setlength{\\parskip}{\\smallskipamount}\n";
1970 case VSpace::MEDSKIP:
1971 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1973 case VSpace::BIGSKIP:
1974 os << "\\setlength{\\parskip}{\\bigskipamount}\n";
1976 case VSpace::LENGTH:
1977 os << "\\setlength{\\parskip}{"
1978 << from_utf8(getDefSkip().length().asLatexString())
1981 default: // should never happen // Then delete it.
1982 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1985 os << "\\setlength{\\parindent}{0pt}\n";
1987 // when separation by indentation
1988 // only output something when a width is given
1989 if (!getParIndent().empty()) {
1990 os << "\\setlength{\\parindent}{"
1991 << from_utf8(getParIndent().asLatexString())
1996 if (is_math_indent) {
1997 // when formula indentation
1998 // only output something when it is not the default
1999 if (!getMathIndent().empty()) {
2000 os << "\\setlength{\\mathindent}{"
2001 << from_utf8(getMathIndent().asString())
2006 // Now insert the LyX specific LaTeX commands...
2007 features.resolveAlternatives();
2008 features.expandMultiples();
2011 if (!output_sync_macro.empty())
2012 os << from_utf8(output_sync_macro) +"\n";
2013 else if (features.runparams().flavor == OutputParams::LATEX)
2014 os << "\\usepackage[active]{srcltx}\n";
2015 else if (features.runparams().flavor == OutputParams::PDFLATEX)
2016 os << "\\synctex=-1\n";
2019 // The package options (via \PassOptionsToPackage)
2020 os << from_ascii(features.getPackageOptions());
2022 // due to interferences with babel and hyperref, the color package has to
2023 // be loaded (when it is not already loaded) before babel when hyperref
2024 // is used with the colorlinks option, see
2025 // http://www.lyx.org/trac/ticket/5291
2026 // we decided therefore to load color always before babel, see
2027 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
2028 os << from_ascii(features.getColorOptions());
2030 // If we use hyperref, jurabib, japanese, varioref or vietnamese,
2031 // we have to call babel before
2033 && (features.isRequired("jurabib")
2034 || features.isRequired("hyperref")
2035 || features.isRequired("varioref")
2036 || features.isRequired("vietnamese")
2037 || features.isRequired("japanese"))) {
2038 os << features.getBabelPresettings();
2040 os << from_utf8(babelCall(language_options.str(),
2041 features.needBabelLangOptions())) + '\n';
2042 os << features.getBabelPostsettings();
2045 // The optional packages;
2046 os << from_ascii(features.getPackages());
2048 // Additional Indices
2049 if (features.isRequired("splitidx")) {
2050 IndicesList::const_iterator iit = indiceslist().begin();
2051 IndicesList::const_iterator iend = indiceslist().end();
2052 for (; iit != iend; ++iit) {
2053 os << "\\newindex{";
2054 os << escape(iit->shortcut());
2060 os << from_utf8(spacing().writePreamble(features.isProvided("SetSpace")));
2063 // * Hyperref manual: "Make sure it comes last of your loaded
2064 // packages, to give it a fighting chance of not being over-written,
2065 // since its job is to redefine many LaTeX commands."
2066 // * Email from Heiko Oberdiek: "It is usually better to load babel
2067 // before hyperref. Then hyperref has a chance to detect babel.
2068 // * Has to be loaded before the "LyX specific LaTeX commands" to
2069 // avoid errors with algorithm floats.
2070 // use hyperref explicitly if it is required
2071 if (features.isRequired("hyperref")) {
2072 OutputParams tmp_params = features.runparams();
2073 pdfoptions().writeLaTeX(tmp_params, os,
2074 features.isProvided("hyperref"));
2075 // correctly break URLs with hyperref and dvi output
2076 if (features.runparams().flavor == OutputParams::LATEX
2077 && features.isAvailable("breakurl"))
2078 os << "\\usepackage{breakurl}\n";
2079 } else if (features.isRequired("nameref"))
2080 // hyperref loads this automatically
2081 os << "\\usepackage{nameref}\n";
2083 // bibtopic needs to be loaded after hyperref.
2084 // the dot provides the aux file naming which LyX can detect.
2085 if (features.mustProvide("bibtopic"))
2086 os << "\\usepackage[dot]{bibtopic}\n";
2088 // Will be surrounded by \makeatletter and \makeatother when not empty
2089 otexstringstream atlyxpreamble;
2091 // Some macros LyX will need
2093 TexString tmppreamble = features.getMacros();
2094 if (!tmppreamble.str.empty())
2095 atlyxpreamble << "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2096 "LyX specific LaTeX commands.\n"
2097 << move(tmppreamble)
2100 // the text class specific preamble
2102 docstring tmppreamble = features.getTClassPreamble();
2103 if (!tmppreamble.empty())
2104 atlyxpreamble << "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2105 "Textclass specific LaTeX commands.\n"
2109 // suppress date if selected
2110 // use \@ifundefined because we cannot be sure that every document class
2111 // has a \date command
2113 atlyxpreamble << "\\@ifundefined{date}{}{\\date{}}\n";
2115 /* the user-defined preamble */
2116 if (!containsOnly(preamble, " \n\t")) {
2118 atlyxpreamble << "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2119 "User specified LaTeX commands.\n";
2121 // Check if the user preamble contains uncodable glyphs
2122 odocstringstream user_preamble;
2123 docstring uncodable_glyphs;
2124 Encoding const * const enc = features.runparams().encoding;
2126 for (size_t n = 0; n < preamble.size(); ++n) {
2127 char_type c = preamble[n];
2128 if (!enc->encodable(c)) {
2129 docstring const glyph(1, c);
2130 LYXERR0("Uncodable character '"
2132 << "' in user preamble!");
2133 uncodable_glyphs += glyph;
2134 if (features.runparams().dryrun) {
2135 user_preamble << "<" << _("LyX Warning: ")
2136 << _("uncodable character") << " '";
2137 user_preamble.put(c);
2138 user_preamble << "'>";
2141 user_preamble.put(c);
2144 user_preamble << preamble;
2146 // On BUFFER_VIEW|UPDATE, warn user if we found uncodable glyphs
2147 if (!features.runparams().dryrun && !uncodable_glyphs.empty()) {
2148 frontend::Alert::warning(
2149 _("Uncodable character in user preamble"),
2151 _("The user preamble of your document contains glyphs "
2152 "that are unknown in the current document encoding "
2153 "(namely %1$s).\nThese glyphs are omitted "
2154 " from the output, which may result in "
2155 "incomplete output."
2156 "\n\nPlease select an appropriate "
2157 "document encoding\n"
2158 "(such as utf8) or change the "
2159 "preamble code accordingly."),
2162 atlyxpreamble << user_preamble.str() << '\n';
2165 // footmisc must be loaded after setspace
2166 // Load it here to avoid clashes with footmisc loaded in the user
2167 // preamble. For that reason we also pass the options via
2168 // \PassOptionsToPackage in getPreamble() and not here.
2169 if (features.mustProvide("footmisc"))
2170 atlyxpreamble << "\\usepackage{footmisc}\n";
2172 // subfig loads internally the LaTeX package "caption". As
2173 // caption is a very popular package, users will load it in
2174 // the preamble. Therefore we must load subfig behind the
2175 // user-defined preamble and check if the caption package was
2176 // loaded or not. For the case that caption is loaded before
2177 // subfig, there is the subfig option "caption=false". This
2178 // option also works when a koma-script class is used and
2179 // koma's own caption commands are used instead of caption. We
2180 // use \PassOptionsToPackage here because the user could have
2181 // already loaded subfig in the preamble.
2182 if (features.mustProvide("subfig"))
2183 atlyxpreamble << "\\@ifundefined{showcaptionsetup}{}{%\n"
2184 " \\PassOptionsToPackage{caption=false}{subfig}}\n"
2185 "\\usepackage{subfig}\n";
2187 // Itemize bullet settings need to be last in case the user
2188 // defines their own bullets that use a package included
2189 // in the user-defined preamble -- ARRae
2190 // Actually it has to be done much later than that
2191 // since some packages like frenchb make modifications
2192 // at \begin{document} time -- JMarc
2193 docstring bullets_def;
2194 for (int i = 0; i < 4; ++i) {
2195 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
2196 if (bullets_def.empty())
2197 bullets_def += "\\AtBeginDocument{\n";
2198 bullets_def += " \\def\\labelitemi";
2200 // `i' is one less than the item to modify
2207 bullets_def += "ii";
2213 bullets_def += '{' +
2214 user_defined_bullet(i).getText()
2219 if (!bullets_def.empty())
2220 atlyxpreamble << bullets_def << "}\n\n";
2222 if (!atlyxpreamble.empty())
2223 os << "\n\\makeatletter\n"
2224 << atlyxpreamble.release()
2225 << "\\makeatother\n\n";
2227 // We try to load babel late, in case it interferes with other packages.
2228 // Jurabib, hyperref, varioref, bicaption and listings (bug 8995) have to be
2229 // called after babel, though.
2230 if (use_babel && !features.isRequired("jurabib")
2231 && !features.isRequired("hyperref")
2232 && !features.isRequired("varioref")
2233 && !features.isRequired("vietnamese")
2234 && !features.isRequired("japanese")) {
2235 os << features.getBabelPresettings();
2237 os << from_utf8(babelCall(language_options.str(),
2238 features.needBabelLangOptions())) + '\n';
2239 os << features.getBabelPostsettings();
2241 if (features.isRequired("bicaption"))
2242 os << "\\usepackage{bicaption}\n";
2243 if (!listings_params.empty() || features.mustProvide("listings"))
2244 os << "\\usepackage{listings}\n";
2245 if (!listings_params.empty()) {
2247 // do not test validity because listings_params is
2248 // supposed to be valid
2250 InsetListingsParams(listings_params).separatedParams(true);
2251 os << from_utf8(par);
2255 // xunicode only needs to be loaded if tipa is used
2256 // (the rest is obsoleted by the new TU encoding).
2257 // It needs to be loaded at least after amsmath, amssymb,
2258 // esint and the other packages that provide special glyphs
2259 if (features.mustProvide("tipa") && useNonTeXFonts) {
2260 // The package officially only supports XeTeX, but also works
2261 // with LuaTeX. Thus we work around its XeTeX test.
2262 if (features.runparams().flavor != OutputParams::XETEX) {
2263 os << "% Pretend to xunicode that we are XeTeX\n"
2264 << "\\def\\XeTeXpicfile{}\n";
2266 os << "\\usepackage{xunicode}\n";
2269 // Polyglossia must be loaded last ...
2270 if (use_polyglossia) {
2272 os << "\\usepackage{polyglossia}\n";
2273 // set the main language
2274 os << "\\setdefaultlanguage";
2275 if (!language->polyglossiaOpts().empty())
2276 os << "[" << from_ascii(language->polyglossiaOpts()) << "]";
2277 os << "{" << from_ascii(language->polyglossia()) << "}\n";
2278 // now setup the other languages
2279 set<string> const polylangs =
2280 features.getPolyglossiaLanguages();
2281 for (set<string>::const_iterator mit = polylangs.begin();
2282 mit != polylangs.end() ; ++mit) {
2283 // We do not output the options here; they are output in
2284 // the language switch commands. This is safer if multiple
2285 // varieties are used.
2286 if (*mit == language->polyglossia())
2288 os << "\\setotherlanguage";
2289 os << "{" << from_ascii(*mit) << "}\n";
2293 // ... but before biblatex (see #7065)
2294 if (features.mustProvide("biblatex")) {
2297 os << "\\usepackage";
2298 if (!biblatex_bibstyle.empty()
2299 && (biblatex_bibstyle == biblatex_citestyle)) {
2300 opts = "style=" + biblatex_bibstyle;
2303 if (!biblatex_bibstyle.empty()) {
2304 opts = "bibstyle=" + biblatex_bibstyle;
2307 if (!biblatex_citestyle.empty()) {
2308 opts += delim + "citestyle=" + biblatex_citestyle;
2312 if (!multibib.empty() && multibib != "child") {
2313 opts += delim + "refsection=" + multibib;
2316 if (bibtexCommand() == "bibtex8"
2317 || prefixIs(bibtexCommand(), "bibtex8 ")) {
2318 opts += delim + "backend=bibtex8";
2320 } else if (bibtexCommand() == "bibtex"
2321 || prefixIs(bibtexCommand(), "bibtex ")) {
2322 opts += delim + "backend=bibtex";
2325 if (!biblio_opts.empty())
2326 opts += delim + biblio_opts;
2328 os << "[" << opts << "]";
2329 os << "{biblatex}\n";
2333 // Load custom language package here
2334 if (features.langPackage() == LaTeXFeatures::LANG_PACK_CUSTOM) {
2335 if (lang_package == "default")
2336 os << from_utf8(lyxrc.language_custom_package);
2338 os << from_utf8(lang_package);
2342 docstring const i18npreamble =
2343 features.getTClassI18nPreamble(use_babel, use_polyglossia);
2344 if (!i18npreamble.empty())
2345 os << i18npreamble + '\n';
2351 void BufferParams::useClassDefaults()
2353 DocumentClass const & tclass = documentClass();
2355 sides = tclass.sides();
2356 columns = tclass.columns();
2357 pagestyle = tclass.pagestyle();
2358 use_default_options = true;
2359 // Only if class has a ToC hierarchy
2360 if (tclass.hasTocLevels()) {
2361 secnumdepth = tclass.secnumdepth();
2362 tocdepth = tclass.tocdepth();
2367 bool BufferParams::hasClassDefaults() const
2369 DocumentClass const & tclass = documentClass();
2371 return sides == tclass.sides()
2372 && columns == tclass.columns()
2373 && pagestyle == tclass.pagestyle()
2374 && use_default_options
2375 && secnumdepth == tclass.secnumdepth()
2376 && tocdepth == tclass.tocdepth();
2380 DocumentClass const & BufferParams::documentClass() const
2386 DocumentClassConstPtr BufferParams::documentClassPtr() const
2392 void BufferParams::setDocumentClass(DocumentClassConstPtr tc)
2394 // evil, but this function is evil
2395 doc_class_ = const_pointer_cast<DocumentClass>(tc);
2396 invalidateConverterCache();
2400 bool BufferParams::setBaseClass(string const & classname)
2402 LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
2403 LayoutFileList & bcl = LayoutFileList::get();
2404 if (!bcl.haveClass(classname)) {
2406 bformat(_("The layout file:\n"
2408 "could not be found. A default textclass with default\n"
2409 "layouts will be used. LyX will not be able to produce\n"
2411 from_utf8(classname));
2412 frontend::Alert::error(_("Document class not found"), s);
2413 bcl.addEmptyClass(classname);
2416 bool const success = bcl[classname].load();
2419 bformat(_("Due to some error in it, the layout file:\n"
2421 "could not be loaded. A default textclass with default\n"
2422 "layouts will be used. LyX will not be able to produce\n"
2424 from_utf8(classname));
2425 frontend::Alert::error(_("Could not load class"), s);
2426 bcl.addEmptyClass(classname);
2429 pimpl_->baseClass_ = classname;
2430 layout_modules_.adaptToBaseClass(baseClass(), removed_modules_);
2435 LayoutFile const * BufferParams::baseClass() const
2437 if (LayoutFileList::get().haveClass(pimpl_->baseClass_))
2438 return &(LayoutFileList::get()[pimpl_->baseClass_]);
2444 LayoutFileIndex const & BufferParams::baseClassID() const
2446 return pimpl_->baseClass_;
2450 void BufferParams::makeDocumentClass(bool const clone)
2455 invalidateConverterCache();
2456 LayoutModuleList mods;
2457 LayoutModuleList ces;
2458 LayoutModuleList::iterator it = layout_modules_.begin();
2459 LayoutModuleList::iterator en = layout_modules_.end();
2460 for (; it != en; ++it)
2461 mods.push_back(*it);
2463 it = cite_engine_.begin();
2464 en = cite_engine_.end();
2465 for (; it != en; ++it)
2468 doc_class_ = getDocumentClass(*baseClass(), mods, ces, clone);
2470 TextClass::ReturnValues success = TextClass::OK;
2471 if (!forced_local_layout_.empty())
2472 success = doc_class_->read(to_utf8(forced_local_layout_),
2474 if (!local_layout_.empty() &&
2475 (success == TextClass::OK || success == TextClass::OK_OLDFORMAT))
2476 success = doc_class_->read(to_utf8(local_layout_), TextClass::MODULE);
2477 if (success != TextClass::OK && success != TextClass::OK_OLDFORMAT) {
2478 docstring const msg = _("Error reading internal layout information");
2479 frontend::Alert::warning(_("Read Error"), msg);
2484 bool BufferParams::layoutModuleCanBeAdded(string const & modName) const
2486 return layout_modules_.moduleCanBeAdded(modName, baseClass());
2490 bool BufferParams::citationModuleCanBeAdded(string const & modName) const
2492 return cite_engine_.moduleCanBeAdded(modName, baseClass());
2496 docstring BufferParams::getLocalLayout(bool forced) const
2499 return from_utf8(doc_class_->forcedLayouts());
2501 return local_layout_;
2505 void BufferParams::setLocalLayout(docstring const & layout, bool forced)
2508 forced_local_layout_ = layout;
2510 local_layout_ = layout;
2514 bool BufferParams::addLayoutModule(string const & modName)
2516 LayoutModuleList::const_iterator it = layout_modules_.begin();
2517 LayoutModuleList::const_iterator end = layout_modules_.end();
2518 for (; it != end; ++it)
2521 layout_modules_.push_back(modName);
2526 string BufferParams::bufferFormat() const
2528 return documentClass().outputFormat();
2532 bool BufferParams::isExportable(string const & format, bool need_viewable) const
2534 FormatList const & formats = exportableFormats(need_viewable);
2535 FormatList::const_iterator fit = formats.begin();
2536 FormatList::const_iterator end = formats.end();
2537 for (; fit != end ; ++fit) {
2538 if ((*fit)->name() == format)
2545 FormatList const & BufferParams::exportableFormats(bool only_viewable) const
2547 FormatList & cached = only_viewable ?
2548 pimpl_->viewableFormatList : pimpl_->exportableFormatList;
2549 bool & valid = only_viewable ?
2550 pimpl_->isViewCacheValid : pimpl_->isExportCacheValid;
2554 vector<string> const backs = backends();
2555 set<string> excludes;
2556 if (useNonTeXFonts) {
2557 excludes.insert("latex");
2558 excludes.insert("pdflatex");
2561 theConverters().getReachable(backs[0], only_viewable, true, excludes);
2562 for (vector<string>::const_iterator it = backs.begin() + 1;
2563 it != backs.end(); ++it) {
2564 FormatList r = theConverters().getReachable(*it, only_viewable,
2566 result.insert(result.end(), r.begin(), r.end());
2568 sort(result.begin(), result.end(), Format::formatSorter);
2575 vector<string> BufferParams::backends() const
2578 string const buffmt = bufferFormat();
2580 // FIXME: Don't hardcode format names here, but use a flag
2581 if (buffmt == "latex") {
2582 if (encoding().package() == Encoding::japanese)
2583 v.push_back("platex");
2585 if (!useNonTeXFonts) {
2586 v.push_back("pdflatex");
2587 v.push_back("latex");
2589 v.push_back("xetex");
2590 v.push_back("luatex");
2591 v.push_back("dviluatex");
2594 v.push_back(buffmt);
2596 v.push_back("xhtml");
2597 v.push_back("text");
2603 OutputParams::FLAVOR BufferParams::getOutputFlavor(string const & format) const
2605 string const dformat = (format.empty() || format == "default") ?
2606 getDefaultOutputFormat() : format;
2607 DefaultFlavorCache::const_iterator it =
2608 default_flavors_.find(dformat);
2610 if (it != default_flavors_.end())
2613 OutputParams::FLAVOR result = OutputParams::LATEX;
2615 // FIXME It'd be better not to hardcode this, but to do
2616 // something with formats.
2617 if (dformat == "xhtml")
2618 result = OutputParams::HTML;
2619 else if (dformat == "text")
2620 result = OutputParams::TEXT;
2621 else if (dformat == "lyx")
2622 result = OutputParams::LYX;
2623 else if (dformat == "pdflatex")
2624 result = OutputParams::PDFLATEX;
2625 else if (dformat == "xetex")
2626 result = OutputParams::XETEX;
2627 else if (dformat == "luatex")
2628 result = OutputParams::LUATEX;
2629 else if (dformat == "dviluatex")
2630 result = OutputParams::DVILUATEX;
2632 // Try to determine flavor of default output format
2633 vector<string> backs = backends();
2634 if (find(backs.begin(), backs.end(), dformat) == backs.end()) {
2635 // Get shortest path to format
2636 Graph::EdgePath path;
2637 for (vector<string>::const_iterator it = backs.begin();
2638 it != backs.end(); ++it) {
2639 Graph::EdgePath p = theConverters().getPath(*it, dformat);
2640 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2645 result = theConverters().getFlavor(path);
2648 // cache this flavor
2649 default_flavors_[dformat] = result;
2654 string BufferParams::getDefaultOutputFormat() const
2656 if (!default_output_format.empty()
2657 && default_output_format != "default")
2658 return default_output_format;
2660 || encoding().package() == Encoding::japanese) {
2661 FormatList const & formats = exportableFormats(true);
2662 if (formats.empty())
2664 // return the first we find
2665 return formats.front()->name();
2668 return lyxrc.default_otf_view_format;
2669 return lyxrc.default_view_format;
2672 Font const BufferParams::getFont() const
2674 FontInfo f = documentClass().defaultfont();
2675 if (fonts_default_family == "rmdefault")
2676 f.setFamily(ROMAN_FAMILY);
2677 else if (fonts_default_family == "sfdefault")
2678 f.setFamily(SANS_FAMILY);
2679 else if (fonts_default_family == "ttdefault")
2680 f.setFamily(TYPEWRITER_FAMILY);
2681 return Font(f, language);
2685 InsetQuotesParams::QuoteStyle BufferParams::getQuoteStyle(string const & qs) const
2687 return quotesstyletranslator().find(qs);
2691 bool BufferParams::isLatex() const
2693 return documentClass().outputType() == LATEX;
2697 bool BufferParams::isLiterate() const
2699 return documentClass().outputType() == LITERATE;
2703 bool BufferParams::isDocBook() const
2705 return documentClass().outputType() == DOCBOOK;
2709 void BufferParams::readPreamble(Lexer & lex)
2711 if (lex.getString() != "\\begin_preamble")
2712 lyxerr << "Error (BufferParams::readPreamble):"
2713 "consistency check failed." << endl;
2715 preamble = lex.getLongString(from_ascii("\\end_preamble"));
2719 void BufferParams::readLocalLayout(Lexer & lex, bool forced)
2721 string const expected = forced ? "\\begin_forced_local_layout" :
2722 "\\begin_local_layout";
2723 if (lex.getString() != expected)
2724 lyxerr << "Error (BufferParams::readLocalLayout):"
2725 "consistency check failed." << endl;
2728 forced_local_layout_ =
2729 lex.getLongString(from_ascii("\\end_forced_local_layout"));
2731 local_layout_ = lex.getLongString(from_ascii("\\end_local_layout"));
2735 bool BufferParams::setLanguage(string const & lang)
2737 Language const *new_language = languages.getLanguage(lang);
2738 if (!new_language) {
2739 // Language lang was not found
2742 language = new_language;
2747 void BufferParams::readLanguage(Lexer & lex)
2749 if (!lex.next()) return;
2751 string const tmptok = lex.getString();
2753 // check if tmptok is part of tex_babel in tex-defs.h
2754 if (!setLanguage(tmptok)) {
2755 // Language tmptok was not found
2756 language = default_language;
2757 lyxerr << "Warning: Setting language `"
2758 << tmptok << "' to `" << language->lang()
2764 void BufferParams::readGraphicsDriver(Lexer & lex)
2769 string const tmptok = lex.getString();
2770 // check if tmptok is part of tex_graphics in tex_defs.h
2773 string const test = tex_graphics[n++];
2775 if (test == tmptok) {
2776 graphics_driver = tmptok;
2781 "Warning: graphics driver `$$Token' not recognized!\n"
2782 " Setting graphics driver to `default'.\n");
2783 graphics_driver = "default";
2790 void BufferParams::readBullets(Lexer & lex)
2795 int const index = lex.getInteger();
2797 int temp_int = lex.getInteger();
2798 user_defined_bullet(index).setFont(temp_int);
2799 temp_bullet(index).setFont(temp_int);
2801 user_defined_bullet(index).setCharacter(temp_int);
2802 temp_bullet(index).setCharacter(temp_int);
2804 user_defined_bullet(index).setSize(temp_int);
2805 temp_bullet(index).setSize(temp_int);
2809 void BufferParams::readBulletsLaTeX(Lexer & lex)
2811 // The bullet class should be able to read this.
2814 int const index = lex.getInteger();
2816 docstring const temp_str = lex.getDocString();
2818 user_defined_bullet(index).setText(temp_str);
2819 temp_bullet(index).setText(temp_str);
2823 void BufferParams::readModules(Lexer & lex)
2825 if (!lex.eatLine()) {
2826 lyxerr << "Error (BufferParams::readModules):"
2827 "Unexpected end of input." << endl;
2831 string mod = lex.getString();
2832 if (mod == "\\end_modules")
2834 addLayoutModule(mod);
2840 void BufferParams::readRemovedModules(Lexer & lex)
2842 if (!lex.eatLine()) {
2843 lyxerr << "Error (BufferParams::readRemovedModules):"
2844 "Unexpected end of input." << endl;
2848 string mod = lex.getString();
2849 if (mod == "\\end_removed_modules")
2851 removed_modules_.push_back(mod);
2854 // now we want to remove any removed modules that were previously
2855 // added. normally, that will be because default modules were added in
2856 // setBaseClass(), which gets called when \textclass is read at the
2857 // start of the read.
2858 list<string>::const_iterator rit = removed_modules_.begin();
2859 list<string>::const_iterator const ren = removed_modules_.end();
2860 for (; rit != ren; ++rit) {
2861 LayoutModuleList::iterator const mit = layout_modules_.begin();
2862 LayoutModuleList::iterator const men = layout_modules_.end();
2863 LayoutModuleList::iterator found = find(mit, men, *rit);
2866 layout_modules_.erase(found);
2871 void BufferParams::readIncludeonly(Lexer & lex)
2873 if (!lex.eatLine()) {
2874 lyxerr << "Error (BufferParams::readIncludeonly):"
2875 "Unexpected end of input." << endl;
2879 string child = lex.getString();
2880 if (child == "\\end_includeonly")
2882 included_children_.push_back(child);
2888 string BufferParams::paperSizeName(PapersizePurpose purpose) const
2890 switch (papersize) {
2892 // could be anything, so don't guess
2894 case PAPER_CUSTOM: {
2895 if (purpose == XDVI && !paperwidth.empty() &&
2896 !paperheight.empty()) {
2897 // heightxwidth<unit>
2898 string first = paperwidth;
2899 string second = paperheight;
2900 if (orientation == ORIENTATION_LANDSCAPE)
2903 return first.erase(first.length() - 2)
2909 // dvips and dvipdfm do not know this
2910 if (purpose == DVIPS || purpose == DVIPDFM)
2914 if (purpose == DVIPS || purpose == DVIPDFM)
2918 if (purpose == DVIPS || purpose == DVIPDFM)
2928 if (purpose == DVIPS || purpose == DVIPDFM)
2932 if (purpose == DVIPS || purpose == DVIPDFM)
2936 if (purpose == DVIPS || purpose == DVIPDFM)
2940 if (purpose == DVIPS || purpose == DVIPDFM)
2944 if (purpose == DVIPS || purpose == DVIPDFM)
2948 // dvipdfm does not know this
2949 if (purpose == DVIPDFM)
2953 if (purpose == DVIPDFM)
2957 if (purpose == DVIPS || purpose == DVIPDFM)
2961 if (purpose == DVIPS || purpose == DVIPDFM)
2965 if (purpose == DVIPS || purpose == DVIPDFM)
2969 if (purpose == DVIPS || purpose == DVIPDFM)
2973 if (purpose == DVIPS || purpose == DVIPDFM)
2977 if (purpose == DVIPS || purpose == DVIPDFM)
2981 if (purpose == DVIPS || purpose == DVIPDFM)
2985 if (purpose == DVIPS || purpose == DVIPDFM)
2989 if (purpose == DVIPS || purpose == DVIPDFM)
2993 if (purpose == DVIPS || purpose == DVIPDFM)
2997 if (purpose == DVIPS || purpose == DVIPDFM)
3001 if (purpose == DVIPS || purpose == DVIPDFM)
3005 if (purpose == DVIPS || purpose == DVIPDFM)
3009 if (purpose == DVIPS || purpose == DVIPDFM)
3013 if (purpose == DVIPS || purpose == DVIPDFM)
3016 case PAPER_USEXECUTIVE:
3017 // dvipdfm does not know this
3018 if (purpose == DVIPDFM)
3023 case PAPER_USLETTER:
3025 if (purpose == XDVI)
3032 string const BufferParams::dvips_options() const
3036 // If the class loads the geometry package, we do not know which
3037 // paper size is used, since we do not set it (bug 7013).
3038 // Therefore we must not specify any argument here.
3039 // dvips gets the correct paper size via DVI specials in this case
3040 // (if the class uses the geometry package correctly).
3041 if (documentClass().provides("geometry"))
3045 && papersize == PAPER_CUSTOM
3046 && !lyxrc.print_paper_dimension_flag.empty()
3047 && !paperwidth.empty()
3048 && !paperheight.empty()) {
3049 // using a custom papersize
3050 result = lyxrc.print_paper_dimension_flag;
3051 result += ' ' + paperwidth;
3052 result += ',' + paperheight;
3054 string const paper_option = paperSizeName(DVIPS);
3055 if (!paper_option.empty() && (paper_option != "letter" ||
3056 orientation != ORIENTATION_LANDSCAPE)) {
3057 // dvips won't accept -t letter -t landscape.
3058 // In all other cases, include the paper size
3060 result = lyxrc.print_paper_flag;
3061 result += ' ' + paper_option;
3064 if (orientation == ORIENTATION_LANDSCAPE &&
3065 papersize != PAPER_CUSTOM)
3066 result += ' ' + lyxrc.print_landscape_flag;
3071 string const BufferParams::main_font_encoding() const
3073 return font_encodings().empty() ? "default" : font_encodings().back();
3077 vector<string> const BufferParams::font_encodings() const
3079 string doc_fontenc = (fontenc == "global") ? lyxrc.fontenc : fontenc;
3081 vector<string> fontencs;
3083 // "default" means "no explicit font encoding"
3084 if (doc_fontenc != "default") {
3085 fontencs = getVectorFromString(doc_fontenc);
3086 if (!language->fontenc().empty()
3087 && ascii_lowercase(language->fontenc()) != "none") {
3088 vector<string> fencs = getVectorFromString(language->fontenc());
3089 vector<string>::const_iterator fit = fencs.begin();
3090 for (; fit != fencs.end(); ++fit) {
3091 if (find(fontencs.begin(), fontencs.end(), *fit) == fontencs.end())
3092 fontencs.push_back(*fit);
3101 string BufferParams::babelCall(string const & lang_opts, bool const langoptions) const
3103 // suppress the babel call if there is no BabelName defined
3104 // for the document language in the lib/languages file and if no
3105 // other languages are used (lang_opts is then empty)
3106 if (lang_opts.empty())
3108 // either a specific language (AsBabelOptions setting in
3109 // lib/languages) or the prefs require the languages to
3110 // be submitted to babel itself (not the class).
3112 return "\\usepackage[" + lang_opts + "]{babel}";
3113 return "\\usepackage{babel}";
3117 docstring BufferParams::getGraphicsDriver(string const & package) const
3121 if (package == "geometry") {
3122 if (graphics_driver == "dvips"
3123 || graphics_driver == "dvipdfm"
3124 || graphics_driver == "pdftex"
3125 || graphics_driver == "vtex")
3126 result = from_ascii(graphics_driver);
3127 else if (graphics_driver == "dvipdfmx")
3128 result = from_ascii("dvipdfm");
3135 void BufferParams::writeEncodingPreamble(otexstream & os,
3136 LaTeXFeatures & features) const
3138 // XeTeX/LuaTeX: (see also #9740)
3139 // With Unicode fonts we use utf8-plain without encoding package.
3140 // With TeX fonts, we cannot use utf8-plain, but "inputenc" fails.
3141 // XeTeX must use ASCII encoding (see Buffer.cpp),
3142 // for LuaTeX, we load "luainputenc" (see below).
3143 if (useNonTeXFonts || features.runparams().flavor == OutputParams::XETEX)
3146 if (inputenc == "auto") {
3147 string const doc_encoding =
3148 language->encoding()->latexName();
3149 Encoding::Package const package =
3150 language->encoding()->package();
3152 // Create list of inputenc options:
3153 set<string> encodings;
3154 // luainputenc fails with more than one encoding
3155 if (!features.runparams().isFullUnicode()) // if we reach this point, this means LuaTeX with TeX fonts
3156 // list all input encodings used in the document
3157 encodings = features.getEncodingSet(doc_encoding);
3159 // If the "japanese" package (i.e. pLaTeX) is used,
3160 // inputenc must be omitted.
3161 // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
3162 if ((!encodings.empty() || package == Encoding::inputenc)
3163 && !features.isRequired("japanese")
3164 && !features.isProvided("inputenc")) {
3165 os << "\\usepackage[";
3166 set<string>::const_iterator it = encodings.begin();
3167 set<string>::const_iterator const end = encodings.end();
3169 os << from_ascii(*it);
3172 for (; it != end; ++it)
3173 os << ',' << from_ascii(*it);
3174 if (package == Encoding::inputenc) {
3175 if (!encodings.empty())
3177 os << from_ascii(doc_encoding);
3179 if (features.runparams().flavor == OutputParams::LUATEX
3180 || features.runparams().flavor == OutputParams::DVILUATEX)
3181 os << "]{luainputenc}\n";
3183 os << "]{inputenc}\n";
3185 if (package == Encoding::CJK || features.mustProvide("CJK")) {
3186 if (language->encoding()->name() == "utf8-cjk"
3187 && LaTeXFeatures::isAvailable("CJKutf8"))
3188 os << "\\usepackage{CJKutf8}\n";
3190 os << "\\usepackage{CJK}\n";
3192 } else if (inputenc != "default") {
3193 switch (encoding().package()) {
3194 case Encoding::none:
3195 case Encoding::japanese:
3197 case Encoding::inputenc:
3198 // do not load inputenc if japanese is used
3199 // or if the class provides inputenc
3200 if (features.isRequired("japanese")
3201 || features.isProvided("inputenc"))
3203 os << "\\usepackage[" << from_ascii(encoding().latexName());
3204 if (features.runparams().flavor == OutputParams::LUATEX
3205 || features.runparams().flavor == OutputParams::DVILUATEX)
3206 os << "]{luainputenc}\n";
3208 os << "]{inputenc}\n";
3211 if (encoding().name() == "utf8-cjk"
3212 && LaTeXFeatures::isAvailable("CJKutf8"))
3213 os << "\\usepackage{CJKutf8}\n";
3215 os << "\\usepackage{CJK}\n";
3218 // Load the CJK package if needed by a secondary language.
3219 // If the main encoding is some variant of UTF8, use CJKutf8.
3220 if (encoding().package() != Encoding::CJK && features.mustProvide("CJK")) {
3221 if (encoding().iconvName() == "UTF-8"
3222 && LaTeXFeatures::isAvailable("CJKutf8"))
3223 os << "\\usepackage{CJKutf8}\n";
3225 os << "\\usepackage{CJK}\n";
3231 string const BufferParams::parseFontName(string const & name) const
3233 string mangled = name;
3234 size_t const idx = mangled.find('[');
3235 if (idx == string::npos || idx == 0)
3238 return mangled.substr(0, idx - 1);
3242 string const BufferParams::loadFonts(LaTeXFeatures & features) const
3244 if (fontsRoman() == "default" && fontsSans() == "default"
3245 && fontsTypewriter() == "default"
3246 && (fontsMath() == "default" || fontsMath() == "auto"))
3252 /* Fontspec (XeTeX, LuaTeX): we provide GUI support for oldstyle
3253 * numbers (Numbers=OldStyle) and sf/tt scaling. The Ligatures=TeX/
3254 * Mapping=tex-text option assures TeX ligatures (such as "--")
3255 * are resolved. Note that tt does not use these ligatures.
3257 * -- add more GUI options?
3258 * -- add more fonts (fonts for other scripts)
3259 * -- if there's a way to find out if a font really supports
3260 * OldStyle, enable/disable the widget accordingly.
3262 if (useNonTeXFonts && features.isAvailable("fontspec")) {
3263 // "Mapping=tex-text" and "Ligatures=TeX" are equivalent.
3264 // However, until v.2 (2010/07/11) fontspec only knew
3265 // Mapping=tex-text (for XeTeX only); then "Ligatures=TeX"
3266 // was introduced for both XeTeX and LuaTeX (LuaTeX
3267 // didn't understand "Mapping=tex-text", while XeTeX
3268 // understood both. With most recent versions, both
3269 // variants are understood by both engines. However,
3270 // we want to provide support for at least TeXLive 2009
3271 // (for XeTeX; LuaTeX is only supported as of v.2)
3272 string const texmapping =
3273 (features.runparams().flavor == OutputParams::XETEX) ?
3274 "Mapping=tex-text" : "Ligatures=TeX";
3275 if (fontsRoman() != "default") {
3276 os << "\\setmainfont[" << texmapping;
3277 if (fonts_old_figures)
3278 os << ",Numbers=OldStyle";
3279 os << "]{" << parseFontName(fontsRoman()) << "}\n";
3281 if (fontsSans() != "default") {
3282 string const sans = parseFontName(fontsSans());
3283 if (fontsSansScale() != 100)
3284 os << "\\setsansfont[Scale="
3285 << float(fontsSansScale()) / 100
3286 << "," << texmapping << "]{"
3289 os << "\\setsansfont[" << texmapping << "]{"
3292 if (fontsTypewriter() != "default") {
3293 string const mono = parseFontName(fontsTypewriter());
3294 if (fontsTypewriterScale() != 100)
3295 os << "\\setmonofont[Scale="
3296 << float(fontsTypewriterScale()) / 100
3300 os << "\\setmonofont{"
3307 bool const ot1 = (main_font_encoding() == "default" || main_font_encoding() == "OT1");
3308 bool const dryrun = features.runparams().dryrun;
3309 bool const complete = (fontsSans() == "default" && fontsTypewriter() == "default");
3310 bool const nomath = (fontsMath() == "default");
3313 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsRoman())).getLaTeXCode(
3314 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3318 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsSans())).getLaTeXCode(
3319 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3320 nomath, fontsSansScale());
3322 // MONOSPACED/TYPEWRITER
3323 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsTypewriter())).getLaTeXCode(
3324 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3325 nomath, fontsTypewriterScale());
3328 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsMath())).getLaTeXCode(
3329 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3336 Encoding const & BufferParams::encoding() const
3338 // Main encoding for LaTeX output.
3340 // Exception: XeTeX with 8-bit TeX fonts requires ASCII (see #9740).
3341 // As the "flavor" is only known once export started, this
3342 // cannot be handled here. Instead, runparams.encoding is set
3343 // to ASCII in Buffer::makeLaTeXFile (for export)
3344 // and Buffer::writeLaTeXSource (for preview).
3346 return *(encodings.fromLyXName("utf8-plain"));
3347 if (inputenc == "auto" || inputenc == "default")
3348 return *language->encoding();
3349 Encoding const * const enc = encodings.fromLyXName(inputenc);
3352 LYXERR0("Unknown inputenc value `" << inputenc
3353 << "'. Using `auto' instead.");
3354 return *language->encoding();
3358 bool BufferParams::addCiteEngine(string const & engine)
3360 LayoutModuleList::const_iterator it = cite_engine_.begin();
3361 LayoutModuleList::const_iterator en = cite_engine_.end();
3362 for (; it != en; ++it)
3365 cite_engine_.push_back(engine);
3370 bool BufferParams::addCiteEngine(vector<string> const & engine)
3372 vector<string>::const_iterator it = engine.begin();
3373 vector<string>::const_iterator en = engine.end();
3375 for (; it != en; ++it)
3376 if (!addCiteEngine(*it))
3382 string const & BufferParams::defaultBiblioStyle() const
3384 map<string, string> const & bs = documentClass().defaultBiblioStyle();
3385 auto cit = bs.find(theCiteEnginesList.getTypeAsString(citeEngineType()));
3386 if (cit != bs.end())
3389 return empty_string();
3393 bool const & BufferParams::fullAuthorList() const
3395 return documentClass().fullAuthorList();
3399 string BufferParams::getCiteAlias(string const & s) const
3401 vector<string> commands =
3402 documentClass().citeCommands(citeEngineType());
3403 // If it is a real command, don't treat it as an alias
3404 if (find(commands.begin(), commands.end(), s) != commands.end())
3406 map<string,string> aliases = documentClass().citeCommandAliases();
3407 if (aliases.find(s) != aliases.end())
3413 void BufferParams::setCiteEngine(string const & engine)
3416 addCiteEngine(engine);
3420 void BufferParams::setCiteEngine(vector<string> const & engine)
3423 addCiteEngine(engine);
3427 vector<string> BufferParams::citeCommands() const
3429 static CitationStyle const default_style;
3430 vector<string> commands =
3431 documentClass().citeCommands(citeEngineType());
3432 if (commands.empty())
3433 commands.push_back(default_style.name);
3438 vector<CitationStyle> BufferParams::citeStyles() const
3440 static CitationStyle const default_style;
3441 vector<CitationStyle> styles =
3442 documentClass().citeStyles(citeEngineType());
3444 styles.push_back(default_style);
3449 string const BufferParams::bibtexCommand() const
3451 // Return document-specific setting if available
3452 if (bibtex_command != "default")
3453 return bibtex_command;
3455 // If we have "default" in document settings, consult the prefs
3456 // 1. Japanese (uses a specific processor)
3457 if (encoding().package() == Encoding::japanese) {
3458 if (lyxrc.jbibtex_command != "automatic")
3459 // Return the specified program, if "automatic" is not set
3460 return lyxrc.jbibtex_command;
3461 else if (!useBiblatex()) {
3462 // With classic BibTeX, return pbibtex, jbibtex, bibtex
3463 if (lyxrc.jbibtex_alternatives.find("pbibtex") != lyxrc.jbibtex_alternatives.end())
3465 if (lyxrc.jbibtex_alternatives.find("jbibtex") != lyxrc.jbibtex_alternatives.end())
3470 // 2. All other languages
3471 else if (lyxrc.bibtex_command != "automatic")
3472 // Return the specified program, if "automatic" is not set
3473 return lyxrc.bibtex_command;
3475 // 3. Automatic: find the most suitable for the current cite framework
3476 if (useBiblatex()) {
3477 // For Biblatex, we prefer biber (also for Japanese)
3478 // and fall back to bibtex8 and, as last resort, bibtex
3479 if (lyxrc.bibtex_alternatives.find("biber") != lyxrc.bibtex_alternatives.end())
3481 else if (lyxrc.bibtex_alternatives.find("bibtex8") != lyxrc.bibtex_alternatives.end())
3488 bool BufferParams::useBiblatex() const
3490 return theCiteEnginesList[citeEngine().list().front()]
3491 ->getCiteFramework() == "biblatex";
3495 void BufferParams::invalidateConverterCache() const
3497 pimpl_->isExportCacheValid = false;
3498 pimpl_->isViewCacheValid = false;