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"
23 #include "buffer_funcs.h"
27 #include "Converter.h"
30 #include "IndicesList.h"
32 #include "LaTeXFeatures.h"
33 #include "LaTeXFonts.h"
34 #include "ModuleList.h"
38 #include "OutputParams.h"
42 #include "PDFOptions.h"
44 #include "frontends/alert.h"
46 #include "insets/InsetListingsParams.h"
48 #include "support/convert.h"
49 #include "support/debug.h"
50 #include "support/docstream.h"
51 #include "support/FileName.h"
52 #include "support/filetools.h"
53 #include "support/gettext.h"
54 #include "support/Messages.h"
55 #include "support/Translator.h"
56 #include "support/lstrings.h"
62 using namespace lyx::support;
65 static char const * const string_paragraph_separation[] = {
70 static char const * const string_quotes_language[] = {
71 "english", "swedish", "german", "polish", "french", "danish", ""
75 static char const * const string_papersize[] = {
76 "default", "custom", "letterpaper", "legalpaper", "executivepaper",
77 "a0paper", "a1paper", "a2paper", "a3paper", "a4paper", "a5paper",
78 "a6paper", "b0paper", "b1paper", "b2paper","b3paper", "b4paper",
79 "b5paper", "b6paper", "c0paper", "c1paper", "c2paper", "c3paper",
80 "c4paper", "c5paper", "c6paper", "b0j", "b1j", "b2j", "b3j", "b4j", "b5j",
85 static char const * const string_orientation[] = {
86 "portrait", "landscape", ""
90 static char const * const string_footnotekinds[] = {
91 "footnote", "margin", "fig", "tab", "alg", "wide-fig", "wide-tab", ""
95 static char const * const tex_graphics[] = {
96 "default", "dvialw", "dvilaser", "dvipdf", "dvipdfm", "dvipdfmx",
97 "dvips", "dvipsone", "dvitops", "dviwin", "dviwindo", "dvi2ps", "emtex",
98 "ln", "oztex", "pctexhp", "pctexps", "pctexwin", "pctex32", "pdftex",
99 "psprint", "pubps", "tcidvi", "textures", "truetex", "vtex", "xdvi",
110 // Paragraph separation
111 typedef Translator<string, BufferParams::ParagraphSeparation> ParSepTranslator;
114 ParSepTranslator const init_parseptranslator()
116 ParSepTranslator translator
117 (string_paragraph_separation[0], BufferParams::ParagraphIndentSeparation);
118 translator.addPair(string_paragraph_separation[1], BufferParams::ParagraphSkipSeparation);
123 ParSepTranslator const & parseptranslator()
125 static ParSepTranslator translator = init_parseptranslator();
131 typedef Translator<string, InsetQuotes::QuoteLanguage> QuotesLangTranslator;
134 QuotesLangTranslator const init_quoteslangtranslator()
136 QuotesLangTranslator translator
137 (string_quotes_language[0], InsetQuotes::EnglishQuotes);
138 translator.addPair(string_quotes_language[1], InsetQuotes::SwedishQuotes);
139 translator.addPair(string_quotes_language[2], InsetQuotes::GermanQuotes);
140 translator.addPair(string_quotes_language[3], InsetQuotes::PolishQuotes);
141 translator.addPair(string_quotes_language[4], InsetQuotes::FrenchQuotes);
142 translator.addPair(string_quotes_language[5], InsetQuotes::DanishQuotes);
147 QuotesLangTranslator const & quoteslangtranslator()
149 static QuotesLangTranslator translator = init_quoteslangtranslator();
155 typedef Translator<string, PAPER_SIZE> PaperSizeTranslator;
158 static PaperSizeTranslator initPaperSizeTranslator()
160 PaperSizeTranslator translator(string_papersize[0], PAPER_DEFAULT);
161 translator.addPair(string_papersize[1], PAPER_CUSTOM);
162 translator.addPair(string_papersize[2], PAPER_USLETTER);
163 translator.addPair(string_papersize[3], PAPER_USLEGAL);
164 translator.addPair(string_papersize[4], PAPER_USEXECUTIVE);
165 translator.addPair(string_papersize[5], PAPER_A0);
166 translator.addPair(string_papersize[6], PAPER_A1);
167 translator.addPair(string_papersize[7], PAPER_A2);
168 translator.addPair(string_papersize[8], PAPER_A3);
169 translator.addPair(string_papersize[9], PAPER_A4);
170 translator.addPair(string_papersize[10], PAPER_A5);
171 translator.addPair(string_papersize[11], PAPER_A6);
172 translator.addPair(string_papersize[12], PAPER_B0);
173 translator.addPair(string_papersize[13], PAPER_B1);
174 translator.addPair(string_papersize[14], PAPER_B2);
175 translator.addPair(string_papersize[15], PAPER_B3);
176 translator.addPair(string_papersize[16], PAPER_B4);
177 translator.addPair(string_papersize[17], PAPER_B5);
178 translator.addPair(string_papersize[18], PAPER_B6);
179 translator.addPair(string_papersize[19], PAPER_C0);
180 translator.addPair(string_papersize[20], PAPER_C1);
181 translator.addPair(string_papersize[21], PAPER_C2);
182 translator.addPair(string_papersize[22], PAPER_C3);
183 translator.addPair(string_papersize[23], PAPER_C4);
184 translator.addPair(string_papersize[24], PAPER_C5);
185 translator.addPair(string_papersize[25], PAPER_C6);
186 translator.addPair(string_papersize[26], PAPER_JISB0);
187 translator.addPair(string_papersize[27], PAPER_JISB1);
188 translator.addPair(string_papersize[28], PAPER_JISB2);
189 translator.addPair(string_papersize[29], PAPER_JISB3);
190 translator.addPair(string_papersize[30], PAPER_JISB4);
191 translator.addPair(string_papersize[31], PAPER_JISB5);
192 translator.addPair(string_papersize[32], PAPER_JISB6);
197 PaperSizeTranslator const & papersizetranslator()
199 static PaperSizeTranslator translator = initPaperSizeTranslator();
205 typedef Translator<string, PAPER_ORIENTATION> PaperOrientationTranslator;
208 PaperOrientationTranslator const init_paperorientationtranslator()
210 PaperOrientationTranslator translator(string_orientation[0], ORIENTATION_PORTRAIT);
211 translator.addPair(string_orientation[1], ORIENTATION_LANDSCAPE);
216 PaperOrientationTranslator const & paperorientationtranslator()
218 static PaperOrientationTranslator translator = init_paperorientationtranslator();
224 typedef Translator<int, PageSides> SidesTranslator;
227 SidesTranslator const init_sidestranslator()
229 SidesTranslator translator(1, OneSide);
230 translator.addPair(2, TwoSides);
235 SidesTranslator const & sidestranslator()
237 static SidesTranslator translator = init_sidestranslator();
243 typedef Translator<int, BufferParams::Package> PackageTranslator;
246 PackageTranslator const init_packagetranslator()
248 PackageTranslator translator(0, BufferParams::package_off);
249 translator.addPair(1, BufferParams::package_auto);
250 translator.addPair(2, BufferParams::package_on);
255 PackageTranslator const & packagetranslator()
257 static PackageTranslator translator = init_packagetranslator();
263 typedef Translator<string, CiteEngineType> CiteEngineTypeTranslator;
266 CiteEngineTypeTranslator const init_citeenginetypetranslator()
268 CiteEngineTypeTranslator translator("authoryear", ENGINE_TYPE_AUTHORYEAR);
269 translator.addPair("numerical", ENGINE_TYPE_NUMERICAL);
270 translator.addPair("default", ENGINE_TYPE_DEFAULT);
275 CiteEngineTypeTranslator const & citeenginetypetranslator()
277 static CiteEngineTypeTranslator translator = init_citeenginetypetranslator();
283 typedef Translator<string, Spacing::Space> SpaceTranslator;
286 SpaceTranslator const init_spacetranslator()
288 SpaceTranslator translator("default", Spacing::Default);
289 translator.addPair("single", Spacing::Single);
290 translator.addPair("onehalf", Spacing::Onehalf);
291 translator.addPair("double", Spacing::Double);
292 translator.addPair("other", Spacing::Other);
297 SpaceTranslator const & spacetranslator()
299 static SpaceTranslator translator = init_spacetranslator();
306 class BufferParams::Impl
311 AuthorList authorlist;
312 BranchList branchlist;
313 Bullet temp_bullets[4];
314 Bullet user_defined_bullets[4];
315 IndicesList indiceslist;
317 /** This is the amount of space used for paragraph_separation "skip",
318 * and for detached paragraphs in "indented" documents.
322 PDFOptions pdfoptions;
323 LayoutFileIndex baseClass_;
327 BufferParams::Impl::Impl()
328 : defskip(VSpace::MEDSKIP), baseClass_(string(""))
330 // set initial author
332 authorlist.record(Author(from_utf8(lyxrc.user_name), from_utf8(lyxrc.user_email)));
337 BufferParams::MemoryTraits::clone(BufferParams::Impl const * ptr)
340 return new BufferParams::Impl(*ptr);
344 void BufferParams::MemoryTraits::destroy(BufferParams::Impl * ptr)
350 BufferParams::BufferParams()
353 setBaseClass(defaultBaseclass());
355 paragraph_separation = ParagraphIndentSeparation;
356 quotes_language = InsetQuotes::EnglishQuotes;
357 fontsize = "default";
360 papersize = PAPER_DEFAULT;
361 orientation = ORIENTATION_PORTRAIT;
362 use_geometry = false;
363 cite_engine_.push_back("basic");
364 cite_engine_type_ = ENGINE_TYPE_DEFAULT;
365 biblio_style = "plain";
366 use_bibtopic = false;
368 trackChanges = false;
369 outputChanges = false;
370 use_default_options = true;
371 maintain_unincluded_children = false;
374 language = default_language;
376 fonts_roman = "default";
377 fonts_sans = "default";
378 fonts_typewriter = "default";
380 fonts_default_family = "default";
381 useNonTeXFonts = false;
382 fonts_expert_sc = false;
383 fonts_old_figures = false;
384 fonts_sans_scale = 100;
385 fonts_typewriter_scale = 100;
387 lang_package = "default";
388 graphics_driver = "default";
389 default_output_format = "default";
390 bibtex_command = "default";
391 index_command = "default";
394 listings_params = string();
395 pagestyle = "default";
396 suppress_date = false;
397 justification = true;
398 // no color is the default (white)
399 backgroundcolor = lyx::rgbFromHexName("#ffffff");
400 isbackgroundcolor = false;
401 // no color is the default (black)
402 fontcolor = lyx::rgbFromHexName("#000000");
404 // light gray is the default font color for greyed-out notes
405 notefontcolor = lyx::rgbFromHexName("#cccccc");
406 boxbgcolor = lyx::rgbFromHexName("#ff0000");
407 compressed = lyxrc.save_compressed;
408 for (int iter = 0; iter < 4; ++iter) {
409 user_defined_bullet(iter) = ITEMIZE_DEFAULTS[iter];
410 temp_bullet(iter) = ITEMIZE_DEFAULTS[iter];
413 indiceslist().addDefault(B_("Index"));
414 html_be_strict = false;
415 html_math_output = MathML;
416 html_math_img_scale = 1.0;
417 html_css_as_file = false;
424 docstring BufferParams::B_(string const & l10n) const
426 LASSERT(language, return from_utf8(l10n));
427 return getMessages(language->code()).get(l10n);
431 BufferParams::Package BufferParams::use_package(std::string const & p) const
433 PackageMap::const_iterator it = use_packages.find(p);
434 if (it == use_packages.end())
440 void BufferParams::use_package(std::string const & p, BufferParams::Package u)
446 map<string, string> const & BufferParams::auto_packages()
448 static map<string, string> packages;
449 if (packages.empty()) {
450 // adding a package here implies a file format change!
451 packages["amsmath"] =
452 N_("The LaTeX package amsmath is only used if AMS formula types or symbols from the AMS math toolbars are inserted into formulas");
453 packages["amssymb"] =
454 N_("The LaTeX package amssymb is only used if symbols from the AMS math toolbars are inserted into formulas");
456 N_("The LaTeX package cancel is only used if \\cancel commands are used in formulas");
458 N_("The LaTeX package esint is only used if special integral symbols are inserted into formulas");
459 packages["mathdots"] =
460 N_("The LaTeX package mathdots is only used if the command \\iddots is inserted into formulas");
461 packages["mathtools"] =
462 N_("The LaTeX package mathtools is only used if some mathematical relations are inserted into formulas");
464 N_("The LaTeX package mhchem is only used if either the command \\ce or \\cf is inserted into formulas");
465 packages["stackrel"] =
466 N_("The LaTeX package stackrel is only used if the command \\stackrel with subscript is inserted into formulas");
467 packages["stmaryrd"] =
468 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");
469 packages["undertilde"] =
470 N_("The LaTeX package undertilde is only used if you use the math frame decoration 'utilde'");
476 AuthorList & BufferParams::authors()
478 return pimpl_->authorlist;
482 AuthorList const & BufferParams::authors() const
484 return pimpl_->authorlist;
488 BranchList & BufferParams::branchlist()
490 return pimpl_->branchlist;
494 BranchList const & BufferParams::branchlist() const
496 return pimpl_->branchlist;
500 IndicesList & BufferParams::indiceslist()
502 return pimpl_->indiceslist;
506 IndicesList const & BufferParams::indiceslist() const
508 return pimpl_->indiceslist;
512 Bullet & BufferParams::temp_bullet(lyx::size_type const index)
514 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
515 return pimpl_->temp_bullets[index];
519 Bullet const & BufferParams::temp_bullet(lyx::size_type const index) const
521 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
522 return pimpl_->temp_bullets[index];
526 Bullet & BufferParams::user_defined_bullet(lyx::size_type const index)
528 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
529 return pimpl_->user_defined_bullets[index];
533 Bullet const & BufferParams::user_defined_bullet(lyx::size_type const index) const
535 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
536 return pimpl_->user_defined_bullets[index];
540 Spacing & BufferParams::spacing()
542 return pimpl_->spacing;
546 Spacing const & BufferParams::spacing() const
548 return pimpl_->spacing;
552 PDFOptions & BufferParams::pdfoptions()
554 return pimpl_->pdfoptions;
558 PDFOptions const & BufferParams::pdfoptions() const
560 return pimpl_->pdfoptions;
564 HSpace const & BufferParams::getIndentation() const
566 return pimpl_->indentation;
570 void BufferParams::setIndentation(HSpace const & indent)
572 pimpl_->indentation = indent;
576 VSpace const & BufferParams::getDefSkip() const
578 return pimpl_->defskip;
582 void BufferParams::setDefSkip(VSpace const & vs)
584 // DEFSKIP will cause an infinite loop
585 LASSERT(vs.kind() != VSpace::DEFSKIP, return);
586 pimpl_->defskip = vs;
590 string BufferParams::readToken(Lexer & lex, string const & token,
591 FileName const & filepath)
593 if (token == "\\textclass") {
595 string const classname = lex.getString();
596 // if there exists a local layout file, ignore the system one
597 // NOTE: in this case, the textclass (.cls file) is assumed to
600 LayoutFileList & bcl = LayoutFileList::get();
601 if (!filepath.empty())
602 tcp = bcl.addLocalLayout(classname, filepath.absFileName());
603 // that returns non-empty if a "local" layout file is found.
607 setBaseClass(classname);
608 // We assume that a tex class exists for local or unknown
609 // layouts so this warning, will only be given for system layouts.
610 if (!baseClass()->isTeXClassAvailable()) {
611 docstring const desc =
612 translateIfPossible(from_utf8(baseClass()->description()));
613 docstring const prereqs =
614 from_utf8(baseClass()->prerequisites());
615 docstring const msg =
616 bformat(_("The selected document class\n"
618 "requires external files that are not available.\n"
619 "The document class can still be used, but the\n"
620 "document cannot be compiled until the following\n"
621 "prerequisites are installed:\n"
623 "See section 3.1.2.2 (Class Availability) of the\n"
624 "User's Guide for more information."), desc, prereqs);
625 frontend::Alert::warning(_("Document class not available"),
628 } else if (token == "\\begin_preamble") {
630 } else if (token == "\\begin_local_layout") {
631 readLocalLayout(lex, false);
632 } else if (token == "\\begin_forced_local_layout") {
633 readLocalLayout(lex, true);
634 } else if (token == "\\begin_modules") {
636 } else if (token == "\\begin_removed_modules") {
637 readRemovedModules(lex);
638 } else if (token == "\\begin_includeonly") {
639 readIncludeonly(lex);
640 } else if (token == "\\maintain_unincluded_children") {
641 lex >> maintain_unincluded_children;
642 } else if (token == "\\options") {
644 options = lex.getString();
645 } else if (token == "\\use_default_options") {
646 lex >> use_default_options;
647 } else if (token == "\\master") {
649 master = lex.getString();
650 } else if (token == "\\suppress_date") {
651 lex >> suppress_date;
652 } else if (token == "\\justification") {
653 lex >> justification;
654 } else if (token == "\\language") {
656 } else if (token == "\\language_package") {
658 lang_package = lex.getString();
659 } else if (token == "\\inputencoding") {
661 } else if (token == "\\graphics") {
662 readGraphicsDriver(lex);
663 } else if (token == "\\default_output_format") {
664 lex >> default_output_format;
665 } else if (token == "\\bibtex_command") {
667 bibtex_command = lex.getString();
668 } else if (token == "\\index_command") {
670 index_command = lex.getString();
671 } else if (token == "\\fontencoding") {
673 fontenc = lex.getString();
674 } else if (token == "\\font_roman") {
676 fonts_roman = lex.getString();
677 } else if (token == "\\font_sans") {
679 fonts_sans = lex.getString();
680 } else if (token == "\\font_typewriter") {
682 fonts_typewriter = lex.getString();
683 } else if (token == "\\font_math") {
685 fonts_math = lex.getString();
686 } else if (token == "\\font_default_family") {
687 lex >> fonts_default_family;
688 } else if (token == "\\use_non_tex_fonts") {
689 lex >> useNonTeXFonts;
690 } else if (token == "\\font_sc") {
691 lex >> fonts_expert_sc;
692 } else if (token == "\\font_osf") {
693 lex >> fonts_old_figures;
694 } else if (token == "\\font_sf_scale") {
695 lex >> fonts_sans_scale;
696 } else if (token == "\\font_tt_scale") {
697 lex >> fonts_typewriter_scale;
698 } else if (token == "\\font_cjk") {
700 } else if (token == "\\paragraph_separation") {
703 paragraph_separation = parseptranslator().find(parsep);
704 } else if (token == "\\paragraph_indentation") {
706 string indentation = lex.getString();
707 pimpl_->indentation = HSpace(indentation);
708 } else if (token == "\\defskip") {
710 string const defskip = lex.getString();
711 pimpl_->defskip = VSpace(defskip);
712 if (pimpl_->defskip.kind() == VSpace::DEFSKIP)
714 pimpl_->defskip = VSpace(VSpace::MEDSKIP);
715 } else if (token == "\\quotes_language") {
718 quotes_language = quoteslangtranslator().find(quotes_lang);
719 } else if (token == "\\papersize") {
722 papersize = papersizetranslator().find(ppsize);
723 } else if (token == "\\use_geometry") {
725 } else if (token == "\\use_package") {
730 use_package(package, packagetranslator().find(use));
731 } else if (token == "\\cite_engine") {
733 vector<string> engine = getVectorFromString(lex.getString());
734 setCiteEngine(engine);
735 } else if (token == "\\cite_engine_type") {
738 cite_engine_type_ = citeenginetypetranslator().find(engine_type);
739 } else if (token == "\\biblio_style") {
741 biblio_style = lex.getString();
742 } else if (token == "\\use_bibtopic") {
744 } else if (token == "\\use_indices") {
746 } else if (token == "\\tracking_changes") {
748 } else if (token == "\\output_changes") {
749 lex >> outputChanges;
750 } else if (token == "\\branch") {
752 docstring branch = lex.getDocString();
753 branchlist().add(branch);
756 string const tok = lex.getString();
757 if (tok == "\\end_branch")
759 Branch * branch_ptr = branchlist().find(branch);
760 if (tok == "\\selected") {
763 branch_ptr->setSelected(lex.getInteger());
765 if (tok == "\\filename_suffix") {
768 branch_ptr->setFileNameSuffix(lex.getInteger());
770 if (tok == "\\color") {
772 string color = lex.getString();
774 branch_ptr->setColor(color);
775 // Update also the Color table:
777 color = lcolor.getX11Name(Color_background);
779 lcolor.setColor(to_utf8(branch), color);
782 } else if (token == "\\index") {
784 docstring index = lex.getDocString();
786 indiceslist().add(index);
789 string const tok = lex.getString();
790 if (tok == "\\end_index")
792 Index * index_ptr = indiceslist().find(index);
793 if (tok == "\\shortcut") {
795 shortcut = lex.getDocString();
797 index_ptr->setShortcut(shortcut);
799 if (tok == "\\color") {
801 string color = lex.getString();
803 index_ptr->setColor(color);
804 // Update also the Color table:
806 color = lcolor.getX11Name(Color_background);
808 if (!shortcut.empty())
809 lcolor.setColor(to_utf8(shortcut), color);
812 } else if (token == "\\author") {
814 istringstream ss(lex.getString());
817 author_map[a.bufferId()] = pimpl_->authorlist.record(a);
818 } else if (token == "\\paperorientation") {
821 orientation = paperorientationtranslator().find(orient);
822 } else if (token == "\\backgroundcolor") {
824 backgroundcolor = lyx::rgbFromHexName(lex.getString());
825 isbackgroundcolor = true;
826 } else if (token == "\\fontcolor") {
828 fontcolor = lyx::rgbFromHexName(lex.getString());
830 } else if (token == "\\notefontcolor") {
832 string color = lex.getString();
833 notefontcolor = lyx::rgbFromHexName(color);
834 lcolor.setColor("notefontcolor", color);
835 } else if (token == "\\boxbgcolor") {
837 string color = lex.getString();
838 boxbgcolor = lyx::rgbFromHexName(color);
839 lcolor.setColor("boxbgcolor", color);
840 } else if (token == "\\paperwidth") {
842 } else if (token == "\\paperheight") {
844 } else if (token == "\\leftmargin") {
846 } else if (token == "\\topmargin") {
848 } else if (token == "\\rightmargin") {
850 } else if (token == "\\bottommargin") {
852 } else if (token == "\\headheight") {
854 } else if (token == "\\headsep") {
856 } else if (token == "\\footskip") {
858 } else if (token == "\\columnsep") {
860 } else if (token == "\\paperfontsize") {
862 } else if (token == "\\papercolumns") {
864 } else if (token == "\\listings_params") {
867 listings_params = InsetListingsParams(par).params();
868 } else if (token == "\\papersides") {
871 sides = sidestranslator().find(psides);
872 } else if (token == "\\paperpagestyle") {
874 } else if (token == "\\bullet") {
876 } else if (token == "\\bulletLaTeX") {
877 readBulletsLaTeX(lex);
878 } else if (token == "\\secnumdepth") {
880 } else if (token == "\\tocdepth") {
882 } else if (token == "\\spacing") {
886 if (nspacing == "other") {
889 spacing().set(spacetranslator().find(nspacing), tmp_val);
890 } else if (token == "\\float_placement") {
891 lex >> float_placement;
893 } else if (prefixIs(token, "\\pdf_") || token == "\\use_hyperref") {
894 string toktmp = pdfoptions().readToken(lex, token);
895 if (!toktmp.empty()) {
896 lyxerr << "PDFOptions::readToken(): Unknown token: " <<
900 } else if (token == "\\html_math_output") {
903 html_math_output = static_cast<MathOutput>(temp);
904 } else if (token == "\\html_be_strict") {
905 lex >> html_be_strict;
906 } else if (token == "\\html_css_as_file") {
907 lex >> html_css_as_file;
908 } else if (token == "\\html_math_img_scale") {
909 lex >> html_math_img_scale;
910 } else if (token == "\\html_latex_start") {
912 html_latex_start = lex.getString();
913 } else if (token == "\\html_latex_end") {
915 html_latex_end = lex.getString();
916 } else if (token == "\\output_sync") {
918 } else if (token == "\\output_sync_macro") {
919 lex >> output_sync_macro;
920 } else if (token == "\\use_refstyle") {
923 lyxerr << "BufferParams::readToken(): Unknown token: " <<
932 void BufferParams::writeFile(ostream & os) const
934 // The top of the file is written by the buffer.
935 // Prints out the buffer info into the .lyx file given by file
938 os << "\\textclass " << baseClass()->name() << '\n';
941 if (!preamble.empty()) {
942 // remove '\n' from the end of preamble
943 string const tmppreamble = rtrim(preamble, "\n");
944 os << "\\begin_preamble\n"
946 << "\n\\end_preamble\n";
950 if (!options.empty()) {
951 os << "\\options " << options << '\n';
954 // use the class options defined in the layout?
955 os << "\\use_default_options "
956 << convert<string>(use_default_options) << "\n";
958 // the master document
959 if (!master.empty()) {
960 os << "\\master " << master << '\n';
964 if (!removed_modules_.empty()) {
965 os << "\\begin_removed_modules" << '\n';
966 list<string>::const_iterator it = removed_modules_.begin();
967 list<string>::const_iterator en = removed_modules_.end();
968 for (; it != en; ++it)
970 os << "\\end_removed_modules" << '\n';
974 if (!layout_modules_.empty()) {
975 os << "\\begin_modules" << '\n';
976 LayoutModuleList::const_iterator it = layout_modules_.begin();
977 LayoutModuleList::const_iterator en = layout_modules_.end();
978 for (; it != en; ++it)
980 os << "\\end_modules" << '\n';
984 if (!included_children_.empty()) {
985 os << "\\begin_includeonly" << '\n';
986 list<string>::const_iterator it = included_children_.begin();
987 list<string>::const_iterator en = included_children_.end();
988 for (; it != en; ++it)
990 os << "\\end_includeonly" << '\n';
992 os << "\\maintain_unincluded_children "
993 << convert<string>(maintain_unincluded_children) << '\n';
995 // local layout information
996 string const local_layout = getLocalLayout(false);
997 if (!local_layout.empty()) {
998 // remove '\n' from the end
999 string const tmplocal = rtrim(local_layout, "\n");
1000 os << "\\begin_local_layout\n"
1002 << "\n\\end_local_layout\n";
1004 string const forced_local_layout = getLocalLayout(true);
1005 if (!forced_local_layout.empty()) {
1006 // remove '\n' from the end
1007 string const tmplocal = rtrim(forced_local_layout, "\n");
1008 os << "\\begin_forced_local_layout\n"
1010 << "\n\\end_forced_local_layout\n";
1013 // then the text parameters
1014 if (language != ignore_language)
1015 os << "\\language " << language->lang() << '\n';
1016 os << "\\language_package " << lang_package
1017 << "\n\\inputencoding " << inputenc
1018 << "\n\\fontencoding " << fontenc
1019 << "\n\\font_roman " << fonts_roman
1020 << "\n\\font_sans " << fonts_sans
1021 << "\n\\font_typewriter " << fonts_typewriter
1022 << "\n\\font_math " << fonts_math
1023 << "\n\\font_default_family " << fonts_default_family
1024 << "\n\\use_non_tex_fonts " << convert<string>(useNonTeXFonts)
1025 << "\n\\font_sc " << convert<string>(fonts_expert_sc)
1026 << "\n\\font_osf " << convert<string>(fonts_old_figures)
1027 << "\n\\font_sf_scale " << fonts_sans_scale
1028 << "\n\\font_tt_scale " << fonts_typewriter_scale
1030 if (!fonts_cjk.empty()) {
1031 os << "\\font_cjk " << fonts_cjk << '\n';
1033 os << "\\graphics " << graphics_driver << '\n';
1034 os << "\\default_output_format " << default_output_format << '\n';
1035 os << "\\output_sync " << output_sync << '\n';
1036 if (!output_sync_macro.empty())
1037 os << "\\output_sync_macro \"" << output_sync_macro << "\"\n";
1038 os << "\\bibtex_command " << bibtex_command << '\n';
1039 os << "\\index_command " << index_command << '\n';
1041 if (!float_placement.empty()) {
1042 os << "\\float_placement " << float_placement << '\n';
1044 os << "\\paperfontsize " << fontsize << '\n';
1046 spacing().writeFile(os);
1047 pdfoptions().writeFile(os);
1049 os << "\\papersize " << string_papersize[papersize]
1050 << "\n\\use_geometry " << convert<string>(use_geometry);
1051 map<string, string> const & packages = auto_packages();
1052 for (map<string, string>::const_iterator it = packages.begin();
1053 it != packages.end(); ++it)
1054 os << "\n\\use_package " << it->first << ' '
1055 << use_package(it->first);
1057 os << "\n\\cite_engine ";
1059 if (!cite_engine_.empty()) {
1060 LayoutModuleList::const_iterator be = cite_engine_.begin();
1061 LayoutModuleList::const_iterator en = cite_engine_.end();
1062 for (LayoutModuleList::const_iterator it = be; it != en; ++it) {
1071 os << "\n\\cite_engine_type " << citeenginetypetranslator().find(cite_engine_type_)
1072 << "\n\\biblio_style " << biblio_style
1073 << "\n\\use_bibtopic " << convert<string>(use_bibtopic)
1074 << "\n\\use_indices " << convert<string>(use_indices)
1075 << "\n\\paperorientation " << string_orientation[orientation]
1076 << "\n\\suppress_date " << convert<string>(suppress_date)
1077 << "\n\\justification " << convert<string>(justification)
1078 << "\n\\use_refstyle " << use_refstyle
1080 if (isbackgroundcolor == true)
1081 os << "\\backgroundcolor " << lyx::X11hexname(backgroundcolor) << '\n';
1082 if (isfontcolor == true)
1083 os << "\\fontcolor " << lyx::X11hexname(fontcolor) << '\n';
1084 if (notefontcolor != lyx::rgbFromHexName("#cccccc"))
1085 os << "\\notefontcolor " << lyx::X11hexname(notefontcolor) << '\n';
1086 if (boxbgcolor != lyx::rgbFromHexName("#ff0000"))
1087 os << "\\boxbgcolor " << lyx::X11hexname(boxbgcolor) << '\n';
1089 BranchList::const_iterator it = branchlist().begin();
1090 BranchList::const_iterator end = branchlist().end();
1091 for (; it != end; ++it) {
1092 os << "\\branch " << to_utf8(it->branch())
1093 << "\n\\selected " << it->isSelected()
1094 << "\n\\filename_suffix " << it->hasFileNameSuffix()
1095 << "\n\\color " << lyx::X11hexname(it->color())
1100 IndicesList::const_iterator iit = indiceslist().begin();
1101 IndicesList::const_iterator iend = indiceslist().end();
1102 for (; iit != iend; ++iit) {
1103 os << "\\index " << to_utf8(iit->index())
1104 << "\n\\shortcut " << to_utf8(iit->shortcut())
1105 << "\n\\color " << lyx::X11hexname(iit->color())
1110 if (!paperwidth.empty())
1111 os << "\\paperwidth "
1112 << VSpace(paperwidth).asLyXCommand() << '\n';
1113 if (!paperheight.empty())
1114 os << "\\paperheight "
1115 << VSpace(paperheight).asLyXCommand() << '\n';
1116 if (!leftmargin.empty())
1117 os << "\\leftmargin "
1118 << VSpace(leftmargin).asLyXCommand() << '\n';
1119 if (!topmargin.empty())
1120 os << "\\topmargin "
1121 << VSpace(topmargin).asLyXCommand() << '\n';
1122 if (!rightmargin.empty())
1123 os << "\\rightmargin "
1124 << VSpace(rightmargin).asLyXCommand() << '\n';
1125 if (!bottommargin.empty())
1126 os << "\\bottommargin "
1127 << VSpace(bottommargin).asLyXCommand() << '\n';
1128 if (!headheight.empty())
1129 os << "\\headheight "
1130 << VSpace(headheight).asLyXCommand() << '\n';
1131 if (!headsep.empty())
1133 << VSpace(headsep).asLyXCommand() << '\n';
1134 if (!footskip.empty())
1136 << VSpace(footskip).asLyXCommand() << '\n';
1137 if (!columnsep.empty())
1138 os << "\\columnsep "
1139 << VSpace(columnsep).asLyXCommand() << '\n';
1140 os << "\\secnumdepth " << secnumdepth
1141 << "\n\\tocdepth " << tocdepth
1142 << "\n\\paragraph_separation "
1143 << string_paragraph_separation[paragraph_separation];
1144 if (!paragraph_separation)
1145 os << "\n\\paragraph_indentation " << getIndentation().asLyXCommand();
1147 os << "\n\\defskip " << getDefSkip().asLyXCommand();
1148 os << "\n\\quotes_language "
1149 << string_quotes_language[quotes_language]
1150 << "\n\\papercolumns " << columns
1151 << "\n\\papersides " << sides
1152 << "\n\\paperpagestyle " << pagestyle << '\n';
1153 if (!listings_params.empty())
1154 os << "\\listings_params \"" <<
1155 InsetListingsParams(listings_params).encodedString() << "\"\n";
1156 for (int i = 0; i < 4; ++i) {
1157 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1158 if (user_defined_bullet(i).getFont() != -1) {
1159 os << "\\bullet " << i << " "
1160 << user_defined_bullet(i).getFont() << " "
1161 << user_defined_bullet(i).getCharacter() << " "
1162 << user_defined_bullet(i).getSize() << "\n";
1166 os << "\\bulletLaTeX " << i << " \""
1167 << lyx::to_ascii(user_defined_bullet(i).getText())
1173 os << "\\tracking_changes " << convert<string>(trackChanges) << '\n'
1174 << "\\output_changes " << convert<string>(outputChanges) << '\n'
1175 << "\\html_math_output " << html_math_output << '\n'
1176 << "\\html_css_as_file " << html_css_as_file << '\n'
1177 << "\\html_be_strict " << convert<string>(html_be_strict) << '\n';
1179 if (html_math_img_scale != 1.0)
1180 os << "\\html_math_img_scale " << convert<string>(html_math_img_scale) << '\n';
1181 if (!html_latex_start.empty())
1182 os << "\\html_latex_start " << html_latex_start << '\n';
1183 if (!html_latex_end.empty())
1184 os << "\\html_latex_end " << html_latex_end << '\n';
1186 os << pimpl_->authorlist;
1190 void BufferParams::validate(LaTeXFeatures & features) const
1192 features.require(documentClass().requires());
1194 if (columns > 1 && language->rightToLeft())
1195 features.require("rtloutputdblcol");
1197 if (outputChanges) {
1198 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1199 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1200 LaTeXFeatures::isAvailable("xcolor");
1202 switch (features.runparams().flavor) {
1203 case OutputParams::LATEX:
1204 case OutputParams::DVILUATEX:
1206 features.require("ct-dvipost");
1207 features.require("dvipost");
1208 } else if (xcolorulem) {
1209 features.require("ct-xcolor-ulem");
1210 features.require("ulem");
1211 features.require("xcolor");
1213 features.require("ct-none");
1216 case OutputParams::LUATEX:
1217 case OutputParams::PDFLATEX:
1218 case OutputParams::XETEX:
1220 features.require("ct-xcolor-ulem");
1221 features.require("ulem");
1222 features.require("xcolor");
1223 // improves color handling in PDF output
1224 features.require("pdfcolmk");
1226 features.require("ct-none");
1234 // Floats with 'Here definitely' as default setting.
1235 if (float_placement.find('H') != string::npos)
1236 features.require("float");
1238 for (PackageMap::const_iterator it = use_packages.begin();
1239 it != use_packages.end(); ++it) {
1240 if (it->first == "amsmath") {
1241 // AMS Style is at document level
1242 if (it->second == package_on ||
1243 features.isProvided("amsmath"))
1244 features.require(it->first);
1245 } else if (it->second == package_on)
1246 features.require(it->first);
1249 // Document-level line spacing
1250 if (spacing().getSpace() != Spacing::Single && !spacing().isDefault())
1251 features.require("setspace");
1253 // the bullet shapes are buffer level not paragraph level
1254 // so they are tested here
1255 for (int i = 0; i < 4; ++i) {
1256 if (user_defined_bullet(i) == ITEMIZE_DEFAULTS[i])
1258 int const font = user_defined_bullet(i).getFont();
1260 int const c = user_defined_bullet(i).getCharacter();
1266 features.require("latexsym");
1268 } else if (font == 1) {
1269 features.require("amssymb");
1270 } else if (font >= 2 && font <= 5) {
1271 features.require("pifont");
1275 if (pdfoptions().use_hyperref) {
1276 features.require("hyperref");
1277 // due to interferences with babel and hyperref, the color package has to
1278 // be loaded after hyperref when hyperref is used with the colorlinks
1279 // option, see http://www.lyx.org/trac/ticket/5291
1280 if (pdfoptions().colorlinks)
1281 features.require("color");
1284 // some languages are only available via polyglossia
1285 if (features.runparams().flavor == OutputParams::XETEX
1286 && (features.hasPolyglossiaExclusiveLanguages()
1288 features.require("polyglossia");
1290 if (useNonTeXFonts && fonts_math != "auto")
1291 features.require("unicode-math");
1293 if (!language->requires().empty())
1294 features.require(language->requires());
1298 bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
1299 FileName const & filepath) const
1301 // http://www.tug.org/texmf-dist/doc/latex/base/fixltx2e.pdf
1302 // !! To use the Fix-cm package, load it before \documentclass, and use the command
1303 // \RequirePackage to do so, rather than the normal \usepackage
1304 // Do not try to load any other package before the document class, unless you
1305 // have a thorough understanding of the LATEX internals and know exactly what you
1307 if (features.mustProvide("fix-cm"))
1308 os << "\\RequirePackage{fix-cm}\n";
1310 os << "\\documentclass";
1312 DocumentClass const & tclass = documentClass();
1314 ostringstream clsoptions; // the document class options.
1316 if (tokenPos(tclass.opt_fontsize(),
1317 '|', fontsize) >= 0) {
1318 // only write if existing in list (and not default)
1319 clsoptions << fontsize << "pt,";
1322 // all paper sizes except of A4, A5, B5 and the US sizes need the
1324 bool nonstandard_papersize = papersize != PAPER_DEFAULT
1325 && papersize != PAPER_USLETTER
1326 && papersize != PAPER_USLEGAL
1327 && papersize != PAPER_USEXECUTIVE
1328 && papersize != PAPER_A4
1329 && papersize != PAPER_A5
1330 && papersize != PAPER_B5;
1332 if (!use_geometry) {
1333 switch (papersize) {
1335 clsoptions << "a4paper,";
1337 case PAPER_USLETTER:
1338 clsoptions << "letterpaper,";
1341 clsoptions << "a5paper,";
1344 clsoptions << "b5paper,";
1346 case PAPER_USEXECUTIVE:
1347 clsoptions << "executivepaper,";
1350 clsoptions << "legalpaper,";
1384 if (sides != tclass.sides()) {
1387 clsoptions << "oneside,";
1390 clsoptions << "twoside,";
1396 if (columns != tclass.columns()) {
1398 clsoptions << "twocolumn,";
1400 clsoptions << "onecolumn,";
1404 && orientation == ORIENTATION_LANDSCAPE)
1405 clsoptions << "landscape,";
1407 // language should be a parameter to \documentclass
1408 if (language->babel() == "hebrew"
1409 && default_language->babel() != "hebrew")
1410 // This seems necessary
1411 features.useLanguage(default_language);
1413 ostringstream language_options;
1414 bool const use_babel = features.useBabel() && !features.isProvided("babel");
1415 bool const use_polyglossia = features.usePolyglossia();
1416 bool const global = lyxrc.language_global_options;
1417 if (use_babel || (use_polyglossia && global)) {
1418 language_options << features.getBabelLanguages();
1419 if (!language->babel().empty()) {
1420 if (!language_options.str().empty())
1421 language_options << ',';
1422 language_options << language->babel();
1424 if (global && !features.needBabelLangOptions()
1425 && !language_options.str().empty())
1426 clsoptions << language_options.str() << ',';
1429 // the predefined options from the layout
1430 if (use_default_options && !tclass.options().empty())
1431 clsoptions << tclass.options() << ',';
1433 // the user-defined options
1434 if (!options.empty()) {
1435 clsoptions << options << ',';
1438 string strOptions(clsoptions.str());
1439 if (!strOptions.empty()) {
1440 strOptions = rtrim(strOptions, ",");
1442 os << '[' << from_utf8(strOptions) << ']';
1445 os << '{' << from_ascii(tclass.latexname()) << "}\n";
1446 // end of \documentclass defs
1448 // if we use fontspec or newtxmath, we have to load the AMS packages here
1449 string const ams = features.loadAMSPackages();
1450 bool const ot1 = (font_encoding() == "default" || font_encoding() == "OT1");
1451 bool const use_newtxmath =
1452 theLaTeXFonts().getLaTeXFont(from_ascii(fonts_math)).getUsedPackage(
1453 ot1, false, false) == "newtxmath";
1454 if ((useNonTeXFonts || use_newtxmath) && !ams.empty())
1455 os << from_ascii(ams);
1457 if (useNonTeXFonts) {
1458 os << "\\usepackage{fontspec}\n";
1459 if (features.mustProvide("unicode-math")
1460 && features.isAvailable("unicode-math"))
1461 os << "\\usepackage{unicode-math}\n";
1464 // font selection must be done before loading fontenc.sty
1465 string const fonts = loadFonts(features);
1467 os << from_utf8(fonts);
1469 if (fonts_default_family != "default")
1470 os << "\\renewcommand{\\familydefault}{\\"
1471 << from_ascii(fonts_default_family) << "}\n";
1473 // set font encoding
1474 // for arabic_arabi and farsi we also need to load the LAE and
1476 // XeTeX and LuaTeX (with OS fonts) work without fontenc
1477 if (font_encoding() != "default" && language->lang() != "japanese"
1478 && !useNonTeXFonts && !features.isProvided("fontenc")) {
1479 docstring extra_encoding;
1480 if (features.mustProvide("textgreek"))
1481 extra_encoding += from_ascii("LGR");
1482 if (features.mustProvide("textcyr")) {
1483 if (!extra_encoding.empty())
1484 extra_encoding.push_back(',');
1485 extra_encoding += from_ascii("T2A");
1487 if (!extra_encoding.empty() && !font_encoding().empty())
1488 extra_encoding.push_back(',');
1489 size_t fars = language_options.str().find("farsi");
1490 size_t arab = language_options.str().find("arabic");
1491 if (language->lang() == "arabic_arabi"
1492 || language->lang() == "farsi" || fars != string::npos
1493 || arab != string::npos) {
1494 os << "\\usepackage[" << extra_encoding
1495 << from_ascii(font_encoding())
1496 << ",LFE,LAE]{fontenc}\n";
1498 os << "\\usepackage[" << extra_encoding
1499 << from_ascii(font_encoding())
1504 // handle inputenc etc.
1505 writeEncodingPreamble(os, features);
1508 if (!features.runparams().includeall && !included_children_.empty()) {
1509 os << "\\includeonly{";
1510 list<string>::const_iterator it = included_children_.begin();
1511 list<string>::const_iterator en = included_children_.end();
1513 for (; it != en; ++it) {
1514 string incfile = *it;
1515 FileName inc = makeAbsPath(incfile, filepath.absFileName());
1516 string mangled = DocFileName(changeExtension(inc.absFileName(), ".tex")).
1518 if (!features.runparams().nice)
1520 // \includeonly doesn't want an extension
1521 incfile = changeExtension(incfile, string());
1522 incfile = support::latex_path(incfile);
1523 if (!incfile.empty()) {
1526 os << from_utf8(incfile);
1533 if (!listings_params.empty() || features.isRequired("listings"))
1534 os << "\\usepackage{listings}\n";
1536 if (!listings_params.empty()) {
1538 // do not test validity because listings_params is
1539 // supposed to be valid
1541 InsetListingsParams(listings_params).separatedParams(true);
1542 // we can't support all packages, but we should load the color package
1543 if (par.find("\\color", 0) != string::npos)
1544 features.require("color");
1545 os << from_utf8(par)
1548 if (!features.isProvided("geometry")
1549 && (use_geometry || nonstandard_papersize)) {
1550 odocstringstream ods;
1551 if (!getGraphicsDriver("geometry").empty())
1552 ods << getGraphicsDriver("geometry");
1553 if (orientation == ORIENTATION_LANDSCAPE)
1554 ods << ",landscape";
1555 switch (papersize) {
1557 if (!paperwidth.empty())
1558 ods << ",paperwidth="
1559 << from_ascii(paperwidth);
1560 if (!paperheight.empty())
1561 ods << ",paperheight="
1562 << from_ascii(paperheight);
1564 case PAPER_USLETTER:
1565 ods << ",letterpaper";
1568 ods << ",legalpaper";
1570 case PAPER_USEXECUTIVE:
1571 ods << ",executivepaper";
1660 docstring const g_options = trim(ods.str(), ",");
1661 os << "\\usepackage";
1662 if (!g_options.empty())
1663 os << '[' << g_options << ']';
1664 os << "{geometry}\n";
1665 // output this only if use_geometry is true
1667 os << "\\geometry{verbose";
1668 if (!topmargin.empty())
1669 os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1670 if (!bottommargin.empty())
1671 os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1672 if (!leftmargin.empty())
1673 os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1674 if (!rightmargin.empty())
1675 os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1676 if (!headheight.empty())
1677 os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1678 if (!headsep.empty())
1679 os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1680 if (!footskip.empty())
1681 os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1682 if (!columnsep.empty())
1683 os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
1686 } else if (orientation == ORIENTATION_LANDSCAPE
1687 || papersize != PAPER_DEFAULT) {
1688 features.require("papersize");
1691 if (tokenPos(tclass.opt_pagestyle(), '|', pagestyle) >= 0) {
1692 if (pagestyle == "fancy")
1693 os << "\\usepackage{fancyhdr}\n";
1694 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1697 // only output when the background color is not default
1698 if (isbackgroundcolor == true) {
1699 // only require color here, the background color will be defined
1700 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1702 features.require("color");
1703 features.require("pagecolor");
1706 // only output when the font color is not default
1707 if (isfontcolor == true) {
1708 // only require color here, the font color will be defined
1709 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1711 features.require("color");
1712 features.require("fontcolor");
1715 // Only if class has a ToC hierarchy
1716 if (tclass.hasTocLevels()) {
1717 if (secnumdepth != tclass.secnumdepth()) {
1718 os << "\\setcounter{secnumdepth}{"
1722 if (tocdepth != tclass.tocdepth()) {
1723 os << "\\setcounter{tocdepth}{"
1729 if (paragraph_separation) {
1730 // when skip separation
1731 switch (getDefSkip().kind()) {
1732 case VSpace::SMALLSKIP:
1733 os << "\\setlength{\\parskip}{\\smallskipamount}\n";
1735 case VSpace::MEDSKIP:
1736 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1738 case VSpace::BIGSKIP:
1739 os << "\\setlength{\\parskip}{\\bigskipamount}\n";
1741 case VSpace::LENGTH:
1742 os << "\\setlength{\\parskip}{"
1743 << from_utf8(getDefSkip().length().asLatexString())
1746 default: // should never happen // Then delete it.
1747 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1750 os << "\\setlength{\\parindent}{0pt}\n";
1752 // when separation by indentation
1753 // only output something when a width is given
1754 if (getIndentation().asLyXCommand() != "default") {
1755 os << "\\setlength{\\parindent}{"
1756 << from_utf8(getIndentation().asLatexCommand())
1761 // Now insert the LyX specific LaTeX commands...
1762 docstring lyxpreamble;
1763 features.resolveAlternatives();
1766 if (!output_sync_macro.empty())
1767 lyxpreamble += from_utf8(output_sync_macro) +"\n";
1768 else if (features.runparams().flavor == OutputParams::LATEX)
1769 lyxpreamble += "\\usepackage[active]{srcltx}\n";
1770 else if (features.runparams().flavor == OutputParams::PDFLATEX)
1771 lyxpreamble += "\\synctex=-1\n";
1774 // due to interferences with babel and hyperref, the color package has to
1775 // be loaded (when it is not already loaded) before babel when hyperref
1776 // is used with the colorlinks option, see
1777 // http://www.lyx.org/trac/ticket/5291
1778 // we decided therefore to load color always before babel, see
1779 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
1780 lyxpreamble += from_ascii(features.getColorOptions());
1782 // If we use hyperref, jurabib, japanese, varioref or vietnamese,
1783 // we have to call babel before
1785 && (features.isRequired("jurabib")
1786 || features.isRequired("hyperref")
1787 || features.isRequired("varioref")
1788 || features.isRequired("vietnamese")
1789 || features.isRequired("japanese"))) {
1791 lyxpreamble += from_utf8(features.getBabelPresettings());
1792 lyxpreamble += from_utf8(babelCall(language_options.str(),
1793 features.needBabelLangOptions())) + '\n';
1794 lyxpreamble += from_utf8(features.getBabelPostsettings());
1797 // The optional packages;
1798 lyxpreamble += from_ascii(features.getPackages());
1800 // Additional Indices
1801 if (features.isRequired("splitidx")) {
1802 IndicesList::const_iterator iit = indiceslist().begin();
1803 IndicesList::const_iterator iend = indiceslist().end();
1804 for (; iit != iend; ++iit) {
1805 pair<docstring, docstring> indexname_latex =
1806 features.runparams().encoding->latexString(iit->index(),
1807 features.runparams().dryrun);
1808 if (!indexname_latex.second.empty()) {
1809 // issue a warning about omitted characters
1810 // FIXME: should be passed to the error dialog
1811 frontend::Alert::warning(_("Uncodable characters"),
1812 bformat(_("The following characters that are used in an index name are not\n"
1813 "representable in the current encoding and therefore have been omitted:\n%1$s."),
1814 indexname_latex.second));
1816 lyxpreamble += "\\newindex[";
1817 lyxpreamble += indexname_latex.first;
1818 lyxpreamble += "]{";
1819 lyxpreamble += escape(iit->shortcut());
1820 lyxpreamble += "}\n";
1825 lyxpreamble += from_utf8(spacing().writePreamble(features.isProvided("SetSpace")));
1828 // * Hyperref manual: "Make sure it comes last of your loaded
1829 // packages, to give it a fighting chance of not being over-written,
1830 // since its job is to redefine many LaTeX commands."
1831 // * Email from Heiko Oberdiek: "It is usually better to load babel
1832 // before hyperref. Then hyperref has a chance to detect babel.
1833 // * Has to be loaded before the "LyX specific LaTeX commands" to
1834 // avoid errors with algorithm floats.
1835 // use hyperref explicitly if it is required
1836 if (features.isRequired("hyperref")) {
1837 // pass what we have to stream here, since we need
1838 // to access the stream itself in PDFOptions.
1841 OutputParams tmp_params = features.runparams();
1842 pdfoptions().writeLaTeX(tmp_params, os,
1843 features.isProvided("hyperref"));
1844 // set back for the rest
1845 lyxpreamble.clear();
1846 // correctly break URLs with hyperref and dvi output
1847 if (features.runparams().flavor == OutputParams::LATEX
1848 && features.isAvailable("breakurl"))
1849 lyxpreamble += "\\usepackage{breakurl}\n";
1850 } else if (features.isRequired("nameref"))
1851 // hyperref loads this automatically
1852 lyxpreamble += "\\usepackage{nameref}\n";
1854 // bibtopic needs to be loaded after hyperref.
1855 // the dot provides the aux file naming which LyX can detect.
1856 if (features.mustProvide("bibtopic"))
1857 lyxpreamble += "\\usepackage[dot]{bibtopic}\n";
1859 // Will be surrounded by \makeatletter and \makeatother when not empty
1860 docstring atlyxpreamble;
1862 // Some macros LyX will need
1863 docstring tmppreamble(features.getMacros());
1865 if (!tmppreamble.empty())
1866 atlyxpreamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1867 "LyX specific LaTeX commands.\n"
1868 + tmppreamble + '\n';
1870 // the text class specific preamble
1871 tmppreamble = features.getTClassPreamble();
1872 if (!tmppreamble.empty())
1873 atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1874 "Textclass specific LaTeX commands.\n"
1875 + tmppreamble + '\n';
1877 // suppress date if selected
1878 // use \@ifundefined because we cannot be sure that every document class
1879 // has a \date command
1881 atlyxpreamble += "\\@ifundefined{date}{}{\\date{}}\n";
1883 /* the user-defined preamble */
1884 if (!containsOnly(preamble, " \n\t"))
1886 atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1887 "User specified LaTeX commands.\n"
1888 + from_utf8(preamble) + '\n';
1890 // subfig loads internally the LaTeX package "caption". As
1891 // caption is a very popular package, users will load it in
1892 // the preamble. Therefore we must load subfig behind the
1893 // user-defined preamble and check if the caption package was
1894 // loaded or not. For the case that caption is loaded before
1895 // subfig, there is the subfig option "caption=false". This
1896 // option also works when a koma-script class is used and
1897 // koma's own caption commands are used instead of caption. We
1898 // use \PassOptionsToPackage here because the user could have
1899 // already loaded subfig in the preamble.
1900 if (features.isRequired("subfig")) {
1901 atlyxpreamble += "\\@ifundefined{showcaptionsetup}{}{%\n"
1902 " \\PassOptionsToPackage{caption=false}{subfig}}\n"
1903 "\\usepackage{subfig}\n";
1906 // Itemize bullet settings need to be last in case the user
1907 // defines their own bullets that use a package included
1908 // in the user-defined preamble -- ARRae
1909 // Actually it has to be done much later than that
1910 // since some packages like frenchb make modifications
1911 // at \begin{document} time -- JMarc
1912 docstring bullets_def;
1913 for (int i = 0; i < 4; ++i) {
1914 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1915 if (bullets_def.empty())
1916 bullets_def += "\\AtBeginDocument{\n";
1917 bullets_def += " \\def\\labelitemi";
1919 // `i' is one less than the item to modify
1926 bullets_def += "ii";
1932 bullets_def += '{' +
1933 user_defined_bullet(i).getText()
1938 if (!bullets_def.empty())
1939 atlyxpreamble += bullets_def + "}\n\n";
1941 if (!atlyxpreamble.empty())
1942 lyxpreamble += "\n\\makeatletter\n"
1943 + atlyxpreamble + "\\makeatother\n\n";
1945 // We try to load babel late, in case it interferes with other packages.
1946 // Jurabib, hyperref and varioref have to be called after babel, though.
1947 if (use_babel && !features.isRequired("jurabib")
1948 && !features.isRequired("hyperref")
1949 && !features.isRequired("varioref")
1950 && !features.isRequired("vietnamese")
1951 && !features.isRequired("japanese")) {
1953 lyxpreamble += from_utf8(features.getBabelPresettings());
1954 lyxpreamble += from_utf8(babelCall(language_options.str(),
1955 features.needBabelLangOptions())) + '\n';
1956 lyxpreamble += from_utf8(features.getBabelPostsettings());
1959 // xunicode needs to be loaded at least after amsmath, amssymb,
1960 // esint and the other packages that provide special glyphs
1961 if (features.runparams().flavor == OutputParams::XETEX
1963 lyxpreamble += "\\usepackage{xunicode}\n";
1965 // Polyglossia must be loaded last
1966 if (use_polyglossia) {
1968 lyxpreamble += "\\usepackage{polyglossia}\n";
1969 // set the main language
1970 lyxpreamble += "\\setdefaultlanguage";
1971 if (!language->polyglossiaOpts().empty())
1972 lyxpreamble += "[" + from_ascii(language->polyglossiaOpts()) + "]";
1973 lyxpreamble += "{" + from_ascii(language->polyglossia()) + "}\n";
1974 // now setup the other languages
1975 std::map<std::string, std::string> const polylangs =
1976 features.getPolyglossiaLanguages();
1977 for (std::map<std::string, std::string>::const_iterator mit = polylangs.begin();
1978 mit != polylangs.end() ; ++mit) {
1979 lyxpreamble += "\\setotherlanguage";
1980 if (!mit->second.empty())
1981 lyxpreamble += "[" + from_ascii(mit->second) + "]";
1982 lyxpreamble += "{" + from_ascii(mit->first) + "}\n";
1986 // Load custom language package here
1987 if (features.langPackage() == LaTeXFeatures::LANG_PACK_CUSTOM) {
1988 if (lang_package == "default")
1989 lyxpreamble += from_utf8(lyxrc.language_custom_package);
1991 lyxpreamble += from_utf8(lang_package);
1992 lyxpreamble += '\n';
1995 docstring const i18npreamble =
1996 features.getTClassI18nPreamble(use_babel, use_polyglossia);
1997 if (!i18npreamble.empty())
1998 lyxpreamble += i18npreamble + '\n';
2006 void BufferParams::useClassDefaults()
2008 DocumentClass const & tclass = documentClass();
2010 sides = tclass.sides();
2011 columns = tclass.columns();
2012 pagestyle = tclass.pagestyle();
2013 use_default_options = true;
2014 // Only if class has a ToC hierarchy
2015 if (tclass.hasTocLevels()) {
2016 secnumdepth = tclass.secnumdepth();
2017 tocdepth = tclass.tocdepth();
2022 bool BufferParams::hasClassDefaults() const
2024 DocumentClass const & tclass = documentClass();
2026 return sides == tclass.sides()
2027 && columns == tclass.columns()
2028 && pagestyle == tclass.pagestyle()
2029 && use_default_options
2030 && secnumdepth == tclass.secnumdepth()
2031 && tocdepth == tclass.tocdepth();
2035 DocumentClass const & BufferParams::documentClass() const
2037 return *doc_class_.get();
2041 DocumentClassConstPtr BufferParams::documentClassPtr() const
2047 void BufferParams::setDocumentClass(DocumentClassConstPtr tc)
2049 // evil, but this function is evil
2050 doc_class_ = const_pointer_cast<DocumentClass>(tc);
2054 bool BufferParams::setBaseClass(string const & classname)
2056 LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
2057 LayoutFileList & bcl = LayoutFileList::get();
2058 if (!bcl.haveClass(classname)) {
2060 bformat(_("The layout file:\n"
2062 "could not be found. A default textclass with default\n"
2063 "layouts will be used. LyX will not be able to produce\n"
2065 from_utf8(classname));
2066 frontend::Alert::error(_("Document class not found"), s);
2067 bcl.addEmptyClass(classname);
2070 bool const success = bcl[classname].load();
2073 bformat(_("Due to some error in it, the layout file:\n"
2075 "could not be loaded. A default textclass with default\n"
2076 "layouts will be used. LyX will not be able to produce\n"
2078 from_utf8(classname));
2079 frontend::Alert::error(_("Could not load class"), s);
2080 bcl.addEmptyClass(classname);
2083 pimpl_->baseClass_ = classname;
2084 layout_modules_.adaptToBaseClass(baseClass(), removed_modules_);
2089 LayoutFile const * BufferParams::baseClass() const
2091 if (LayoutFileList::get().haveClass(pimpl_->baseClass_))
2092 return &(LayoutFileList::get()[pimpl_->baseClass_]);
2098 LayoutFileIndex const & BufferParams::baseClassID() const
2100 return pimpl_->baseClass_;
2104 void BufferParams::makeDocumentClass()
2109 LayoutModuleList mods;
2110 LayoutModuleList::iterator it = layout_modules_.begin();
2111 LayoutModuleList::iterator en = layout_modules_.end();
2112 for (; it != en; ++it)
2113 mods.push_back(*it);
2115 it = cite_engine_.begin();
2116 en = cite_engine_.end();
2117 for (; it != en; ++it)
2118 mods.push_back(*it);
2120 doc_class_ = getDocumentClass(*baseClass(), mods);
2122 TextClass::ReturnValues success = TextClass::OK;
2123 if (!forced_local_layout_.empty())
2124 success = doc_class_->read(forced_local_layout_, TextClass::MODULE);
2125 if (!local_layout_.empty() &&
2126 (success == TextClass::OK || success == TextClass::OK_OLDFORMAT))
2127 success = doc_class_->read(local_layout_, TextClass::MODULE);
2128 if (success != TextClass::OK && success != TextClass::OK_OLDFORMAT) {
2129 docstring const msg = _("Error reading internal layout information");
2130 frontend::Alert::warning(_("Read Error"), msg);
2135 bool BufferParams::layoutModuleCanBeAdded(string const & modName) const
2137 return layout_modules_.moduleCanBeAdded(modName, baseClass());
2141 bool BufferParams::citationModuleCanBeAdded(string const & modName) const
2143 return cite_engine_.moduleCanBeAdded(modName, baseClass());
2147 std::string BufferParams::getLocalLayout(bool forced) const
2150 return doc_class_->forcedLayouts();
2152 return local_layout_;
2156 void BufferParams::setLocalLayout(string const & layout, bool forced)
2159 forced_local_layout_ = layout;
2161 local_layout_ = layout;
2165 bool BufferParams::addLayoutModule(string const & modName)
2167 LayoutModuleList::const_iterator it = layout_modules_.begin();
2168 LayoutModuleList::const_iterator end = layout_modules_.end();
2169 for (; it != end; ++it)
2172 layout_modules_.push_back(modName);
2177 string BufferParams::bufferFormat() const
2179 string format = documentClass().outputFormat();
2180 if (format == "latex") {
2183 if (encoding().package() == Encoding::japanese)
2190 bool BufferParams::isExportable(string const & format) const
2192 vector<string> backs = backends();
2193 for (vector<string>::const_iterator it = backs.begin();
2194 it != backs.end(); ++it)
2195 if (theConverters().isReachable(*it, format))
2201 vector<Format const *> BufferParams::exportableFormats(bool only_viewable) const
2203 vector<string> const backs = backends();
2204 set<string> excludes;
2205 if (useNonTeXFonts) {
2206 excludes.insert("latex");
2207 excludes.insert("pdflatex");
2209 vector<Format const *> result =
2210 theConverters().getReachable(backs[0], only_viewable, true, excludes);
2211 for (vector<string>::const_iterator it = backs.begin() + 1;
2212 it != backs.end(); ++it) {
2213 vector<Format const *> r =
2214 theConverters().getReachable(*it, only_viewable, false, excludes);
2215 result.insert(result.end(), r.begin(), r.end());
2221 bool BufferParams::isExportableFormat(string const & format) const
2223 typedef vector<Format const *> Formats;
2225 formats = exportableFormats(true);
2226 Formats::const_iterator fit = formats.begin();
2227 Formats::const_iterator end = formats.end();
2228 for (; fit != end ; ++fit) {
2229 if ((*fit)->name() == format)
2236 vector<string> BufferParams::backends() const
2239 string const buffmt = bufferFormat();
2241 // FIXME: Don't hardcode format names here, but use a flag
2242 if (buffmt == "latex") {
2243 if (!useNonTeXFonts) {
2244 v.push_back("pdflatex");
2245 v.push_back("latex");
2247 v.push_back("luatex");
2248 v.push_back("dviluatex");
2249 v.push_back("xetex");
2250 } else if (buffmt == "xetex") {
2251 v.push_back("xetex");
2252 // FIXME: need to test all languages (bug 8205)
2253 if (!language || !language->isPolyglossiaExclusive()) {
2254 v.push_back("luatex");
2255 v.push_back("dviluatex");
2258 v.push_back(buffmt);
2260 v.push_back("xhtml");
2261 v.push_back("text");
2267 OutputParams::FLAVOR BufferParams::getOutputFlavor(string const format) const
2269 string const dformat = (format.empty() || format == "default") ?
2270 getDefaultOutputFormat() : format;
2271 DefaultFlavorCache::const_iterator it =
2272 default_flavors_.find(dformat);
2274 if (it != default_flavors_.end())
2277 OutputParams::FLAVOR result = OutputParams::LATEX;
2279 // FIXME It'd be better not to hardcode this, but to do
2280 // something with formats.
2281 if (dformat == "xhtml")
2282 result = OutputParams::HTML;
2283 else if (dformat == "text")
2284 result = OutputParams::TEXT;
2285 else if (dformat == "lyx")
2286 result = OutputParams::LYX;
2287 else if (dformat == "pdflatex")
2288 result = OutputParams::PDFLATEX;
2289 else if (dformat == "xetex")
2290 result = OutputParams::XETEX;
2291 else if (dformat == "luatex")
2292 result = OutputParams::LUATEX;
2293 else if (dformat == "dviluatex")
2294 result = OutputParams::DVILUATEX;
2296 // Try to determine flavor of default output format
2297 vector<string> backs = backends();
2298 if (find(backs.begin(), backs.end(), dformat) == backs.end()) {
2299 // Get shortest path to format
2300 Graph::EdgePath path;
2301 for (vector<string>::const_iterator it = backs.begin();
2302 it != backs.end(); ++it) {
2303 Graph::EdgePath p = theConverters().getPath(*it, dformat);
2304 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2309 result = theConverters().getFlavor(path);
2312 // cache this flavor
2313 default_flavors_[dformat] = result;
2318 string BufferParams::getDefaultOutputFormat() const
2320 if (!default_output_format.empty()
2321 && default_output_format != "default")
2322 return default_output_format;
2324 || encoding().package() == Encoding::japanese) {
2325 vector<Format const *> const formats = exportableFormats(true);
2326 if (formats.empty())
2328 // return the first we find
2329 return formats.front()->name();
2332 return lyxrc.default_otf_view_format;
2333 return lyxrc.default_view_format;
2336 Font const BufferParams::getFont() const
2338 FontInfo f = documentClass().defaultfont();
2339 if (fonts_default_family == "rmdefault")
2340 f.setFamily(ROMAN_FAMILY);
2341 else if (fonts_default_family == "sfdefault")
2342 f.setFamily(SANS_FAMILY);
2343 else if (fonts_default_family == "ttdefault")
2344 f.setFamily(TYPEWRITER_FAMILY);
2345 return Font(f, language);
2349 InsetQuotes::QuoteLanguage BufferParams::getQuoteStyle(string const qs) const
2351 return quoteslangtranslator().find(qs);
2355 bool BufferParams::isLatex() const
2357 return documentClass().outputType() == LATEX;
2361 bool BufferParams::isLiterate() const
2363 return documentClass().outputType() == LITERATE;
2367 bool BufferParams::isDocBook() const
2369 return documentClass().outputType() == DOCBOOK;
2373 void BufferParams::readPreamble(Lexer & lex)
2375 if (lex.getString() != "\\begin_preamble")
2376 lyxerr << "Error (BufferParams::readPreamble):"
2377 "consistency check failed." << endl;
2379 preamble = lex.getLongString("\\end_preamble");
2383 void BufferParams::readLocalLayout(Lexer & lex, bool forced)
2385 string const expected = forced ? "\\begin_forced_local_layout" :
2386 "\\begin_local_layout";
2387 if (lex.getString() != expected)
2388 lyxerr << "Error (BufferParams::readLocalLayout):"
2389 "consistency check failed." << endl;
2392 forced_local_layout_ =
2393 lex.getLongString("\\end_forced_local_layout");
2395 local_layout_ = lex.getLongString("\\end_local_layout");
2399 bool BufferParams::setLanguage(string const & lang)
2401 Language const *new_language = languages.getLanguage(lang);
2402 if (!new_language) {
2403 // Language lang was not found
2406 language = new_language;
2411 void BufferParams::readLanguage(Lexer & lex)
2413 if (!lex.next()) return;
2415 string const tmptok = lex.getString();
2417 // check if tmptok is part of tex_babel in tex-defs.h
2418 if (!setLanguage(tmptok)) {
2419 // Language tmptok was not found
2420 language = default_language;
2421 lyxerr << "Warning: Setting language `"
2422 << tmptok << "' to `" << language->lang()
2428 void BufferParams::readGraphicsDriver(Lexer & lex)
2433 string const tmptok = lex.getString();
2434 // check if tmptok is part of tex_graphics in tex_defs.h
2437 string const test = tex_graphics[n++];
2439 if (test == tmptok) {
2440 graphics_driver = tmptok;
2445 "Warning: graphics driver `$$Token' not recognized!\n"
2446 " Setting graphics driver to `default'.\n");
2447 graphics_driver = "default";
2454 void BufferParams::readBullets(Lexer & lex)
2459 int const index = lex.getInteger();
2461 int temp_int = lex.getInteger();
2462 user_defined_bullet(index).setFont(temp_int);
2463 temp_bullet(index).setFont(temp_int);
2465 user_defined_bullet(index).setCharacter(temp_int);
2466 temp_bullet(index).setCharacter(temp_int);
2468 user_defined_bullet(index).setSize(temp_int);
2469 temp_bullet(index).setSize(temp_int);
2473 void BufferParams::readBulletsLaTeX(Lexer & lex)
2475 // The bullet class should be able to read this.
2478 int const index = lex.getInteger();
2480 docstring const temp_str = lex.getDocString();
2482 user_defined_bullet(index).setText(temp_str);
2483 temp_bullet(index).setText(temp_str);
2487 void BufferParams::readModules(Lexer & lex)
2489 if (!lex.eatLine()) {
2490 lyxerr << "Error (BufferParams::readModules):"
2491 "Unexpected end of input." << endl;
2495 string mod = lex.getString();
2496 if (mod == "\\end_modules")
2498 addLayoutModule(mod);
2504 void BufferParams::readRemovedModules(Lexer & lex)
2506 if (!lex.eatLine()) {
2507 lyxerr << "Error (BufferParams::readRemovedModules):"
2508 "Unexpected end of input." << endl;
2512 string mod = lex.getString();
2513 if (mod == "\\end_removed_modules")
2515 removed_modules_.push_back(mod);
2518 // now we want to remove any removed modules that were previously
2519 // added. normally, that will be because default modules were added in
2520 // setBaseClass(), which gets called when \textclass is read at the
2521 // start of the read.
2522 list<string>::const_iterator rit = removed_modules_.begin();
2523 list<string>::const_iterator const ren = removed_modules_.end();
2524 for (; rit != ren; ++rit) {
2525 LayoutModuleList::iterator const mit = layout_modules_.begin();
2526 LayoutModuleList::iterator const men = layout_modules_.end();
2527 LayoutModuleList::iterator found = find(mit, men, *rit);
2530 layout_modules_.erase(found);
2535 void BufferParams::readIncludeonly(Lexer & lex)
2537 if (!lex.eatLine()) {
2538 lyxerr << "Error (BufferParams::readIncludeonly):"
2539 "Unexpected end of input." << endl;
2543 string child = lex.getString();
2544 if (child == "\\end_includeonly")
2546 included_children_.push_back(child);
2552 string BufferParams::paperSizeName(PapersizePurpose purpose) const
2554 switch (papersize) {
2556 // could be anything, so don't guess
2558 case PAPER_CUSTOM: {
2559 if (purpose == XDVI && !paperwidth.empty() &&
2560 !paperheight.empty()) {
2561 // heightxwidth<unit>
2562 string first = paperwidth;
2563 string second = paperheight;
2564 if (orientation == ORIENTATION_LANDSCAPE)
2567 return first.erase(first.length() - 2)
2573 // dvips and dvipdfm do not know this
2574 if (purpose == DVIPS || purpose == DVIPDFM)
2578 if (purpose == DVIPS || purpose == DVIPDFM)
2582 if (purpose == DVIPS || purpose == DVIPDFM)
2592 if (purpose == DVIPS || purpose == DVIPDFM)
2596 if (purpose == DVIPS || purpose == DVIPDFM)
2600 if (purpose == DVIPS || purpose == DVIPDFM)
2604 if (purpose == DVIPS || purpose == DVIPDFM)
2608 if (purpose == DVIPS || purpose == DVIPDFM)
2612 // dvipdfm does not know this
2613 if (purpose == DVIPDFM)
2617 if (purpose == DVIPDFM)
2621 if (purpose == DVIPS || purpose == DVIPDFM)
2625 if (purpose == DVIPS || purpose == DVIPDFM)
2629 if (purpose == DVIPS || purpose == DVIPDFM)
2633 if (purpose == DVIPS || purpose == DVIPDFM)
2637 if (purpose == DVIPS || purpose == DVIPDFM)
2641 if (purpose == DVIPS || purpose == DVIPDFM)
2645 if (purpose == DVIPS || purpose == DVIPDFM)
2649 if (purpose == DVIPS || purpose == DVIPDFM)
2653 if (purpose == DVIPS || purpose == DVIPDFM)
2657 if (purpose == DVIPS || purpose == DVIPDFM)
2661 if (purpose == DVIPS || purpose == DVIPDFM)
2665 if (purpose == DVIPS || purpose == DVIPDFM)
2669 if (purpose == DVIPS || purpose == DVIPDFM)
2673 if (purpose == DVIPS || purpose == DVIPDFM)
2677 if (purpose == DVIPS || purpose == DVIPDFM)
2680 case PAPER_USEXECUTIVE:
2681 // dvipdfm does not know this
2682 if (purpose == DVIPDFM)
2687 case PAPER_USLETTER:
2689 if (purpose == XDVI)
2696 string const BufferParams::dvips_options() const
2700 // If the class loads the geometry package, we do not know which
2701 // paper size is used, since we do not set it (bug 7013).
2702 // Therefore we must not specify any argument here.
2703 // dvips gets the correct paper size via DVI specials in this case
2704 // (if the class uses the geometry package correctly).
2705 if (documentClass().provides("geometry"))
2709 && papersize == PAPER_CUSTOM
2710 && !lyxrc.print_paper_dimension_flag.empty()
2711 && !paperwidth.empty()
2712 && !paperheight.empty()) {
2713 // using a custom papersize
2714 result = lyxrc.print_paper_dimension_flag;
2715 result += ' ' + paperwidth;
2716 result += ',' + paperheight;
2718 string const paper_option = paperSizeName(DVIPS);
2719 if (!paper_option.empty() && (paper_option != "letter" ||
2720 orientation != ORIENTATION_LANDSCAPE)) {
2721 // dvips won't accept -t letter -t landscape.
2722 // In all other cases, include the paper size
2724 result = lyxrc.print_paper_flag;
2725 result += ' ' + paper_option;
2728 if (orientation == ORIENTATION_LANDSCAPE &&
2729 papersize != PAPER_CUSTOM)
2730 result += ' ' + lyxrc.print_landscape_flag;
2735 string const BufferParams::font_encoding() const
2737 return (fontenc == "global") ? lyxrc.fontenc : fontenc;
2741 string BufferParams::babelCall(string const & lang_opts, bool const langoptions) const
2743 // suppress the babel call if there is no BabelName defined
2744 // for the document language in the lib/languages file and if no
2745 // other languages are used (lang_opts is then empty)
2746 if (lang_opts.empty())
2748 // either a specific language (AsBabelOptions setting in
2749 // lib/languages) or the prefs require the languages to
2750 // be submitted to babel itself (not the class).
2752 return "\\usepackage[" + lang_opts + "]{babel}";
2753 return "\\usepackage{babel}";
2757 docstring BufferParams::getGraphicsDriver(string const & package) const
2761 if (package == "geometry") {
2762 if (graphics_driver == "dvips"
2763 || graphics_driver == "dvipdfm"
2764 || graphics_driver == "pdftex"
2765 || graphics_driver == "vtex")
2766 result = from_ascii(graphics_driver);
2767 else if (graphics_driver == "dvipdfmx")
2768 result = from_ascii("dvipdfm");
2775 void BufferParams::writeEncodingPreamble(otexstream & os,
2776 LaTeXFeatures & features) const
2778 // XeTeX does not need this
2779 if (features.runparams().flavor == OutputParams::XETEX)
2781 // LuaTeX neither, but with tex fonts, we need to load
2782 // the luainputenc package.
2783 if (features.runparams().flavor == OutputParams::LUATEX
2784 || features.runparams().flavor == OutputParams::DVILUATEX) {
2785 if (!useNonTeXFonts && inputenc != "default"
2786 && ((inputenc == "auto" && language->encoding()->package() == Encoding::inputenc)
2787 || (inputenc != "auto" && encoding().package() == Encoding::inputenc))) {
2788 os << "\\usepackage[utf8]{luainputenc}\n";
2792 if (inputenc == "auto") {
2793 string const doc_encoding =
2794 language->encoding()->latexName();
2795 Encoding::Package const package =
2796 language->encoding()->package();
2798 // Create a list with all the input encodings used
2800 set<string> encodings =
2801 features.getEncodingSet(doc_encoding);
2803 // If the "japanese" package (i.e. pLaTeX) is used,
2804 // inputenc must be omitted.
2805 // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
2806 if ((!encodings.empty() || package == Encoding::inputenc)
2807 && !features.isRequired("japanese")) {
2808 os << "\\usepackage[";
2809 set<string>::const_iterator it = encodings.begin();
2810 set<string>::const_iterator const end = encodings.end();
2812 os << from_ascii(*it);
2815 for (; it != end; ++it)
2816 os << ',' << from_ascii(*it);
2817 if (package == Encoding::inputenc) {
2818 if (!encodings.empty())
2820 os << from_ascii(doc_encoding);
2822 os << "]{inputenc}\n";
2824 if (package == Encoding::CJK || features.mustProvide("CJK")) {
2825 if (language->encoding()->name() == "utf8-cjk"
2826 && LaTeXFeatures::isAvailable("CJKutf8"))
2827 os << "\\usepackage{CJKutf8}\n";
2829 os << "\\usepackage{CJK}\n";
2831 } else if (inputenc != "default") {
2832 switch (encoding().package()) {
2833 case Encoding::none:
2834 case Encoding::japanese:
2836 case Encoding::inputenc:
2837 // do not load inputenc if japanese is used
2838 if (features.isRequired("japanese"))
2840 os << "\\usepackage[" << from_ascii(encoding().latexName())
2844 if (encoding().name() == "utf8-cjk"
2845 && LaTeXFeatures::isAvailable("CJKutf8"))
2846 os << "\\usepackage{CJKutf8}\n";
2848 os << "\\usepackage{CJK}\n";
2851 // Load the CJK package if needed by a secondary language.
2852 // If the main encoding is some variant of UTF8, use CJKutf8.
2853 if (encoding().package() != Encoding::CJK && features.mustProvide("CJK")) {
2854 if (encoding().iconvName() == "UTF-8"
2855 && LaTeXFeatures::isAvailable("CJKutf8"))
2856 os << "\\usepackage{CJKutf8}\n";
2858 os << "\\usepackage{CJK}\n";
2864 string const BufferParams::parseFontName(string const & name) const
2866 string mangled = name;
2867 size_t const idx = mangled.find('[');
2868 if (idx == string::npos || idx == 0)
2871 return mangled.substr(0, idx - 1);
2875 string const BufferParams::loadFonts(LaTeXFeatures & features) const
2877 if (fonts_roman == "default" && fonts_sans == "default"
2878 && fonts_typewriter == "default"
2879 && (fonts_math == "default" || fonts_math == "auto"))
2885 /* Fontspec (XeTeX, LuaTeX): we provide GUI support for oldstyle
2886 * numbers (Numbers=OldStyle) and sf/tt scaling. The Ligatures=TeX/
2887 * Mapping=tex-text option assures TeX ligatures (such as "--")
2888 * are resolved. Note that tt does not use these ligatures.
2890 * -- add more GUI options?
2891 * -- add more fonts (fonts for other scripts)
2892 * -- if there's a way to find out if a font really supports
2893 * OldStyle, enable/disable the widget accordingly.
2895 if (useNonTeXFonts && features.isAvailable("fontspec")) {
2896 // "Mapping=tex-text" and "Ligatures=TeX" are equivalent.
2897 // However, until v.2 (2010/07/11) fontspec only knew
2898 // Mapping=tex-text (for XeTeX only); then "Ligatures=TeX"
2899 // was introduced for both XeTeX and LuaTeX (LuaTeX
2900 // didn't understand "Mapping=tex-text", while XeTeX
2901 // understood both. With most recent versions, both
2902 // variants are understood by both engines. However,
2903 // we want to provide support for at least TeXLive 2009
2904 // (for XeTeX; LuaTeX is only supported as of v.2)
2905 string const texmapping =
2906 (features.runparams().flavor == OutputParams::XETEX) ?
2907 "Mapping=tex-text" : "Ligatures=TeX";
2908 if (fonts_roman != "default") {
2909 os << "\\setmainfont[" << texmapping;
2910 if (fonts_old_figures)
2911 os << ",Numbers=OldStyle";
2912 os << "]{" << parseFontName(fonts_roman) << "}\n";
2914 if (fonts_sans != "default") {
2915 string const sans = parseFontName(fonts_sans);
2916 if (fonts_sans_scale != 100)
2917 os << "\\setsansfont[Scale="
2918 << float(fonts_sans_scale) / 100
2919 << "," << texmapping << "]{"
2922 os << "\\setsansfont[" << texmapping << "]{"
2925 if (fonts_typewriter != "default") {
2926 string const mono = parseFontName(fonts_typewriter);
2927 if (fonts_typewriter_scale != 100)
2928 os << "\\setmonofont[Scale="
2929 << float(fonts_typewriter_scale) / 100
2933 os << "\\setmonofont{"
2940 bool const ot1 = (font_encoding() == "default" || font_encoding() == "OT1");
2941 bool const dryrun = features.runparams().dryrun;
2942 bool const complete = (fonts_sans == "default" && fonts_typewriter == "default");
2943 bool const nomath = (fonts_math == "default");
2946 os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_roman)).getLaTeXCode(
2947 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
2951 os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_sans)).getLaTeXCode(
2952 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
2953 nomath, fonts_sans_scale);
2955 // MONOSPACED/TYPEWRITER
2956 os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_typewriter)).getLaTeXCode(
2957 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
2958 nomath, fonts_typewriter_scale);
2961 os << theLaTeXFonts().getLaTeXFont(from_ascii(fonts_math)).getLaTeXCode(
2962 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
2969 Encoding const & BufferParams::encoding() const
2971 // FIXME: actually, we should check for the flavor
2972 // or runparams.isFullyUnicode() here:
2973 // This check will not work with XeTeX/LuaTeX and tex fonts.
2974 // Thus we have to reset the encoding in Buffer::makeLaTeXFile.
2976 return *(encodings.fromLyXName("utf8-plain"));
2977 if (inputenc == "auto" || inputenc == "default")
2978 return *language->encoding();
2979 Encoding const * const enc = encodings.fromLyXName(inputenc);
2982 LYXERR0("Unknown inputenc value `" << inputenc
2983 << "'. Using `auto' instead.");
2984 return *language->encoding();
2988 bool BufferParams::addCiteEngine(string const & engine)
2990 LayoutModuleList::const_iterator it = cite_engine_.begin();
2991 LayoutModuleList::const_iterator en = cite_engine_.end();
2992 for (; it != en; ++it)
2995 cite_engine_.push_back(engine);
3000 bool BufferParams::addCiteEngine(vector<string> const & engine)
3002 vector<string>::const_iterator it = engine.begin();
3003 vector<string>::const_iterator en = engine.end();
3005 for (; it != en; ++it)
3006 if (!addCiteEngine(*it))
3012 string const & BufferParams::defaultBiblioStyle() const
3014 return documentClass().defaultBiblioStyle();
3018 bool const & BufferParams::fullAuthorList() const
3020 return documentClass().fullAuthorList();
3024 void BufferParams::setCiteEngine(string const & engine)
3027 addCiteEngine(engine);
3031 void BufferParams::setCiteEngine(vector<string> const & engine)
3034 addCiteEngine(engine);
3038 vector<string> BufferParams::citeCommands() const
3040 static CitationStyle const default_style;
3041 vector<string> commands =
3042 documentClass().citeCommands(citeEngineType());
3043 if (commands.empty())
3044 commands.push_back(default_style.cmd);
3049 vector<CitationStyle> BufferParams::citeStyles() const
3051 static CitationStyle const default_style;
3052 vector<CitationStyle> styles =
3053 documentClass().citeStyles(citeEngineType());
3055 styles.push_back(default_style);