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"
28 #include "Converter.h"
31 #include "IndicesList.h"
33 #include "LaTeXFeatures.h"
34 #include "LaTeXFonts.h"
35 #include "ModuleList.h"
39 #include "OutputParams.h"
43 #include "PDFOptions.h"
45 #include "frontends/alert.h"
47 #include "insets/InsetListingsParams.h"
49 #include "support/convert.h"
50 #include "support/debug.h"
51 #include "support/docstream.h"
52 #include "support/FileName.h"
53 #include "support/filetools.h"
54 #include "support/gettext.h"
55 #include "support/Messages.h"
56 #include "support/mutex.h"
57 #include "support/Package.h"
58 #include "support/Translator.h"
59 #include "support/lstrings.h"
65 using namespace lyx::support;
68 static char const * const string_paragraph_separation[] = {
73 static char const * const string_quotes_language[] = {
74 "english", "swedish", "german", "polish", "french", "danish", ""
78 static char const * const string_papersize[] = {
79 "default", "custom", "letterpaper", "legalpaper", "executivepaper",
80 "a0paper", "a1paper", "a2paper", "a3paper", "a4paper", "a5paper",
81 "a6paper", "b0paper", "b1paper", "b2paper","b3paper", "b4paper",
82 "b5paper", "b6paper", "c0paper", "c1paper", "c2paper", "c3paper",
83 "c4paper", "c5paper", "c6paper", "b0j", "b1j", "b2j", "b3j", "b4j", "b5j",
88 static char const * const string_orientation[] = {
89 "portrait", "landscape", ""
93 static char const * const tex_graphics[] = {
94 "default", "dvialw", "dvilaser", "dvipdf", "dvipdfm", "dvipdfmx",
95 "dvips", "dvipsone", "dvitops", "dviwin", "dviwindo", "dvi2ps", "emtex",
96 "ln", "oztex", "pctexhp", "pctexps", "pctexwin", "pctex32", "pdftex",
97 "psprint", "pubps", "tcidvi", "textures", "truetex", "vtex", "xdvi",
108 // Paragraph separation
109 typedef Translator<string, BufferParams::ParagraphSeparation> ParSepTranslator;
112 ParSepTranslator const init_parseptranslator()
114 ParSepTranslator translator
115 (string_paragraph_separation[0], BufferParams::ParagraphIndentSeparation);
116 translator.addPair(string_paragraph_separation[1], BufferParams::ParagraphSkipSeparation);
121 ParSepTranslator const & parseptranslator()
123 static ParSepTranslator const translator =
124 init_parseptranslator();
130 typedef Translator<string, InsetQuotes::QuoteLanguage> QuotesLangTranslator;
133 QuotesLangTranslator const init_quoteslangtranslator()
135 QuotesLangTranslator translator
136 (string_quotes_language[0], InsetQuotes::EnglishQuotes);
137 translator.addPair(string_quotes_language[1], InsetQuotes::SwedishQuotes);
138 translator.addPair(string_quotes_language[2], InsetQuotes::GermanQuotes);
139 translator.addPair(string_quotes_language[3], InsetQuotes::PolishQuotes);
140 translator.addPair(string_quotes_language[4], InsetQuotes::FrenchQuotes);
141 translator.addPair(string_quotes_language[5], InsetQuotes::DanishQuotes);
146 QuotesLangTranslator const & quoteslangtranslator()
148 static QuotesLangTranslator const translator =
149 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 const translator =
200 initPaperSizeTranslator();
206 typedef Translator<string, PAPER_ORIENTATION> PaperOrientationTranslator;
209 PaperOrientationTranslator const init_paperorientationtranslator()
211 PaperOrientationTranslator translator(string_orientation[0], ORIENTATION_PORTRAIT);
212 translator.addPair(string_orientation[1], ORIENTATION_LANDSCAPE);
217 PaperOrientationTranslator const & paperorientationtranslator()
219 static PaperOrientationTranslator const translator =
220 init_paperorientationtranslator();
226 typedef Translator<int, PageSides> SidesTranslator;
229 SidesTranslator const init_sidestranslator()
231 SidesTranslator translator(1, OneSide);
232 translator.addPair(2, TwoSides);
237 SidesTranslator const & sidestranslator()
239 static SidesTranslator const translator = init_sidestranslator();
245 typedef Translator<int, BufferParams::Package> PackageTranslator;
248 PackageTranslator const init_packagetranslator()
250 PackageTranslator translator(0, BufferParams::package_off);
251 translator.addPair(1, BufferParams::package_auto);
252 translator.addPair(2, BufferParams::package_on);
257 PackageTranslator const & packagetranslator()
259 static PackageTranslator const translator =
260 init_packagetranslator();
266 typedef Translator<string, CiteEngineType> CiteEngineTypeTranslator;
269 CiteEngineTypeTranslator const init_citeenginetypetranslator()
271 CiteEngineTypeTranslator translator("authoryear", ENGINE_TYPE_AUTHORYEAR);
272 translator.addPair("numerical", ENGINE_TYPE_NUMERICAL);
273 translator.addPair("default", ENGINE_TYPE_DEFAULT);
278 CiteEngineTypeTranslator const & citeenginetypetranslator()
280 static CiteEngineTypeTranslator const translator =
281 init_citeenginetypetranslator();
287 typedef Translator<string, Spacing::Space> SpaceTranslator;
290 SpaceTranslator const init_spacetranslator()
292 SpaceTranslator translator("default", Spacing::Default);
293 translator.addPair("single", Spacing::Single);
294 translator.addPair("onehalf", Spacing::Onehalf);
295 translator.addPair("double", Spacing::Double);
296 translator.addPair("other", Spacing::Other);
301 SpaceTranslator const & spacetranslator()
303 static SpaceTranslator const translator = init_spacetranslator();
310 class BufferParams::Impl
315 AuthorList authorlist;
316 BranchList branchlist;
317 Bullet temp_bullets[4];
318 Bullet user_defined_bullets[4];
319 IndicesList indiceslist;
321 /** This is the amount of space used for paragraph_separation "skip",
322 * and for detached paragraphs in "indented" documents.
326 PDFOptions pdfoptions;
327 LayoutFileIndex baseClass_;
331 BufferParams::Impl::Impl()
332 : defskip(VSpace::MEDSKIP), baseClass_(string(""))
334 // set initial author
336 authorlist.record(Author(from_utf8(lyxrc.user_name), from_utf8(lyxrc.user_email)));
341 BufferParams::MemoryTraits::clone(BufferParams::Impl const * ptr)
344 return new BufferParams::Impl(*ptr);
348 void BufferParams::MemoryTraits::destroy(BufferParams::Impl * ptr)
354 BufferParams::BufferParams()
357 setBaseClass(defaultBaseclass());
358 cite_engine_.push_back("basic");
359 cite_engine_type_ = ENGINE_TYPE_DEFAULT;
361 paragraph_separation = ParagraphIndentSeparation;
362 quotes_language = InsetQuotes::EnglishQuotes;
363 fontsize = "default";
366 papersize = PAPER_DEFAULT;
367 orientation = ORIENTATION_PORTRAIT;
368 use_geometry = false;
369 biblio_style = "plain";
370 use_bibtopic = false;
372 save_transient_properties = true;
373 track_changes = false;
374 output_changes = false;
375 use_default_options = true;
376 maintain_unincluded_children = false;
379 language = default_language;
381 fonts_roman[0] = "default";
382 fonts_roman[1] = "default";
383 fonts_sans[0] = "default";
384 fonts_sans[1] = "default";
385 fonts_typewriter[0] = "default";
386 fonts_typewriter[1] = "default";
387 fonts_math[0] = "auto";
388 fonts_math[1] = "auto";
389 fonts_default_family = "default";
390 useNonTeXFonts = false;
391 fonts_expert_sc = false;
392 fonts_old_figures = false;
393 fonts_sans_scale[0] = 100;
394 fonts_sans_scale[1] = 100;
395 fonts_typewriter_scale[0] = 100;
396 fonts_typewriter_scale[1] = 100;
398 lang_package = "default";
399 graphics_driver = "default";
400 default_output_format = "default";
401 bibtex_command = "default";
402 index_command = "default";
405 listings_params = string();
406 pagestyle = "default";
407 suppress_date = false;
408 justification = true;
409 // no color is the default (white)
410 backgroundcolor = lyx::rgbFromHexName("#ffffff");
411 isbackgroundcolor = false;
412 // no color is the default (black)
413 fontcolor = lyx::rgbFromHexName("#000000");
415 // light gray is the default font color for greyed-out notes
416 notefontcolor = lyx::rgbFromHexName("#cccccc");
417 boxbgcolor = lyx::rgbFromHexName("#ff0000");
418 compressed = lyxrc.save_compressed;
419 for (int iter = 0; iter < 4; ++iter) {
420 user_defined_bullet(iter) = ITEMIZE_DEFAULTS[iter];
421 temp_bullet(iter) = ITEMIZE_DEFAULTS[iter];
424 indiceslist().addDefault(B_("Index"));
425 html_be_strict = false;
426 html_math_output = MathML;
427 html_math_img_scale = 1.0;
428 html_css_as_file = false;
429 display_pixel_ratio = 1.0;
434 // map current author
435 author_map_[pimpl_->authorlist.get(0).bufferId()] = 0;
439 docstring BufferParams::B_(string const & l10n) const
441 LASSERT(language, return from_utf8(l10n));
442 return getMessages(language->code()).get(l10n);
446 BufferParams::Package BufferParams::use_package(std::string const & p) const
448 PackageMap::const_iterator it = use_packages.find(p);
449 if (it == use_packages.end())
455 void BufferParams::use_package(std::string const & p, BufferParams::Package u)
461 map<string, string> const & BufferParams::auto_packages()
463 static map<string, string> packages;
464 if (packages.empty()) {
465 // We could have a race condition here that two threads
466 // discover an empty map at the same time and want to fill
467 // it, but that is no problem, since the same contents is
468 // filled in twice then. Having the locker inside the
469 // packages.empty() condition has the advantage that we
470 // don't need the mutex overhead for simple reading.
472 Mutex::Locker locker(&mutex);
473 // adding a package here implies a file format change!
474 packages["amsmath"] =
475 N_("The LaTeX package amsmath is only used if AMS formula types or symbols from the AMS math toolbars are inserted into formulas");
476 packages["amssymb"] =
477 N_("The LaTeX package amssymb is only used if symbols from the AMS math toolbars are inserted into formulas");
479 N_("The LaTeX package cancel is only used if \\cancel commands are used in formulas");
481 N_("The LaTeX package esint is only used if special integral symbols are inserted into formulas");
482 packages["mathdots"] =
483 N_("The LaTeX package mathdots is only used if the command \\iddots is inserted into formulas");
484 packages["mathtools"] =
485 N_("The LaTeX package mathtools is only used if some mathematical relations are inserted into formulas");
487 N_("The LaTeX package mhchem is only used if either the command \\ce or \\cf is inserted into formulas");
488 packages["stackrel"] =
489 N_("The LaTeX package stackrel is only used if the command \\stackrel with subscript is inserted into formulas");
490 packages["stmaryrd"] =
491 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");
492 packages["undertilde"] =
493 N_("The LaTeX package undertilde is only used if you use the math frame decoration 'utilde'");
499 AuthorList & BufferParams::authors()
501 return pimpl_->authorlist;
505 AuthorList const & BufferParams::authors() const
507 return pimpl_->authorlist;
511 void BufferParams::addAuthor(Author a)
513 author_map_[a.bufferId()] = pimpl_->authorlist.record(a);
517 BranchList & BufferParams::branchlist()
519 return pimpl_->branchlist;
523 BranchList const & BufferParams::branchlist() const
525 return pimpl_->branchlist;
529 IndicesList & BufferParams::indiceslist()
531 return pimpl_->indiceslist;
535 IndicesList const & BufferParams::indiceslist() const
537 return pimpl_->indiceslist;
541 Bullet & BufferParams::temp_bullet(lyx::size_type const index)
543 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
544 return pimpl_->temp_bullets[index];
548 Bullet const & BufferParams::temp_bullet(lyx::size_type const index) const
550 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
551 return pimpl_->temp_bullets[index];
555 Bullet & BufferParams::user_defined_bullet(lyx::size_type const index)
557 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
558 return pimpl_->user_defined_bullets[index];
562 Bullet const & BufferParams::user_defined_bullet(lyx::size_type const index) const
564 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
565 return pimpl_->user_defined_bullets[index];
569 Spacing & BufferParams::spacing()
571 return pimpl_->spacing;
575 Spacing const & BufferParams::spacing() const
577 return pimpl_->spacing;
581 PDFOptions & BufferParams::pdfoptions()
583 return pimpl_->pdfoptions;
587 PDFOptions const & BufferParams::pdfoptions() const
589 return pimpl_->pdfoptions;
593 HSpace const & BufferParams::getIndentation() const
595 return pimpl_->indentation;
599 void BufferParams::setIndentation(HSpace const & indent)
601 pimpl_->indentation = indent;
605 VSpace const & BufferParams::getDefSkip() const
607 return pimpl_->defskip;
611 void BufferParams::setDefSkip(VSpace const & vs)
613 // DEFSKIP will cause an infinite loop
614 LASSERT(vs.kind() != VSpace::DEFSKIP, return);
615 pimpl_->defskip = vs;
619 string BufferParams::readToken(Lexer & lex, string const & token,
620 FileName const & filepath)
624 if (token == "\\textclass") {
626 string const classname = lex.getString();
627 // if there exists a local layout file, ignore the system one
628 // NOTE: in this case, the textclass (.cls file) is assumed to
631 LayoutFileList & bcl = LayoutFileList::get();
632 if (!filepath.empty()) {
633 // If classname is an absolute path, the document is
634 // using a local layout file which could not be accessed
635 // by a relative path. In this case the path is correct
636 // even if the document was moved to a different
637 // location. However, we will have a problem if the
638 // document was generated on a different platform.
639 bool isabsolute = FileName::isAbsolute(classname);
640 string const classpath = onlyPath(classname);
641 string const path = isabsolute ? classpath
642 : FileName(addPath(filepath.absFileName(),
643 classpath)).realPath();
644 string const oldpath = isabsolute ? string()
645 : FileName(addPath(origin, classpath)).realPath();
646 tcp = bcl.addLocalLayout(onlyFileName(classname), path, oldpath);
648 // that returns non-empty if a "local" layout file is found.
650 result = to_utf8(makeRelPath(from_utf8(onlyPath(tcp)),
651 from_utf8(filepath.absFileName())));
654 setBaseClass(onlyFileName(tcp));
656 setBaseClass(onlyFileName(classname));
657 // We assume that a tex class exists for local or unknown
658 // layouts so this warning, will only be given for system layouts.
659 if (!baseClass()->isTeXClassAvailable()) {
660 docstring const desc =
661 translateIfPossible(from_utf8(baseClass()->description()));
662 docstring const prereqs =
663 from_utf8(baseClass()->prerequisites());
664 docstring const msg =
665 bformat(_("The selected document class\n"
667 "requires external files that are not available.\n"
668 "The document class can still be used, but the\n"
669 "document cannot be compiled until the following\n"
670 "prerequisites are installed:\n"
672 "See section 3.1.2.2 (Class Availability) of the\n"
673 "User's Guide for more information."), desc, prereqs);
674 frontend::Alert::warning(_("Document class not available"),
677 } else if (token == "\\save_transient_properties") {
678 lex >> save_transient_properties;
679 } else if (token == "\\origin") {
681 origin = lex.getString();
682 string const sysdirprefix = "/systemlyxdir/";
683 if (prefixIs(origin, sysdirprefix)) {
684 origin.replace(0, sysdirprefix.length() - 1,
685 package().system_support().absFileName());
687 } else if (token == "\\begin_preamble") {
689 } else if (token == "\\begin_local_layout") {
690 readLocalLayout(lex, false);
691 } else if (token == "\\begin_forced_local_layout") {
692 readLocalLayout(lex, true);
693 } else if (token == "\\begin_modules") {
695 } else if (token == "\\begin_removed_modules") {
696 readRemovedModules(lex);
697 } else if (token == "\\begin_includeonly") {
698 readIncludeonly(lex);
699 } else if (token == "\\maintain_unincluded_children") {
700 lex >> maintain_unincluded_children;
701 } else if (token == "\\options") {
703 options = lex.getString();
704 } else if (token == "\\use_default_options") {
705 lex >> use_default_options;
706 } else if (token == "\\master") {
708 master = lex.getString();
709 if (!filepath.empty() && FileName::isAbsolute(origin)) {
710 bool const isabs = FileName::isAbsolute(master);
711 FileName const abspath(isabs ? master : origin + master);
712 bool const moved = filepath != FileName(origin);
713 if (moved && abspath.exists()) {
714 docstring const path = isabs
716 : from_utf8(abspath.realPath());
717 docstring const refpath =
718 from_utf8(filepath.absFileName());
719 master = to_utf8(makeRelPath(path, refpath));
722 } else if (token == "\\suppress_date") {
723 lex >> suppress_date;
724 } else if (token == "\\justification") {
725 lex >> justification;
726 } else if (token == "\\language") {
728 } else if (token == "\\language_package") {
730 lang_package = lex.getString();
731 } else if (token == "\\inputencoding") {
733 } else if (token == "\\graphics") {
734 readGraphicsDriver(lex);
735 } else if (token == "\\default_output_format") {
736 lex >> default_output_format;
737 } else if (token == "\\bibtex_command") {
739 bibtex_command = lex.getString();
740 } else if (token == "\\index_command") {
742 index_command = lex.getString();
743 } else if (token == "\\fontencoding") {
745 fontenc = lex.getString();
746 } else if (token == "\\font_roman") {
747 lex >> fonts_roman[0];
748 lex >> fonts_roman[1];
749 } else if (token == "\\font_sans") {
750 lex >> fonts_sans[0];
751 lex >> fonts_sans[1];
752 } else if (token == "\\font_typewriter") {
753 lex >> fonts_typewriter[0];
754 lex >> fonts_typewriter[1];
755 } else if (token == "\\font_math") {
756 lex >> fonts_math[0];
757 lex >> fonts_math[1];
758 } else if (token == "\\font_default_family") {
759 lex >> fonts_default_family;
760 } else if (token == "\\use_non_tex_fonts") {
761 lex >> useNonTeXFonts;
762 } else if (token == "\\font_sc") {
763 lex >> fonts_expert_sc;
764 } else if (token == "\\font_osf") {
765 lex >> fonts_old_figures;
766 } else if (token == "\\font_sf_scale") {
767 lex >> fonts_sans_scale[0];
768 lex >> fonts_sans_scale[1];
769 } else if (token == "\\font_tt_scale") {
770 lex >> fonts_typewriter_scale[0];
771 lex >> fonts_typewriter_scale[1];
772 } else if (token == "\\font_cjk") {
774 } else if (token == "\\paragraph_separation") {
777 paragraph_separation = parseptranslator().find(parsep);
778 } else if (token == "\\paragraph_indentation") {
780 string indentation = lex.getString();
781 pimpl_->indentation = HSpace(indentation);
782 } else if (token == "\\defskip") {
784 string const defskip = lex.getString();
785 pimpl_->defskip = VSpace(defskip);
786 if (pimpl_->defskip.kind() == VSpace::DEFSKIP)
788 pimpl_->defskip = VSpace(VSpace::MEDSKIP);
789 } else if (token == "\\quotes_language") {
792 quotes_language = quoteslangtranslator().find(quotes_lang);
793 } else if (token == "\\papersize") {
796 papersize = papersizetranslator().find(ppsize);
797 } else if (token == "\\use_geometry") {
799 } else if (token == "\\use_package") {
804 use_package(package, packagetranslator().find(use));
805 } else if (token == "\\cite_engine") {
807 vector<string> engine = getVectorFromString(lex.getString());
808 setCiteEngine(engine);
809 } else if (token == "\\cite_engine_type") {
812 cite_engine_type_ = citeenginetypetranslator().find(engine_type);
813 } else if (token == "\\biblio_style") {
815 biblio_style = lex.getString();
816 } else if (token == "\\use_bibtopic") {
818 } else if (token == "\\use_indices") {
820 } else if (token == "\\tracking_changes") {
821 lex >> track_changes;
822 } else if (token == "\\output_changes") {
823 lex >> output_changes;
824 } else if (token == "\\branch") {
826 docstring branch = lex.getDocString();
827 branchlist().add(branch);
830 string const tok = lex.getString();
831 if (tok == "\\end_branch")
833 Branch * branch_ptr = branchlist().find(branch);
834 if (tok == "\\selected") {
837 branch_ptr->setSelected(lex.getInteger());
839 if (tok == "\\filename_suffix") {
842 branch_ptr->setFileNameSuffix(lex.getInteger());
844 if (tok == "\\color") {
846 string color = lex.getString();
848 branch_ptr->setColor(color);
849 // Update also the Color table:
851 color = lcolor.getX11Name(Color_background);
853 lcolor.setColor(to_utf8(branch), color);
856 } else if (token == "\\index") {
858 docstring index = lex.getDocString();
860 indiceslist().add(index);
863 string const tok = lex.getString();
864 if (tok == "\\end_index")
866 Index * index_ptr = indiceslist().find(index);
867 if (tok == "\\shortcut") {
869 shortcut = lex.getDocString();
871 index_ptr->setShortcut(shortcut);
873 if (tok == "\\color") {
875 string color = lex.getString();
877 index_ptr->setColor(color);
878 // Update also the Color table:
880 color = lcolor.getX11Name(Color_background);
882 if (!shortcut.empty())
883 lcolor.setColor(to_utf8(shortcut), color);
886 } else if (token == "\\author") {
888 istringstream ss(lex.getString());
892 } else if (token == "\\paperorientation") {
895 orientation = paperorientationtranslator().find(orient);
896 } else if (token == "\\backgroundcolor") {
898 backgroundcolor = lyx::rgbFromHexName(lex.getString());
899 isbackgroundcolor = true;
900 } else if (token == "\\fontcolor") {
902 fontcolor = lyx::rgbFromHexName(lex.getString());
904 } else if (token == "\\notefontcolor") {
906 string color = lex.getString();
907 notefontcolor = lyx::rgbFromHexName(color);
908 lcolor.setColor("notefontcolor", color);
909 } else if (token == "\\boxbgcolor") {
911 string color = lex.getString();
912 boxbgcolor = lyx::rgbFromHexName(color);
913 lcolor.setColor("boxbgcolor", color);
914 } else if (token == "\\paperwidth") {
916 } else if (token == "\\paperheight") {
918 } else if (token == "\\leftmargin") {
920 } else if (token == "\\topmargin") {
922 } else if (token == "\\rightmargin") {
924 } else if (token == "\\bottommargin") {
926 } else if (token == "\\headheight") {
928 } else if (token == "\\headsep") {
930 } else if (token == "\\footskip") {
932 } else if (token == "\\columnsep") {
934 } else if (token == "\\paperfontsize") {
936 } else if (token == "\\papercolumns") {
938 } else if (token == "\\listings_params") {
941 listings_params = InsetListingsParams(par).params();
942 } else if (token == "\\papersides") {
945 sides = sidestranslator().find(psides);
946 } else if (token == "\\paperpagestyle") {
948 } else if (token == "\\bullet") {
950 } else if (token == "\\bulletLaTeX") {
951 readBulletsLaTeX(lex);
952 } else if (token == "\\secnumdepth") {
954 } else if (token == "\\tocdepth") {
956 } else if (token == "\\spacing") {
960 if (nspacing == "other") {
963 spacing().set(spacetranslator().find(nspacing), tmp_val);
964 } else if (token == "\\float_placement") {
965 lex >> float_placement;
967 } else if (prefixIs(token, "\\pdf_") || token == "\\use_hyperref") {
968 string toktmp = pdfoptions().readToken(lex, token);
969 if (!toktmp.empty()) {
970 lyxerr << "PDFOptions::readToken(): Unknown token: " <<
974 } else if (token == "\\html_math_output") {
977 html_math_output = static_cast<MathOutput>(temp);
978 } else if (token == "\\html_be_strict") {
979 lex >> html_be_strict;
980 } else if (token == "\\html_css_as_file") {
981 lex >> html_css_as_file;
982 } else if (token == "\\html_math_img_scale") {
983 lex >> html_math_img_scale;
984 } else if (token == "\\html_latex_start") {
986 html_latex_start = lex.getString();
987 } else if (token == "\\html_latex_end") {
989 html_latex_end = lex.getString();
990 } else if (token == "\\output_sync") {
992 } else if (token == "\\output_sync_macro") {
993 lex >> output_sync_macro;
994 } else if (token == "\\use_refstyle") {
997 lyxerr << "BufferParams::readToken(): Unknown token: " <<
1007 // Quote argument if it contains spaces
1008 string quoteIfNeeded(string const & str) {
1009 if (contains(str, ' '))
1010 return "\"" + str + "\"";
1016 void BufferParams::writeFile(ostream & os, Buffer const * buf) const
1018 // The top of the file is written by the buffer.
1019 // Prints out the buffer info into the .lyx file given by file
1021 os << "\\save_transient_properties "
1022 << convert<string>(save_transient_properties) << '\n';
1024 // the document directory (must end with a path separator)
1025 // realPath() is used to resolve symlinks, while addPath(..., "")
1026 // ensures a trailing path separator.
1027 string filepath = addPath(buf->fileName().onlyPath().realPath(), "");
1028 string const sysdir = addPath(package().system_support().realPath(), "");
1029 string const relpath =
1030 to_utf8(makeRelPath(from_utf8(filepath), from_utf8(sysdir)));
1031 if (!prefixIs(relpath, "../") && !FileName::isAbsolute(relpath))
1032 filepath = addPath("/systemlyxdir", relpath);
1033 else if (!save_transient_properties || !lyxrc.save_origin)
1034 filepath = "unavailable";
1035 os << "\\origin " << quoteIfNeeded(filepath) << '\n';
1038 os << "\\textclass "
1039 << quoteIfNeeded(buf->includedFilePath(addName(buf->layoutPos(),
1040 baseClass()->name()), "layout"))
1043 // then the preamble
1044 if (!preamble.empty()) {
1045 // remove '\n' from the end of preamble
1046 string const tmppreamble = rtrim(preamble, "\n");
1047 os << "\\begin_preamble\n"
1049 << "\n\\end_preamble\n";
1053 if (!options.empty()) {
1054 os << "\\options " << options << '\n';
1057 // use the class options defined in the layout?
1058 os << "\\use_default_options "
1059 << convert<string>(use_default_options) << "\n";
1061 // the master document
1062 if (!master.empty()) {
1063 os << "\\master " << master << '\n';
1067 if (!removed_modules_.empty()) {
1068 os << "\\begin_removed_modules" << '\n';
1069 list<string>::const_iterator it = removed_modules_.begin();
1070 list<string>::const_iterator en = removed_modules_.end();
1071 for (; it != en; ++it)
1073 os << "\\end_removed_modules" << '\n';
1077 if (!layout_modules_.empty()) {
1078 os << "\\begin_modules" << '\n';
1079 LayoutModuleList::const_iterator it = layout_modules_.begin();
1080 LayoutModuleList::const_iterator en = layout_modules_.end();
1081 for (; it != en; ++it)
1083 os << "\\end_modules" << '\n';
1087 if (!included_children_.empty()) {
1088 os << "\\begin_includeonly" << '\n';
1089 list<string>::const_iterator it = included_children_.begin();
1090 list<string>::const_iterator en = included_children_.end();
1091 for (; it != en; ++it)
1093 os << "\\end_includeonly" << '\n';
1095 os << "\\maintain_unincluded_children "
1096 << convert<string>(maintain_unincluded_children) << '\n';
1098 // local layout information
1099 string const local_layout = getLocalLayout(false);
1100 if (!local_layout.empty()) {
1101 // remove '\n' from the end
1102 string const tmplocal = rtrim(local_layout, "\n");
1103 os << "\\begin_local_layout\n"
1105 << "\n\\end_local_layout\n";
1107 string const forced_local_layout = getLocalLayout(true);
1108 if (!forced_local_layout.empty()) {
1109 // remove '\n' from the end
1110 string const tmplocal = rtrim(forced_local_layout, "\n");
1111 os << "\\begin_forced_local_layout\n"
1113 << "\n\\end_forced_local_layout\n";
1116 // then the text parameters
1117 if (language != ignore_language)
1118 os << "\\language " << language->lang() << '\n';
1119 os << "\\language_package " << lang_package
1120 << "\n\\inputencoding " << inputenc
1121 << "\n\\fontencoding " << fontenc
1122 << "\n\\font_roman \"" << fonts_roman[0]
1123 << "\" \"" << fonts_roman[1] << '"'
1124 << "\n\\font_sans \"" << fonts_sans[0]
1125 << "\" \"" << fonts_sans[1] << '"'
1126 << "\n\\font_typewriter \"" << fonts_typewriter[0]
1127 << "\" \"" << fonts_typewriter[1] << '"'
1128 << "\n\\font_math \"" << fonts_math[0]
1129 << "\" \"" << fonts_math[1] << '"'
1130 << "\n\\font_default_family " << fonts_default_family
1131 << "\n\\use_non_tex_fonts " << convert<string>(useNonTeXFonts)
1132 << "\n\\font_sc " << convert<string>(fonts_expert_sc)
1133 << "\n\\font_osf " << convert<string>(fonts_old_figures)
1134 << "\n\\font_sf_scale " << fonts_sans_scale[0]
1135 << ' ' << fonts_sans_scale[1]
1136 << "\n\\font_tt_scale " << fonts_typewriter_scale[0]
1137 << ' ' << fonts_typewriter_scale[1]
1139 if (!fonts_cjk.empty()) {
1140 os << "\\font_cjk " << fonts_cjk << '\n';
1142 os << "\\graphics " << graphics_driver << '\n';
1143 os << "\\default_output_format " << default_output_format << '\n';
1144 os << "\\output_sync " << output_sync << '\n';
1145 if (!output_sync_macro.empty())
1146 os << "\\output_sync_macro \"" << output_sync_macro << "\"\n";
1147 os << "\\bibtex_command " << bibtex_command << '\n';
1148 os << "\\index_command " << index_command << '\n';
1150 if (!float_placement.empty()) {
1151 os << "\\float_placement " << float_placement << '\n';
1153 os << "\\paperfontsize " << fontsize << '\n';
1155 spacing().writeFile(os);
1156 pdfoptions().writeFile(os);
1158 os << "\\papersize " << string_papersize[papersize]
1159 << "\n\\use_geometry " << convert<string>(use_geometry);
1160 map<string, string> const & packages = auto_packages();
1161 for (map<string, string>::const_iterator it = packages.begin();
1162 it != packages.end(); ++it)
1163 os << "\n\\use_package " << it->first << ' '
1164 << use_package(it->first);
1166 os << "\n\\cite_engine ";
1168 if (!cite_engine_.empty()) {
1169 LayoutModuleList::const_iterator be = cite_engine_.begin();
1170 LayoutModuleList::const_iterator en = cite_engine_.end();
1171 for (LayoutModuleList::const_iterator it = be; it != en; ++it) {
1180 os << "\n\\cite_engine_type " << citeenginetypetranslator().find(cite_engine_type_)
1181 << "\n\\biblio_style " << biblio_style
1182 << "\n\\use_bibtopic " << convert<string>(use_bibtopic)
1183 << "\n\\use_indices " << convert<string>(use_indices)
1184 << "\n\\paperorientation " << string_orientation[orientation]
1185 << "\n\\suppress_date " << convert<string>(suppress_date)
1186 << "\n\\justification " << convert<string>(justification)
1187 << "\n\\use_refstyle " << use_refstyle
1189 if (isbackgroundcolor == true)
1190 os << "\\backgroundcolor " << lyx::X11hexname(backgroundcolor) << '\n';
1191 if (isfontcolor == true)
1192 os << "\\fontcolor " << lyx::X11hexname(fontcolor) << '\n';
1193 if (notefontcolor != lyx::rgbFromHexName("#cccccc"))
1194 os << "\\notefontcolor " << lyx::X11hexname(notefontcolor) << '\n';
1195 if (boxbgcolor != lyx::rgbFromHexName("#ff0000"))
1196 os << "\\boxbgcolor " << lyx::X11hexname(boxbgcolor) << '\n';
1198 BranchList::const_iterator it = branchlist().begin();
1199 BranchList::const_iterator end = branchlist().end();
1200 for (; it != end; ++it) {
1201 os << "\\branch " << to_utf8(it->branch())
1202 << "\n\\selected " << it->isSelected()
1203 << "\n\\filename_suffix " << it->hasFileNameSuffix()
1204 << "\n\\color " << lyx::X11hexname(it->color())
1209 IndicesList::const_iterator iit = indiceslist().begin();
1210 IndicesList::const_iterator iend = indiceslist().end();
1211 for (; iit != iend; ++iit) {
1212 os << "\\index " << to_utf8(iit->index())
1213 << "\n\\shortcut " << to_utf8(iit->shortcut())
1214 << "\n\\color " << lyx::X11hexname(iit->color())
1219 if (!paperwidth.empty())
1220 os << "\\paperwidth "
1221 << VSpace(paperwidth).asLyXCommand() << '\n';
1222 if (!paperheight.empty())
1223 os << "\\paperheight "
1224 << VSpace(paperheight).asLyXCommand() << '\n';
1225 if (!leftmargin.empty())
1226 os << "\\leftmargin "
1227 << VSpace(leftmargin).asLyXCommand() << '\n';
1228 if (!topmargin.empty())
1229 os << "\\topmargin "
1230 << VSpace(topmargin).asLyXCommand() << '\n';
1231 if (!rightmargin.empty())
1232 os << "\\rightmargin "
1233 << VSpace(rightmargin).asLyXCommand() << '\n';
1234 if (!bottommargin.empty())
1235 os << "\\bottommargin "
1236 << VSpace(bottommargin).asLyXCommand() << '\n';
1237 if (!headheight.empty())
1238 os << "\\headheight "
1239 << VSpace(headheight).asLyXCommand() << '\n';
1240 if (!headsep.empty())
1242 << VSpace(headsep).asLyXCommand() << '\n';
1243 if (!footskip.empty())
1245 << VSpace(footskip).asLyXCommand() << '\n';
1246 if (!columnsep.empty())
1247 os << "\\columnsep "
1248 << VSpace(columnsep).asLyXCommand() << '\n';
1249 os << "\\secnumdepth " << secnumdepth
1250 << "\n\\tocdepth " << tocdepth
1251 << "\n\\paragraph_separation "
1252 << string_paragraph_separation[paragraph_separation];
1253 if (!paragraph_separation)
1254 os << "\n\\paragraph_indentation " << getIndentation().asLyXCommand();
1256 os << "\n\\defskip " << getDefSkip().asLyXCommand();
1257 os << "\n\\quotes_language "
1258 << string_quotes_language[quotes_language]
1259 << "\n\\papercolumns " << columns
1260 << "\n\\papersides " << sides
1261 << "\n\\paperpagestyle " << pagestyle << '\n';
1262 if (!listings_params.empty())
1263 os << "\\listings_params \"" <<
1264 InsetListingsParams(listings_params).encodedString() << "\"\n";
1265 for (int i = 0; i < 4; ++i) {
1266 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1267 if (user_defined_bullet(i).getFont() != -1) {
1268 os << "\\bullet " << i << " "
1269 << user_defined_bullet(i).getFont() << " "
1270 << user_defined_bullet(i).getCharacter() << " "
1271 << user_defined_bullet(i).getSize() << "\n";
1275 os << "\\bulletLaTeX " << i << " \""
1276 << lyx::to_ascii(user_defined_bullet(i).getText())
1282 os << "\\tracking_changes "
1283 << (save_transient_properties ? convert<string>(track_changes) : "false")
1286 os << "\\output_changes "
1287 << (save_transient_properties ? convert<string>(output_changes) : "false")
1290 os << "\\html_math_output " << html_math_output << '\n'
1291 << "\\html_css_as_file " << html_css_as_file << '\n'
1292 << "\\html_be_strict " << convert<string>(html_be_strict) << '\n';
1294 if (html_math_img_scale != 1.0)
1295 os << "\\html_math_img_scale " << convert<string>(html_math_img_scale) << '\n';
1296 if (!html_latex_start.empty())
1297 os << "\\html_latex_start " << html_latex_start << '\n';
1298 if (!html_latex_end.empty())
1299 os << "\\html_latex_end " << html_latex_end << '\n';
1301 os << pimpl_->authorlist;
1305 void BufferParams::validate(LaTeXFeatures & features) const
1307 features.require(documentClass().requires());
1309 if (columns > 1 && language->rightToLeft())
1310 features.require("rtloutputdblcol");
1312 if (output_changes) {
1313 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1314 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1315 LaTeXFeatures::isAvailable("xcolor");
1317 switch (features.runparams().flavor) {
1318 case OutputParams::LATEX:
1319 case OutputParams::DVILUATEX:
1321 features.require("ct-dvipost");
1322 features.require("dvipost");
1323 } else if (xcolorulem) {
1324 features.require("ct-xcolor-ulem");
1325 features.require("ulem");
1326 features.require("xcolor");
1328 features.require("ct-none");
1331 case OutputParams::LUATEX:
1332 case OutputParams::PDFLATEX:
1333 case OutputParams::XETEX:
1335 features.require("ct-xcolor-ulem");
1336 features.require("ulem");
1337 features.require("xcolor");
1338 // improves color handling in PDF output
1339 features.require("pdfcolmk");
1341 features.require("ct-none");
1349 // Floats with 'Here definitely' as default setting.
1350 if (float_placement.find('H') != string::npos)
1351 features.require("float");
1353 for (PackageMap::const_iterator it = use_packages.begin();
1354 it != use_packages.end(); ++it) {
1355 if (it->first == "amsmath") {
1356 // AMS Style is at document level
1357 if (it->second == package_on ||
1358 features.isProvided("amsmath"))
1359 features.require(it->first);
1360 } else if (it->second == package_on)
1361 features.require(it->first);
1364 // Document-level line spacing
1365 if (spacing().getSpace() != Spacing::Single && !spacing().isDefault())
1366 features.require("setspace");
1368 // the bullet shapes are buffer level not paragraph level
1369 // so they are tested here
1370 for (int i = 0; i < 4; ++i) {
1371 if (user_defined_bullet(i) == ITEMIZE_DEFAULTS[i])
1373 int const font = user_defined_bullet(i).getFont();
1375 int const c = user_defined_bullet(i).getCharacter();
1381 features.require("latexsym");
1383 } else if (font == 1) {
1384 features.require("amssymb");
1385 } else if (font >= 2 && font <= 5) {
1386 features.require("pifont");
1390 if (pdfoptions().use_hyperref) {
1391 features.require("hyperref");
1392 // due to interferences with babel and hyperref, the color package has to
1393 // be loaded after hyperref when hyperref is used with the colorlinks
1394 // option, see http://www.lyx.org/trac/ticket/5291
1395 if (pdfoptions().colorlinks)
1396 features.require("color");
1398 if (!listings_params.empty()) {
1399 // do not test validity because listings_params is
1400 // supposed to be valid
1402 InsetListingsParams(listings_params).separatedParams(true);
1403 // we can't support all packages, but we should load the color package
1404 if (par.find("\\color", 0) != string::npos)
1405 features.require("color");
1408 // some languages are only available via polyglossia
1409 if (features.hasPolyglossiaExclusiveLanguages())
1410 features.require("polyglossia");
1412 if (useNonTeXFonts && fontsMath() != "auto")
1413 features.require("unicode-math");
1415 if (!language->requires().empty())
1416 features.require(language->requires());
1420 bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
1421 FileName const & filepath) const
1423 // http://www.tug.org/texmf-dist/doc/latex/base/fixltx2e.pdf
1424 // !! To use the Fix-cm package, load it before \documentclass, and use the command
1425 // \RequirePackage to do so, rather than the normal \usepackage
1426 // Do not try to load any other package before the document class, unless you
1427 // have a thorough understanding of the LATEX internals and know exactly what you
1429 if (features.mustProvide("fix-cm"))
1430 os << "\\RequirePackage{fix-cm}\n";
1431 // Likewise for fixltx2e. If other packages conflict with this policy,
1432 // treat it as a package bug (and report it!)
1433 // See http://www.latex-project.org/cgi-bin/ltxbugs2html?pr=latex/4407
1434 if (features.mustProvide("fixltx2e"))
1435 os << "\\RequirePackage{fixltx2e}\n";
1437 os << "\\documentclass";
1439 DocumentClass const & tclass = documentClass();
1441 ostringstream clsoptions; // the document class options.
1443 if (tokenPos(tclass.opt_fontsize(),
1444 '|', fontsize) >= 0) {
1445 // only write if existing in list (and not default)
1446 clsoptions << fontsize << "pt,";
1449 // all paper sizes except of A4, A5, B5 and the US sizes need the
1451 bool nonstandard_papersize = papersize != PAPER_DEFAULT
1452 && papersize != PAPER_USLETTER
1453 && papersize != PAPER_USLEGAL
1454 && papersize != PAPER_USEXECUTIVE
1455 && papersize != PAPER_A4
1456 && papersize != PAPER_A5
1457 && papersize != PAPER_B5;
1459 if (!use_geometry) {
1460 switch (papersize) {
1462 clsoptions << "a4paper,";
1464 case PAPER_USLETTER:
1465 clsoptions << "letterpaper,";
1468 clsoptions << "a5paper,";
1471 clsoptions << "b5paper,";
1473 case PAPER_USEXECUTIVE:
1474 clsoptions << "executivepaper,";
1477 clsoptions << "legalpaper,";
1511 if (sides != tclass.sides()) {
1514 clsoptions << "oneside,";
1517 clsoptions << "twoside,";
1523 if (columns != tclass.columns()) {
1525 clsoptions << "twocolumn,";
1527 clsoptions << "onecolumn,";
1531 && orientation == ORIENTATION_LANDSCAPE)
1532 clsoptions << "landscape,";
1534 // language should be a parameter to \documentclass
1535 if (language->babel() == "hebrew"
1536 && default_language->babel() != "hebrew")
1537 // This seems necessary
1538 features.useLanguage(default_language);
1540 ostringstream language_options;
1541 bool const use_babel = features.useBabel() && !features.isProvided("babel");
1542 bool const use_polyglossia = features.usePolyglossia();
1543 bool const global = lyxrc.language_global_options;
1544 if (use_babel || (use_polyglossia && global)) {
1545 language_options << features.getBabelLanguages();
1546 if (!language->babel().empty()) {
1547 if (!language_options.str().empty())
1548 language_options << ',';
1549 language_options << language->babel();
1551 if (global && !features.needBabelLangOptions()
1552 && !language_options.str().empty())
1553 clsoptions << language_options.str() << ',';
1556 // the predefined options from the layout
1557 if (use_default_options && !tclass.options().empty())
1558 clsoptions << tclass.options() << ',';
1560 // the user-defined options
1561 if (!options.empty()) {
1562 clsoptions << options << ',';
1565 string strOptions(clsoptions.str());
1566 if (!strOptions.empty()) {
1567 strOptions = rtrim(strOptions, ",");
1569 os << '[' << from_utf8(strOptions) << ']';
1572 os << '{' << from_ascii(tclass.latexname()) << "}\n";
1573 // end of \documentclass defs
1575 // if we use fontspec or newtxmath, we have to load the AMS packages here
1576 string const ams = features.loadAMSPackages();
1577 bool const ot1 = (font_encoding() == "default" || font_encoding() == "OT1");
1578 bool const use_newtxmath =
1579 theLaTeXFonts().getLaTeXFont(from_ascii(fontsMath())).getUsedPackage(
1580 ot1, false, false) == "newtxmath";
1581 if ((useNonTeXFonts || use_newtxmath) && !ams.empty())
1582 os << from_ascii(ams);
1584 if (useNonTeXFonts) {
1585 os << "\\usepackage{fontspec}\n";
1586 if (features.mustProvide("unicode-math")
1587 && features.isAvailable("unicode-math"))
1588 os << "\\usepackage{unicode-math}\n";
1591 // font selection must be done before loading fontenc.sty
1592 string const fonts = loadFonts(features);
1594 os << from_utf8(fonts);
1596 if (fonts_default_family != "default")
1597 os << "\\renewcommand{\\familydefault}{\\"
1598 << from_ascii(fonts_default_family) << "}\n";
1600 // set font encoding
1601 // XeTeX and LuaTeX (with OS fonts) do not need fontenc
1602 if (!useNonTeXFonts && !features.isProvided("fontenc")
1603 && font_encoding() != "default") {
1604 // get main font encodings
1605 vector<string> fontencs = font_encodings();
1606 // get font encodings of secondary languages
1607 features.getFontEncodings(fontencs);
1608 if (!fontencs.empty()) {
1609 os << "\\usepackage["
1610 << from_ascii(getStringFromVector(fontencs))
1615 // handle inputenc etc.
1616 writeEncodingPreamble(os, features);
1619 if (!features.runparams().includeall && !included_children_.empty()) {
1620 os << "\\includeonly{";
1621 list<string>::const_iterator it = included_children_.begin();
1622 list<string>::const_iterator en = included_children_.end();
1624 for (; it != en; ++it) {
1625 string incfile = *it;
1626 FileName inc = makeAbsPath(incfile, filepath.absFileName());
1627 string mangled = DocFileName(changeExtension(inc.absFileName(), ".tex")).
1629 if (!features.runparams().nice)
1631 // \includeonly doesn't want an extension
1632 incfile = changeExtension(incfile, string());
1633 incfile = support::latex_path(incfile);
1634 if (!incfile.empty()) {
1637 os << from_utf8(incfile);
1644 if (!features.isProvided("geometry")
1645 && (use_geometry || nonstandard_papersize)) {
1646 odocstringstream ods;
1647 if (!getGraphicsDriver("geometry").empty())
1648 ods << getGraphicsDriver("geometry");
1649 if (orientation == ORIENTATION_LANDSCAPE)
1650 ods << ",landscape";
1651 switch (papersize) {
1653 if (!paperwidth.empty())
1654 ods << ",paperwidth="
1655 << from_ascii(paperwidth);
1656 if (!paperheight.empty())
1657 ods << ",paperheight="
1658 << from_ascii(paperheight);
1660 case PAPER_USLETTER:
1661 ods << ",letterpaper";
1664 ods << ",legalpaper";
1666 case PAPER_USEXECUTIVE:
1667 ods << ",executivepaper";
1756 docstring const g_options = trim(ods.str(), ",");
1757 os << "\\usepackage";
1758 if (!g_options.empty())
1759 os << '[' << g_options << ']';
1760 os << "{geometry}\n";
1761 // output this only if use_geometry is true
1763 os << "\\geometry{verbose";
1764 if (!topmargin.empty())
1765 os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1766 if (!bottommargin.empty())
1767 os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1768 if (!leftmargin.empty())
1769 os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1770 if (!rightmargin.empty())
1771 os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1772 if (!headheight.empty())
1773 os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1774 if (!headsep.empty())
1775 os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1776 if (!footskip.empty())
1777 os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1778 if (!columnsep.empty())
1779 os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
1782 } else if (orientation == ORIENTATION_LANDSCAPE
1783 || papersize != PAPER_DEFAULT) {
1784 features.require("papersize");
1787 if (tokenPos(tclass.opt_pagestyle(), '|', pagestyle) >= 0) {
1788 if (pagestyle == "fancy")
1789 os << "\\usepackage{fancyhdr}\n";
1790 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1793 // only output when the background color is not default
1794 if (isbackgroundcolor == true) {
1795 // only require color here, the background color will be defined
1796 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1798 features.require("color");
1799 features.require("pagecolor");
1802 // only output when the font color is not default
1803 if (isfontcolor == true) {
1804 // only require color here, the font color will be defined
1805 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1807 features.require("color");
1808 features.require("fontcolor");
1811 // Only if class has a ToC hierarchy
1812 if (tclass.hasTocLevels()) {
1813 if (secnumdepth != tclass.secnumdepth()) {
1814 os << "\\setcounter{secnumdepth}{"
1818 if (tocdepth != tclass.tocdepth()) {
1819 os << "\\setcounter{tocdepth}{"
1825 if (paragraph_separation) {
1826 // when skip separation
1827 switch (getDefSkip().kind()) {
1828 case VSpace::SMALLSKIP:
1829 os << "\\setlength{\\parskip}{\\smallskipamount}\n";
1831 case VSpace::MEDSKIP:
1832 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1834 case VSpace::BIGSKIP:
1835 os << "\\setlength{\\parskip}{\\bigskipamount}\n";
1837 case VSpace::LENGTH:
1838 os << "\\setlength{\\parskip}{"
1839 << from_utf8(getDefSkip().length().asLatexString())
1842 default: // should never happen // Then delete it.
1843 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1846 os << "\\setlength{\\parindent}{0pt}\n";
1848 // when separation by indentation
1849 // only output something when a width is given
1850 if (getIndentation().asLyXCommand() != "default") {
1851 os << "\\setlength{\\parindent}{"
1852 << from_utf8(getIndentation().asLatexCommand())
1857 // Now insert the LyX specific LaTeX commands...
1858 docstring lyxpreamble;
1859 features.resolveAlternatives();
1862 if (!output_sync_macro.empty())
1863 lyxpreamble += from_utf8(output_sync_macro) +"\n";
1864 else if (features.runparams().flavor == OutputParams::LATEX)
1865 lyxpreamble += "\\usepackage[active]{srcltx}\n";
1866 else if (features.runparams().flavor == OutputParams::PDFLATEX)
1867 lyxpreamble += "\\synctex=-1\n";
1870 // The package options (via \PassOptionsToPackage)
1871 lyxpreamble += from_ascii(features.getPackageOptions());
1873 // due to interferences with babel and hyperref, the color package has to
1874 // be loaded (when it is not already loaded) before babel when hyperref
1875 // is used with the colorlinks option, see
1876 // http://www.lyx.org/trac/ticket/5291
1877 // we decided therefore to load color always before babel, see
1878 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
1879 lyxpreamble += from_ascii(features.getColorOptions());
1881 // If we use hyperref, jurabib, japanese, varioref or vietnamese,
1882 // we have to call babel before
1884 && (features.isRequired("jurabib")
1885 || features.isRequired("hyperref")
1886 || features.isRequired("varioref")
1887 || features.isRequired("vietnamese")
1888 || features.isRequired("japanese"))) {
1890 lyxpreamble += from_utf8(features.getBabelPresettings());
1891 lyxpreamble += from_utf8(babelCall(language_options.str(),
1892 features.needBabelLangOptions())) + '\n';
1893 lyxpreamble += from_utf8(features.getBabelPostsettings());
1896 // The optional packages;
1897 lyxpreamble += from_ascii(features.getPackages());
1899 // Additional Indices
1900 if (features.isRequired("splitidx")) {
1901 IndicesList::const_iterator iit = indiceslist().begin();
1902 IndicesList::const_iterator iend = indiceslist().end();
1903 for (; iit != iend; ++iit) {
1904 pair<docstring, docstring> indexname_latex =
1905 features.runparams().encoding->latexString(iit->index(),
1906 features.runparams().dryrun);
1907 if (!indexname_latex.second.empty()) {
1908 // issue a warning about omitted characters
1909 // FIXME: should be passed to the error dialog
1910 frontend::Alert::warning(_("Uncodable characters"),
1911 bformat(_("The following characters that are used in an index name are not\n"
1912 "representable in the current encoding and therefore have been omitted:\n%1$s."),
1913 indexname_latex.second));
1915 lyxpreamble += "\\newindex[";
1916 lyxpreamble += indexname_latex.first;
1917 lyxpreamble += "]{";
1918 lyxpreamble += escape(iit->shortcut());
1919 lyxpreamble += "}\n";
1924 lyxpreamble += from_utf8(spacing().writePreamble(features.isProvided("SetSpace")));
1927 // * Hyperref manual: "Make sure it comes last of your loaded
1928 // packages, to give it a fighting chance of not being over-written,
1929 // since its job is to redefine many LaTeX commands."
1930 // * Email from Heiko Oberdiek: "It is usually better to load babel
1931 // before hyperref. Then hyperref has a chance to detect babel.
1932 // * Has to be loaded before the "LyX specific LaTeX commands" to
1933 // avoid errors with algorithm floats.
1934 // use hyperref explicitly if it is required
1935 if (features.isRequired("hyperref")) {
1936 // pass what we have to stream here, since we need
1937 // to access the stream itself in PDFOptions.
1940 OutputParams tmp_params = features.runparams();
1941 pdfoptions().writeLaTeX(tmp_params, os,
1942 features.isProvided("hyperref"));
1943 // set back for the rest
1944 lyxpreamble.clear();
1945 // correctly break URLs with hyperref and dvi output
1946 if (features.runparams().flavor == OutputParams::LATEX
1947 && features.isAvailable("breakurl"))
1948 lyxpreamble += "\\usepackage{breakurl}\n";
1949 } else if (features.isRequired("nameref"))
1950 // hyperref loads this automatically
1951 lyxpreamble += "\\usepackage{nameref}\n";
1953 // bibtopic needs to be loaded after hyperref.
1954 // the dot provides the aux file naming which LyX can detect.
1955 if (features.mustProvide("bibtopic"))
1956 lyxpreamble += "\\usepackage[dot]{bibtopic}\n";
1958 // Will be surrounded by \makeatletter and \makeatother when not empty
1959 docstring atlyxpreamble;
1961 // Some macros LyX will need
1962 docstring tmppreamble(features.getMacros());
1964 if (!tmppreamble.empty())
1965 atlyxpreamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1966 "LyX specific LaTeX commands.\n"
1967 + tmppreamble + '\n';
1969 // the text class specific preamble
1970 tmppreamble = features.getTClassPreamble();
1971 if (!tmppreamble.empty())
1972 atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1973 "Textclass specific LaTeX commands.\n"
1974 + tmppreamble + '\n';
1976 // suppress date if selected
1977 // use \@ifundefined because we cannot be sure that every document class
1978 // has a \date command
1980 atlyxpreamble += "\\@ifundefined{date}{}{\\date{}}\n";
1982 /* the user-defined preamble */
1983 if (!containsOnly(preamble, " \n\t")) {
1985 atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1986 "User specified LaTeX commands.\n";
1988 // Check if the user preamble contains uncodable glyphs
1989 docstring const u_preamble = from_utf8(preamble);
1990 odocstringstream user_preamble;
1991 docstring uncodable_glyphs;
1992 Encoding const * const enc = features.runparams().encoding;
1994 for (size_t n = 0; n < u_preamble.size(); ++n) {
1995 char_type c = u_preamble[n];
1996 if (!enc->encodable(c)) {
1997 docstring const glyph(1, c);
1998 LYXERR0("Uncodable character '"
2000 << "' in user preamble!");
2001 uncodable_glyphs += glyph;
2002 if (features.runparams().dryrun) {
2003 user_preamble << "<" << _("LyX Warning: ")
2004 << _("uncodable character") << " '";
2005 user_preamble.put(c);
2006 user_preamble << "'>";
2009 user_preamble.put(c);
2012 user_preamble << u_preamble;
2014 // On BUFFER_VIEW|UPDATE, warn user if we found uncodable glyphs
2015 if (!features.runparams().dryrun && !uncodable_glyphs.empty()) {
2016 frontend::Alert::warning(
2017 _("Uncodable character in user preamble"),
2019 _("The user preamble of your document contains glyphs "
2020 "that are unknown in the current document encoding "
2021 "(namely %1$s).\nThese glyphs are omitted "
2022 " from the output, which may result in "
2023 "incomplete output."
2024 "\n\nPlease select an appropriate "
2025 "document encoding\n"
2026 "(such as utf8) or change the "
2027 "preamble code accordingly."),
2030 atlyxpreamble += user_preamble.str() + '\n';
2033 // footmisc must be loaded after setspace
2034 // Load it here to avoid clashes with footmisc loaded in the user
2035 // preamble. For that reason we also pass the options via
2036 // \PassOptionsToPackage in getPreamble() and not here.
2037 if (features.mustProvide("footmisc"))
2038 atlyxpreamble += "\\usepackage{footmisc}\n";
2040 // subfig loads internally the LaTeX package "caption". As
2041 // caption is a very popular package, users will load it in
2042 // the preamble. Therefore we must load subfig behind the
2043 // user-defined preamble and check if the caption package was
2044 // loaded or not. For the case that caption is loaded before
2045 // subfig, there is the subfig option "caption=false". This
2046 // option also works when a koma-script class is used and
2047 // koma's own caption commands are used instead of caption. We
2048 // use \PassOptionsToPackage here because the user could have
2049 // already loaded subfig in the preamble.
2050 if (features.isRequired("subfig")) {
2051 atlyxpreamble += "\\@ifundefined{showcaptionsetup}{}{%\n"
2052 " \\PassOptionsToPackage{caption=false}{subfig}}\n"
2053 "\\usepackage{subfig}\n";
2056 // Itemize bullet settings need to be last in case the user
2057 // defines their own bullets that use a package included
2058 // in the user-defined preamble -- ARRae
2059 // Actually it has to be done much later than that
2060 // since some packages like frenchb make modifications
2061 // at \begin{document} time -- JMarc
2062 docstring bullets_def;
2063 for (int i = 0; i < 4; ++i) {
2064 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
2065 if (bullets_def.empty())
2066 bullets_def += "\\AtBeginDocument{\n";
2067 bullets_def += " \\def\\labelitemi";
2069 // `i' is one less than the item to modify
2076 bullets_def += "ii";
2082 bullets_def += '{' +
2083 user_defined_bullet(i).getText()
2088 if (!bullets_def.empty())
2089 atlyxpreamble += bullets_def + "}\n\n";
2091 if (!atlyxpreamble.empty())
2092 lyxpreamble += "\n\\makeatletter\n"
2093 + atlyxpreamble + "\\makeatother\n\n";
2095 // We try to load babel late, in case it interferes with other packages.
2096 // Jurabib, hyperref, varioref, bicaption and listings (bug 8995) have to be
2097 // called after babel, though.
2098 if (use_babel && !features.isRequired("jurabib")
2099 && !features.isRequired("hyperref")
2100 && !features.isRequired("varioref")
2101 && !features.isRequired("vietnamese")
2102 && !features.isRequired("japanese")) {
2104 lyxpreamble += from_utf8(features.getBabelPresettings());
2105 lyxpreamble += from_utf8(babelCall(language_options.str(),
2106 features.needBabelLangOptions())) + '\n';
2107 lyxpreamble += from_utf8(features.getBabelPostsettings());
2109 if (features.isRequired("bicaption"))
2110 lyxpreamble += "\\usepackage{bicaption}\n";
2111 if (!listings_params.empty() || features.isRequired("listings"))
2112 lyxpreamble += "\\usepackage{listings}\n";
2113 if (!listings_params.empty()) {
2114 lyxpreamble += "\\lstset{";
2115 // do not test validity because listings_params is
2116 // supposed to be valid
2118 InsetListingsParams(listings_params).separatedParams(true);
2119 lyxpreamble += from_utf8(par);
2120 lyxpreamble += "}\n";
2123 // xunicode needs to be loaded at least after amsmath, amssymb,
2124 // esint and the other packages that provide special glyphs
2125 if (features.runparams().flavor == OutputParams::XETEX
2127 lyxpreamble += "\\usepackage{xunicode}\n";
2129 // Polyglossia must be loaded last
2130 if (use_polyglossia) {
2132 lyxpreamble += "\\usepackage{polyglossia}\n";
2133 // set the main language
2134 lyxpreamble += "\\setdefaultlanguage";
2135 if (!language->polyglossiaOpts().empty())
2136 lyxpreamble += "[" + from_ascii(language->polyglossiaOpts()) + "]";
2137 lyxpreamble += "{" + from_ascii(language->polyglossia()) + "}\n";
2138 // now setup the other languages
2139 std::map<std::string, std::string> const polylangs =
2140 features.getPolyglossiaLanguages();
2141 for (std::map<std::string, std::string>::const_iterator mit = polylangs.begin();
2142 mit != polylangs.end() ; ++mit) {
2143 lyxpreamble += "\\setotherlanguage";
2144 if (!mit->second.empty())
2145 lyxpreamble += "[" + from_ascii(mit->second) + "]";
2146 lyxpreamble += "{" + from_ascii(mit->first) + "}\n";
2150 // Load custom language package here
2151 if (features.langPackage() == LaTeXFeatures::LANG_PACK_CUSTOM) {
2152 if (lang_package == "default")
2153 lyxpreamble += from_utf8(lyxrc.language_custom_package);
2155 lyxpreamble += from_utf8(lang_package);
2156 lyxpreamble += '\n';
2159 docstring const i18npreamble =
2160 features.getTClassI18nPreamble(use_babel, use_polyglossia);
2161 if (!i18npreamble.empty())
2162 lyxpreamble += i18npreamble + '\n';
2170 void BufferParams::useClassDefaults()
2172 DocumentClass const & tclass = documentClass();
2174 sides = tclass.sides();
2175 columns = tclass.columns();
2176 pagestyle = tclass.pagestyle();
2177 use_default_options = true;
2178 // Only if class has a ToC hierarchy
2179 if (tclass.hasTocLevels()) {
2180 secnumdepth = tclass.secnumdepth();
2181 tocdepth = tclass.tocdepth();
2186 bool BufferParams::hasClassDefaults() const
2188 DocumentClass const & tclass = documentClass();
2190 return sides == tclass.sides()
2191 && columns == tclass.columns()
2192 && pagestyle == tclass.pagestyle()
2193 && use_default_options
2194 && secnumdepth == tclass.secnumdepth()
2195 && tocdepth == tclass.tocdepth();
2199 DocumentClass const & BufferParams::documentClass() const
2201 return *doc_class_.get();
2205 DocumentClassConstPtr BufferParams::documentClassPtr() const
2211 void BufferParams::setDocumentClass(DocumentClassConstPtr tc)
2213 // evil, but this function is evil
2214 doc_class_ = const_pointer_cast<DocumentClass>(tc);
2218 bool BufferParams::setBaseClass(string const & classname)
2220 LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
2221 LayoutFileList & bcl = LayoutFileList::get();
2222 if (!bcl.haveClass(classname)) {
2224 bformat(_("The layout file:\n"
2226 "could not be found. A default textclass with default\n"
2227 "layouts will be used. LyX will not be able to produce\n"
2229 from_utf8(classname));
2230 frontend::Alert::error(_("Document class not found"), s);
2231 bcl.addEmptyClass(classname);
2234 bool const success = bcl[classname].load();
2237 bformat(_("Due to some error in it, the layout file:\n"
2239 "could not be loaded. A default textclass with default\n"
2240 "layouts will be used. LyX will not be able to produce\n"
2242 from_utf8(classname));
2243 frontend::Alert::error(_("Could not load class"), s);
2244 bcl.addEmptyClass(classname);
2247 pimpl_->baseClass_ = classname;
2248 layout_modules_.adaptToBaseClass(baseClass(), removed_modules_);
2253 LayoutFile const * BufferParams::baseClass() const
2255 if (LayoutFileList::get().haveClass(pimpl_->baseClass_))
2256 return &(LayoutFileList::get()[pimpl_->baseClass_]);
2262 LayoutFileIndex const & BufferParams::baseClassID() const
2264 return pimpl_->baseClass_;
2268 void BufferParams::makeDocumentClass(bool const clone)
2273 LayoutModuleList mods;
2274 LayoutModuleList::iterator it = layout_modules_.begin();
2275 LayoutModuleList::iterator en = layout_modules_.end();
2276 for (; it != en; ++it)
2277 mods.push_back(*it);
2279 it = cite_engine_.begin();
2280 en = cite_engine_.end();
2281 for (; it != en; ++it)
2282 mods.push_back(*it);
2284 doc_class_ = getDocumentClass(*baseClass(), mods, clone);
2286 TextClass::ReturnValues success = TextClass::OK;
2287 if (!forced_local_layout_.empty())
2288 success = doc_class_->read(forced_local_layout_, TextClass::MODULE);
2289 if (!local_layout_.empty() &&
2290 (success == TextClass::OK || success == TextClass::OK_OLDFORMAT))
2291 success = doc_class_->read(local_layout_, TextClass::MODULE);
2292 if (success != TextClass::OK && success != TextClass::OK_OLDFORMAT) {
2293 docstring const msg = _("Error reading internal layout information");
2294 frontend::Alert::warning(_("Read Error"), msg);
2299 bool BufferParams::layoutModuleCanBeAdded(string const & modName) const
2301 return layout_modules_.moduleCanBeAdded(modName, baseClass());
2305 bool BufferParams::citationModuleCanBeAdded(string const & modName) const
2307 return cite_engine_.moduleCanBeAdded(modName, baseClass());
2311 std::string BufferParams::getLocalLayout(bool forced) const
2314 return doc_class_->forcedLayouts();
2316 return local_layout_;
2320 void BufferParams::setLocalLayout(string const & layout, bool forced)
2323 forced_local_layout_ = layout;
2325 local_layout_ = layout;
2329 bool BufferParams::addLayoutModule(string const & modName)
2331 LayoutModuleList::const_iterator it = layout_modules_.begin();
2332 LayoutModuleList::const_iterator end = layout_modules_.end();
2333 for (; it != end; ++it)
2336 layout_modules_.push_back(modName);
2341 string BufferParams::bufferFormat() const
2343 string format = documentClass().outputFormat();
2344 if (format == "latex") {
2346 return "xetex"; // actually "xetex or luatex"
2347 if (encoding().package() == Encoding::japanese)
2354 bool BufferParams::isExportable(string const & format) const
2356 vector<string> backs = backends();
2357 for (vector<string>::const_iterator it = backs.begin();
2358 it != backs.end(); ++it)
2359 if (theConverters().isReachable(*it, format))
2365 vector<Format const *> BufferParams::exportableFormats(bool only_viewable) const
2367 vector<string> const backs = backends();
2368 set<string> excludes;
2369 if (useNonTeXFonts) {
2370 excludes.insert("latex");
2371 excludes.insert("pdflatex");
2373 vector<Format const *> result =
2374 theConverters().getReachable(backs[0], only_viewable, true, excludes);
2375 for (vector<string>::const_iterator it = backs.begin() + 1;
2376 it != backs.end(); ++it) {
2377 vector<Format const *> r =
2378 theConverters().getReachable(*it, only_viewable, false, excludes);
2379 result.insert(result.end(), r.begin(), r.end());
2385 bool BufferParams::isExportableFormat(string const & format) const
2387 typedef vector<Format const *> Formats;
2389 formats = exportableFormats(true);
2390 Formats::const_iterator fit = formats.begin();
2391 Formats::const_iterator end = formats.end();
2392 for (; fit != end ; ++fit) {
2393 if ((*fit)->name() == format)
2400 vector<string> BufferParams::backends() const
2403 string const buffmt = bufferFormat();
2405 // FIXME: Don't hardcode format names here, but use a flag
2406 if (buffmt == "latex") {
2407 if (!useNonTeXFonts) {
2408 v.push_back("pdflatex");
2409 v.push_back("latex");
2411 v.push_back("luatex");
2412 v.push_back("dviluatex");
2413 v.push_back("xetex");
2414 } else if (buffmt == "xetex") {
2415 v.push_back("xetex");
2416 // FIXME: need to test all languages (bug 8205)
2417 if (!language || !language->isPolyglossiaExclusive()) {
2418 v.push_back("luatex");
2419 v.push_back("dviluatex");
2422 v.push_back(buffmt);
2424 v.push_back("xhtml");
2425 v.push_back("text");
2431 OutputParams::FLAVOR BufferParams::getOutputFlavor(string const & format) const
2433 string const dformat = (format.empty() || format == "default") ?
2434 getDefaultOutputFormat() : format;
2435 DefaultFlavorCache::const_iterator it =
2436 default_flavors_.find(dformat);
2438 if (it != default_flavors_.end())
2441 OutputParams::FLAVOR result = OutputParams::LATEX;
2443 // FIXME It'd be better not to hardcode this, but to do
2444 // something with formats.
2445 if (dformat == "xhtml")
2446 result = OutputParams::HTML;
2447 else if (dformat == "text")
2448 result = OutputParams::TEXT;
2449 else if (dformat == "lyx")
2450 result = OutputParams::LYX;
2451 else if (dformat == "pdflatex")
2452 result = OutputParams::PDFLATEX;
2453 else if (dformat == "xetex")
2454 result = OutputParams::XETEX;
2455 else if (dformat == "luatex")
2456 result = OutputParams::LUATEX;
2457 else if (dformat == "dviluatex")
2458 result = OutputParams::DVILUATEX;
2460 // Try to determine flavor of default output format
2461 vector<string> backs = backends();
2462 if (find(backs.begin(), backs.end(), dformat) == backs.end()) {
2463 // Get shortest path to format
2464 Graph::EdgePath path;
2465 for (vector<string>::const_iterator it = backs.begin();
2466 it != backs.end(); ++it) {
2467 Graph::EdgePath p = theConverters().getPath(*it, dformat);
2468 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2473 result = theConverters().getFlavor(path);
2476 // cache this flavor
2477 default_flavors_[dformat] = result;
2482 string BufferParams::getDefaultOutputFormat() const
2484 if (!default_output_format.empty()
2485 && default_output_format != "default")
2486 return default_output_format;
2488 || encoding().package() == Encoding::japanese) {
2489 vector<Format const *> const formats = exportableFormats(true);
2490 if (formats.empty())
2492 // return the first we find
2493 return formats.front()->name();
2496 return lyxrc.default_otf_view_format;
2497 return lyxrc.default_view_format;
2500 Font const BufferParams::getFont() const
2502 FontInfo f = documentClass().defaultfont();
2503 if (fonts_default_family == "rmdefault")
2504 f.setFamily(ROMAN_FAMILY);
2505 else if (fonts_default_family == "sfdefault")
2506 f.setFamily(SANS_FAMILY);
2507 else if (fonts_default_family == "ttdefault")
2508 f.setFamily(TYPEWRITER_FAMILY);
2509 return Font(f, language);
2513 InsetQuotes::QuoteLanguage BufferParams::getQuoteStyle(string const & qs) const
2515 return quoteslangtranslator().find(qs);
2519 bool BufferParams::isLatex() const
2521 return documentClass().outputType() == LATEX;
2525 bool BufferParams::isLiterate() const
2527 return documentClass().outputType() == LITERATE;
2531 bool BufferParams::isDocBook() const
2533 return documentClass().outputType() == DOCBOOK;
2537 void BufferParams::readPreamble(Lexer & lex)
2539 if (lex.getString() != "\\begin_preamble")
2540 lyxerr << "Error (BufferParams::readPreamble):"
2541 "consistency check failed." << endl;
2543 preamble = lex.getLongString("\\end_preamble");
2547 void BufferParams::readLocalLayout(Lexer & lex, bool forced)
2549 string const expected = forced ? "\\begin_forced_local_layout" :
2550 "\\begin_local_layout";
2551 if (lex.getString() != expected)
2552 lyxerr << "Error (BufferParams::readLocalLayout):"
2553 "consistency check failed." << endl;
2556 forced_local_layout_ =
2557 lex.getLongString("\\end_forced_local_layout");
2559 local_layout_ = lex.getLongString("\\end_local_layout");
2563 bool BufferParams::setLanguage(string const & lang)
2565 Language const *new_language = languages.getLanguage(lang);
2566 if (!new_language) {
2567 // Language lang was not found
2570 language = new_language;
2575 void BufferParams::readLanguage(Lexer & lex)
2577 if (!lex.next()) return;
2579 string const tmptok = lex.getString();
2581 // check if tmptok is part of tex_babel in tex-defs.h
2582 if (!setLanguage(tmptok)) {
2583 // Language tmptok was not found
2584 language = default_language;
2585 lyxerr << "Warning: Setting language `"
2586 << tmptok << "' to `" << language->lang()
2592 void BufferParams::readGraphicsDriver(Lexer & lex)
2597 string const tmptok = lex.getString();
2598 // check if tmptok is part of tex_graphics in tex_defs.h
2601 string const test = tex_graphics[n++];
2603 if (test == tmptok) {
2604 graphics_driver = tmptok;
2609 "Warning: graphics driver `$$Token' not recognized!\n"
2610 " Setting graphics driver to `default'.\n");
2611 graphics_driver = "default";
2618 void BufferParams::readBullets(Lexer & lex)
2623 int const index = lex.getInteger();
2625 int temp_int = lex.getInteger();
2626 user_defined_bullet(index).setFont(temp_int);
2627 temp_bullet(index).setFont(temp_int);
2629 user_defined_bullet(index).setCharacter(temp_int);
2630 temp_bullet(index).setCharacter(temp_int);
2632 user_defined_bullet(index).setSize(temp_int);
2633 temp_bullet(index).setSize(temp_int);
2637 void BufferParams::readBulletsLaTeX(Lexer & lex)
2639 // The bullet class should be able to read this.
2642 int const index = lex.getInteger();
2644 docstring const temp_str = lex.getDocString();
2646 user_defined_bullet(index).setText(temp_str);
2647 temp_bullet(index).setText(temp_str);
2651 void BufferParams::readModules(Lexer & lex)
2653 if (!lex.eatLine()) {
2654 lyxerr << "Error (BufferParams::readModules):"
2655 "Unexpected end of input." << endl;
2659 string mod = lex.getString();
2660 if (mod == "\\end_modules")
2662 addLayoutModule(mod);
2668 void BufferParams::readRemovedModules(Lexer & lex)
2670 if (!lex.eatLine()) {
2671 lyxerr << "Error (BufferParams::readRemovedModules):"
2672 "Unexpected end of input." << endl;
2676 string mod = lex.getString();
2677 if (mod == "\\end_removed_modules")
2679 removed_modules_.push_back(mod);
2682 // now we want to remove any removed modules that were previously
2683 // added. normally, that will be because default modules were added in
2684 // setBaseClass(), which gets called when \textclass is read at the
2685 // start of the read.
2686 list<string>::const_iterator rit = removed_modules_.begin();
2687 list<string>::const_iterator const ren = removed_modules_.end();
2688 for (; rit != ren; ++rit) {
2689 LayoutModuleList::iterator const mit = layout_modules_.begin();
2690 LayoutModuleList::iterator const men = layout_modules_.end();
2691 LayoutModuleList::iterator found = find(mit, men, *rit);
2694 layout_modules_.erase(found);
2699 void BufferParams::readIncludeonly(Lexer & lex)
2701 if (!lex.eatLine()) {
2702 lyxerr << "Error (BufferParams::readIncludeonly):"
2703 "Unexpected end of input." << endl;
2707 string child = lex.getString();
2708 if (child == "\\end_includeonly")
2710 included_children_.push_back(child);
2716 string BufferParams::paperSizeName(PapersizePurpose purpose) const
2718 switch (papersize) {
2720 // could be anything, so don't guess
2722 case PAPER_CUSTOM: {
2723 if (purpose == XDVI && !paperwidth.empty() &&
2724 !paperheight.empty()) {
2725 // heightxwidth<unit>
2726 string first = paperwidth;
2727 string second = paperheight;
2728 if (orientation == ORIENTATION_LANDSCAPE)
2731 return first.erase(first.length() - 2)
2737 // dvips and dvipdfm do not know this
2738 if (purpose == DVIPS || purpose == DVIPDFM)
2742 if (purpose == DVIPS || purpose == DVIPDFM)
2746 if (purpose == DVIPS || purpose == DVIPDFM)
2756 if (purpose == DVIPS || purpose == DVIPDFM)
2760 if (purpose == DVIPS || purpose == DVIPDFM)
2764 if (purpose == DVIPS || purpose == DVIPDFM)
2768 if (purpose == DVIPS || purpose == DVIPDFM)
2772 if (purpose == DVIPS || purpose == DVIPDFM)
2776 // dvipdfm does not know this
2777 if (purpose == DVIPDFM)
2781 if (purpose == DVIPDFM)
2785 if (purpose == DVIPS || purpose == DVIPDFM)
2789 if (purpose == DVIPS || purpose == DVIPDFM)
2793 if (purpose == DVIPS || purpose == DVIPDFM)
2797 if (purpose == DVIPS || purpose == DVIPDFM)
2801 if (purpose == DVIPS || purpose == DVIPDFM)
2805 if (purpose == DVIPS || purpose == DVIPDFM)
2809 if (purpose == DVIPS || purpose == DVIPDFM)
2813 if (purpose == DVIPS || purpose == DVIPDFM)
2817 if (purpose == DVIPS || purpose == DVIPDFM)
2821 if (purpose == DVIPS || purpose == DVIPDFM)
2825 if (purpose == DVIPS || purpose == DVIPDFM)
2829 if (purpose == DVIPS || purpose == DVIPDFM)
2833 if (purpose == DVIPS || purpose == DVIPDFM)
2837 if (purpose == DVIPS || purpose == DVIPDFM)
2841 if (purpose == DVIPS || purpose == DVIPDFM)
2844 case PAPER_USEXECUTIVE:
2845 // dvipdfm does not know this
2846 if (purpose == DVIPDFM)
2851 case PAPER_USLETTER:
2853 if (purpose == XDVI)
2860 string const BufferParams::dvips_options() const
2864 // If the class loads the geometry package, we do not know which
2865 // paper size is used, since we do not set it (bug 7013).
2866 // Therefore we must not specify any argument here.
2867 // dvips gets the correct paper size via DVI specials in this case
2868 // (if the class uses the geometry package correctly).
2869 if (documentClass().provides("geometry"))
2873 && papersize == PAPER_CUSTOM
2874 && !lyxrc.print_paper_dimension_flag.empty()
2875 && !paperwidth.empty()
2876 && !paperheight.empty()) {
2877 // using a custom papersize
2878 result = lyxrc.print_paper_dimension_flag;
2879 result += ' ' + paperwidth;
2880 result += ',' + paperheight;
2882 string const paper_option = paperSizeName(DVIPS);
2883 if (!paper_option.empty() && (paper_option != "letter" ||
2884 orientation != ORIENTATION_LANDSCAPE)) {
2885 // dvips won't accept -t letter -t landscape.
2886 // In all other cases, include the paper size
2888 result = lyxrc.print_paper_flag;
2889 result += ' ' + paper_option;
2892 if (orientation == ORIENTATION_LANDSCAPE &&
2893 papersize != PAPER_CUSTOM)
2894 result += ' ' + lyxrc.print_landscape_flag;
2899 string const BufferParams::font_encoding() const
2901 return font_encodings().empty() ? "default" : font_encodings().back();
2905 vector<string> const BufferParams::font_encodings() const
2907 string doc_fontenc = (fontenc == "global") ? lyxrc.fontenc : fontenc;
2909 vector<string> fontencs;
2911 // "default" means "no explicit font encoding"
2912 if (doc_fontenc != "default") {
2913 fontencs = getVectorFromString(doc_fontenc);
2914 if (!language->fontenc().empty()
2915 && ascii_lowercase(language->fontenc()) != "none") {
2916 vector<string> fencs = getVectorFromString(language->fontenc());
2917 vector<string>::const_iterator fit = fencs.begin();
2918 for (; fit != fencs.end(); ++fit) {
2919 if (find(fontencs.begin(), fontencs.end(), *fit) == fontencs.end())
2920 fontencs.push_back(*fit);
2929 string BufferParams::babelCall(string const & lang_opts, bool const langoptions) const
2931 // suppress the babel call if there is no BabelName defined
2932 // for the document language in the lib/languages file and if no
2933 // other languages are used (lang_opts is then empty)
2934 if (lang_opts.empty())
2936 // either a specific language (AsBabelOptions setting in
2937 // lib/languages) or the prefs require the languages to
2938 // be submitted to babel itself (not the class).
2940 return "\\usepackage[" + lang_opts + "]{babel}";
2941 return "\\usepackage{babel}";
2945 docstring BufferParams::getGraphicsDriver(string const & package) const
2949 if (package == "geometry") {
2950 if (graphics_driver == "dvips"
2951 || graphics_driver == "dvipdfm"
2952 || graphics_driver == "pdftex"
2953 || graphics_driver == "vtex")
2954 result = from_ascii(graphics_driver);
2955 else if (graphics_driver == "dvipdfmx")
2956 result = from_ascii("dvipdfm");
2963 void BufferParams::writeEncodingPreamble(otexstream & os,
2964 LaTeXFeatures & features) const
2966 // XeTeX/LuaTeX: (see also #9740)
2967 // With Unicode fonts we use utf8-plain without encoding package.
2968 // With TeX fonts, we cannot use utf8-plain, but "inputenc" fails.
2969 // XeTeX must use ASCII encoding, for LuaTeX, we load
2970 // "luainputenc" (see below).
2971 if (useNonTeXFonts || features.runparams().flavor == OutputParams::XETEX)
2974 if (inputenc == "auto") {
2975 string const doc_encoding =
2976 language->encoding()->latexName();
2977 Encoding::Package const package =
2978 language->encoding()->package();
2980 // Create list of inputenc options:
2981 set<string> encodings;
2982 // luainputenc fails with more than one encoding
2983 if (!features.runparams().isFullUnicode()) // if we reach this point, this means LuaTeX with TeX fonts
2984 // list all input encodings used in the document
2985 encodings = features.getEncodingSet(doc_encoding);
2987 // If the "japanese" package (i.e. pLaTeX) is used,
2988 // inputenc must be omitted.
2989 // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
2990 if ((!encodings.empty() || package == Encoding::inputenc)
2991 && !features.isRequired("japanese")
2992 && !features.isProvided("inputenc")) {
2993 os << "\\usepackage[";
2994 set<string>::const_iterator it = encodings.begin();
2995 set<string>::const_iterator const end = encodings.end();
2997 os << from_ascii(*it);
3000 for (; it != end; ++it)
3001 os << ',' << from_ascii(*it);
3002 if (package == Encoding::inputenc) {
3003 if (!encodings.empty())
3005 os << from_ascii(doc_encoding);
3007 if (features.runparams().flavor == OutputParams::LUATEX
3008 || features.runparams().flavor == OutputParams::DVILUATEX)
3009 os << "]{luainputenc}\n";
3011 os << "]{inputenc}\n";
3013 if (package == Encoding::CJK || features.mustProvide("CJK")) {
3014 if (language->encoding()->name() == "utf8-cjk"
3015 && LaTeXFeatures::isAvailable("CJKutf8"))
3016 os << "\\usepackage{CJKutf8}\n";
3018 os << "\\usepackage{CJK}\n";
3020 } else if (inputenc != "default") {
3021 switch (encoding().package()) {
3022 case Encoding::none:
3023 case Encoding::japanese:
3025 case Encoding::inputenc:
3026 // do not load inputenc if japanese is used
3027 // or if the class provides inputenc
3028 if (features.isRequired("japanese")
3029 || features.isProvided("inputenc"))
3031 os << "\\usepackage[" << from_ascii(encoding().latexName());
3032 if (features.runparams().flavor == OutputParams::LUATEX
3033 || features.runparams().flavor == OutputParams::DVILUATEX)
3034 os << "]{luainputenc}\n";
3036 os << "]{inputenc}\n";
3039 if (encoding().name() == "utf8-cjk"
3040 && LaTeXFeatures::isAvailable("CJKutf8"))
3041 os << "\\usepackage{CJKutf8}\n";
3043 os << "\\usepackage{CJK}\n";
3046 // Load the CJK package if needed by a secondary language.
3047 // If the main encoding is some variant of UTF8, use CJKutf8.
3048 if (encoding().package() != Encoding::CJK && features.mustProvide("CJK")) {
3049 if (encoding().iconvName() == "UTF-8"
3050 && LaTeXFeatures::isAvailable("CJKutf8"))
3051 os << "\\usepackage{CJKutf8}\n";
3053 os << "\\usepackage{CJK}\n";
3059 string const BufferParams::parseFontName(string const & name) const
3061 string mangled = name;
3062 size_t const idx = mangled.find('[');
3063 if (idx == string::npos || idx == 0)
3066 return mangled.substr(0, idx - 1);
3070 string const BufferParams::loadFonts(LaTeXFeatures & features) const
3072 if (fontsRoman() == "default" && fontsSans() == "default"
3073 && fontsTypewriter() == "default"
3074 && (fontsMath() == "default" || fontsMath() == "auto"))
3080 /* Fontspec (XeTeX, LuaTeX): we provide GUI support for oldstyle
3081 * numbers (Numbers=OldStyle) and sf/tt scaling. The Ligatures=TeX/
3082 * Mapping=tex-text option assures TeX ligatures (such as "--")
3083 * are resolved. Note that tt does not use these ligatures.
3085 * -- add more GUI options?
3086 * -- add more fonts (fonts for other scripts)
3087 * -- if there's a way to find out if a font really supports
3088 * OldStyle, enable/disable the widget accordingly.
3090 if (useNonTeXFonts && features.isAvailable("fontspec")) {
3091 // "Mapping=tex-text" and "Ligatures=TeX" are equivalent.
3092 // However, until v.2 (2010/07/11) fontspec only knew
3093 // Mapping=tex-text (for XeTeX only); then "Ligatures=TeX"
3094 // was introduced for both XeTeX and LuaTeX (LuaTeX
3095 // didn't understand "Mapping=tex-text", while XeTeX
3096 // understood both. With most recent versions, both
3097 // variants are understood by both engines. However,
3098 // we want to provide support for at least TeXLive 2009
3099 // (for XeTeX; LuaTeX is only supported as of v.2)
3100 string const texmapping =
3101 (features.runparams().flavor == OutputParams::XETEX) ?
3102 "Mapping=tex-text" : "Ligatures=TeX";
3103 if (fontsRoman() != "default") {
3104 os << "\\setmainfont[" << texmapping;
3105 if (fonts_old_figures)
3106 os << ",Numbers=OldStyle";
3107 os << "]{" << parseFontName(fontsRoman()) << "}\n";
3109 if (fontsSans() != "default") {
3110 string const sans = parseFontName(fontsSans());
3111 if (fontsSansScale() != 100)
3112 os << "\\setsansfont[Scale="
3113 << float(fontsSansScale()) / 100
3114 << "," << texmapping << "]{"
3117 os << "\\setsansfont[" << texmapping << "]{"
3120 if (fontsTypewriter() != "default") {
3121 string const mono = parseFontName(fontsTypewriter());
3122 if (fontsTypewriterScale() != 100)
3123 os << "\\setmonofont[Scale="
3124 << float(fontsTypewriterScale()) / 100
3128 os << "\\setmonofont{"
3135 bool const ot1 = (font_encoding() == "default" || font_encoding() == "OT1");
3136 bool const dryrun = features.runparams().dryrun;
3137 bool const complete = (fontsSans() == "default" && fontsTypewriter() == "default");
3138 bool const nomath = (fontsMath() == "default");
3141 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsRoman())).getLaTeXCode(
3142 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3146 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsSans())).getLaTeXCode(
3147 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3148 nomath, fontsSansScale());
3150 // MONOSPACED/TYPEWRITER
3151 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsTypewriter())).getLaTeXCode(
3152 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3153 nomath, fontsTypewriterScale());
3156 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsMath())).getLaTeXCode(
3157 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3164 Encoding const & BufferParams::encoding() const
3166 // Main encoding for LaTeX output.
3168 // Exception: XeTeX with 8-bit TeX fonts requires ASCII (see #9740).
3169 // As the "flavor" is only known once export started, this
3170 // cannot be handled here. Instead, runparams.encoding is set
3171 // to ASCII in Buffer::makeLaTeXFile (for export)
3172 // and Buffer::writeLaTeXSource (for preview).
3174 return *(encodings.fromLyXName("utf8-plain"));
3175 if (inputenc == "auto" || inputenc == "default")
3176 return *language->encoding();
3177 Encoding const * const enc = encodings.fromLyXName(inputenc);
3180 LYXERR0("Unknown inputenc value `" << inputenc
3181 << "'. Using `auto' instead.");
3182 return *language->encoding();
3186 bool BufferParams::addCiteEngine(string const & engine)
3188 LayoutModuleList::const_iterator it = cite_engine_.begin();
3189 LayoutModuleList::const_iterator en = cite_engine_.end();
3190 for (; it != en; ++it)
3193 cite_engine_.push_back(engine);
3198 bool BufferParams::addCiteEngine(vector<string> const & engine)
3200 vector<string>::const_iterator it = engine.begin();
3201 vector<string>::const_iterator en = engine.end();
3203 for (; it != en; ++it)
3204 if (!addCiteEngine(*it))
3210 string const & BufferParams::defaultBiblioStyle() const
3212 return documentClass().defaultBiblioStyle();
3216 bool const & BufferParams::fullAuthorList() const
3218 return documentClass().fullAuthorList();
3222 void BufferParams::setCiteEngine(string const & engine)
3225 addCiteEngine(engine);
3229 void BufferParams::setCiteEngine(vector<string> const & engine)
3232 addCiteEngine(engine);
3236 vector<string> BufferParams::citeCommands() const
3238 static CitationStyle const default_style;
3239 vector<string> commands =
3240 documentClass().citeCommands(citeEngineType());
3241 if (commands.empty())
3242 commands.push_back(default_style.cmd);
3247 vector<CitationStyle> BufferParams::citeStyles() const
3249 static CitationStyle const default_style;
3250 vector<CitationStyle> styles =
3251 documentClass().citeStyles(citeEngineType());
3253 styles.push_back(default_style);