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"
29 #include "IndicesList.h"
31 #include "LaTeXFeatures.h"
32 #include "ModuleList.h"
36 #include "OutputParams.h"
40 #include "PDFOptions.h"
42 #include "frontends/alert.h"
44 #include "insets/InsetListingsParams.h"
46 #include "support/convert.h"
47 #include "support/debug.h"
48 #include "support/docstream.h"
49 #include "support/FileName.h"
50 #include "support/filetools.h"
51 #include "support/gettext.h"
52 #include "support/Messages.h"
53 #include "support/Translator.h"
54 #include "support/lstrings.h"
60 using namespace lyx::support;
63 static char const * const string_paragraph_separation[] = {
68 static char const * const string_quotes_language[] = {
69 "english", "swedish", "german", "polish", "french", "danish", ""
73 static char const * const string_papersize[] = {
74 "default", "custom", "letterpaper", "legalpaper", "executivepaper",
75 "a0paper", "a1paper", "a2paper", "a3paper", "a4paper", "a5paper",
76 "a6paper", "b0paper", "b1paper", "b2paper","b3paper", "b4paper",
77 "b5paper", "b6paper", "c0paper", "c1paper", "c2paper", "c3paper",
78 "c4paper", "c5paper", "c6paper", "b0j", "b1j", "b2j", "b3j", "b4j", "b5j",
83 static char const * const string_orientation[] = {
84 "portrait", "landscape", ""
88 static char const * const string_footnotekinds[] = {
89 "footnote", "margin", "fig", "tab", "alg", "wide-fig", "wide-tab", ""
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 translator = init_parseptranslator();
129 typedef Translator<string, InsetQuotes::QuoteLanguage> QuotesLangTranslator;
132 QuotesLangTranslator const init_quoteslangtranslator()
134 QuotesLangTranslator translator
135 (string_quotes_language[0], InsetQuotes::EnglishQuotes);
136 translator.addPair(string_quotes_language[1], InsetQuotes::SwedishQuotes);
137 translator.addPair(string_quotes_language[2], InsetQuotes::GermanQuotes);
138 translator.addPair(string_quotes_language[3], InsetQuotes::PolishQuotes);
139 translator.addPair(string_quotes_language[4], InsetQuotes::FrenchQuotes);
140 translator.addPair(string_quotes_language[5], InsetQuotes::DanishQuotes);
145 QuotesLangTranslator const & quoteslangtranslator()
147 static QuotesLangTranslator translator = init_quoteslangtranslator();
153 typedef Translator<string, PAPER_SIZE> PaperSizeTranslator;
156 static PaperSizeTranslator initPaperSizeTranslator()
158 PaperSizeTranslator translator(string_papersize[0], PAPER_DEFAULT);
159 translator.addPair(string_papersize[1], PAPER_CUSTOM);
160 translator.addPair(string_papersize[2], PAPER_USLETTER);
161 translator.addPair(string_papersize[3], PAPER_USLEGAL);
162 translator.addPair(string_papersize[4], PAPER_USEXECUTIVE);
163 translator.addPair(string_papersize[5], PAPER_A0);
164 translator.addPair(string_papersize[6], PAPER_A1);
165 translator.addPair(string_papersize[7], PAPER_A2);
166 translator.addPair(string_papersize[8], PAPER_A3);
167 translator.addPair(string_papersize[9], PAPER_A4);
168 translator.addPair(string_papersize[10], PAPER_A5);
169 translator.addPair(string_papersize[11], PAPER_A6);
170 translator.addPair(string_papersize[12], PAPER_B0);
171 translator.addPair(string_papersize[13], PAPER_B1);
172 translator.addPair(string_papersize[14], PAPER_B2);
173 translator.addPair(string_papersize[15], PAPER_B3);
174 translator.addPair(string_papersize[16], PAPER_B4);
175 translator.addPair(string_papersize[17], PAPER_B5);
176 translator.addPair(string_papersize[18], PAPER_B6);
177 translator.addPair(string_papersize[19], PAPER_C0);
178 translator.addPair(string_papersize[20], PAPER_C1);
179 translator.addPair(string_papersize[21], PAPER_C2);
180 translator.addPair(string_papersize[22], PAPER_C3);
181 translator.addPair(string_papersize[23], PAPER_C4);
182 translator.addPair(string_papersize[24], PAPER_C5);
183 translator.addPair(string_papersize[25], PAPER_C6);
184 translator.addPair(string_papersize[26], PAPER_JISB0);
185 translator.addPair(string_papersize[27], PAPER_JISB1);
186 translator.addPair(string_papersize[28], PAPER_JISB2);
187 translator.addPair(string_papersize[29], PAPER_JISB3);
188 translator.addPair(string_papersize[30], PAPER_JISB4);
189 translator.addPair(string_papersize[31], PAPER_JISB5);
190 translator.addPair(string_papersize[32], PAPER_JISB6);
195 PaperSizeTranslator const & papersizetranslator()
197 static PaperSizeTranslator translator = initPaperSizeTranslator();
203 typedef Translator<string, PAPER_ORIENTATION> PaperOrientationTranslator;
206 PaperOrientationTranslator const init_paperorientationtranslator()
208 PaperOrientationTranslator translator(string_orientation[0], ORIENTATION_PORTRAIT);
209 translator.addPair(string_orientation[1], ORIENTATION_LANDSCAPE);
214 PaperOrientationTranslator const & paperorientationtranslator()
216 static PaperOrientationTranslator translator = init_paperorientationtranslator();
222 typedef Translator<int, PageSides> SidesTranslator;
225 SidesTranslator const init_sidestranslator()
227 SidesTranslator translator(1, OneSide);
228 translator.addPair(2, TwoSides);
233 SidesTranslator const & sidestranslator()
235 static SidesTranslator translator = init_sidestranslator();
241 typedef Translator<int, BufferParams::Package> PackageTranslator;
244 PackageTranslator const init_packagetranslator()
246 PackageTranslator translator(0, BufferParams::package_off);
247 translator.addPair(1, BufferParams::package_auto);
248 translator.addPair(2, BufferParams::package_on);
253 PackageTranslator const & packagetranslator()
255 static PackageTranslator translator = init_packagetranslator();
261 typedef Translator<string, CiteEngine> CiteEngineTranslator;
264 CiteEngineTranslator const init_citeenginetranslator()
266 CiteEngineTranslator translator("basic", ENGINE_BASIC);
267 translator.addPair("natbib_numerical", ENGINE_NATBIB_NUMERICAL);
268 translator.addPair("natbib_authoryear", ENGINE_NATBIB_AUTHORYEAR);
269 translator.addPair("jurabib", ENGINE_JURABIB);
274 CiteEngineTranslator const & citeenginetranslator()
276 static CiteEngineTranslator translator = init_citeenginetranslator();
282 typedef Translator<string, Spacing::Space> SpaceTranslator;
285 SpaceTranslator const init_spacetranslator()
287 SpaceTranslator translator("default", Spacing::Default);
288 translator.addPair("single", Spacing::Single);
289 translator.addPair("onehalf", Spacing::Onehalf);
290 translator.addPair("double", Spacing::Double);
291 translator.addPair("other", Spacing::Other);
296 SpaceTranslator const & spacetranslator()
298 static SpaceTranslator translator = init_spacetranslator();
305 class BufferParams::Impl
310 AuthorList authorlist;
311 BranchList branchlist;
312 Bullet temp_bullets[4];
313 Bullet user_defined_bullets[4];
314 IndicesList indiceslist;
316 /** This is the amount of space used for paragraph_separation "skip",
317 * and for detached paragraphs in "indented" documents.
321 PDFOptions pdfoptions;
322 LayoutFileIndex baseClass_;
326 BufferParams::Impl::Impl()
327 : defskip(VSpace::MEDSKIP), baseClass_(string(""))
329 // set initial author
331 authorlist.record(Author(from_utf8(lyxrc.user_name), from_utf8(lyxrc.user_email)));
336 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 use_amsmath = package_auto;
364 use_esint = package_auto;
365 use_mhchem = package_auto;
366 use_mathdots = package_auto;
367 cite_engine_ = ENGINE_BASIC;
368 use_bibtopic = false;
370 trackChanges = false;
371 outputChanges = false;
372 use_default_options = true;
373 maintain_unincluded_children = false;
376 language = default_language;
378 fonts_roman = "default";
379 fonts_sans = "default";
380 fonts_typewriter = "default";
381 fonts_default_family = "default";
382 useNonTeXFonts = false;
383 fonts_expert_sc = false;
384 fonts_old_figures = false;
385 fonts_sans_scale = 100;
386 fonts_typewriter_scale = 100;
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 // no color is the default (white)
398 backgroundcolor = lyx::rgbFromHexName("#ffffff");
399 isbackgroundcolor = false;
400 // no color is the default (black)
401 fontcolor = lyx::rgbFromHexName("#000000");
403 // light gray is the default font color for greyed-out notes
404 notefontcolor = lyx::rgbFromHexName("#cccccc");
405 boxbgcolor = lyx::rgbFromHexName("#ff0000");
406 compressed = lyxrc.save_compressed;
407 for (int iter = 0; iter < 4; ++iter) {
408 user_defined_bullet(iter) = ITEMIZE_DEFAULTS[iter];
409 temp_bullet(iter) = ITEMIZE_DEFAULTS[iter];
412 indiceslist().addDefault(B_("Index"));
413 html_be_strict = false;
414 html_math_output = MathML;
415 html_math_img_scale = 1.0;
422 docstring BufferParams::B_(string const & l10n) const
424 LASSERT(language, /**/);
425 return getMessages(language->code()).get(l10n);
429 AuthorList & BufferParams::authors()
431 return pimpl_->authorlist;
435 AuthorList const & BufferParams::authors() const
437 return pimpl_->authorlist;
441 BranchList & BufferParams::branchlist()
443 return pimpl_->branchlist;
447 BranchList const & BufferParams::branchlist() const
449 return pimpl_->branchlist;
453 IndicesList & BufferParams::indiceslist()
455 return pimpl_->indiceslist;
459 IndicesList const & BufferParams::indiceslist() const
461 return pimpl_->indiceslist;
465 Bullet & BufferParams::temp_bullet(lyx::size_type const index)
467 LASSERT(index < 4, /**/);
468 return pimpl_->temp_bullets[index];
472 Bullet const & BufferParams::temp_bullet(lyx::size_type const index) const
474 LASSERT(index < 4, /**/);
475 return pimpl_->temp_bullets[index];
479 Bullet & BufferParams::user_defined_bullet(lyx::size_type const index)
481 LASSERT(index < 4, /**/);
482 return pimpl_->user_defined_bullets[index];
486 Bullet const & BufferParams::user_defined_bullet(lyx::size_type const index) const
488 LASSERT(index < 4, /**/);
489 return pimpl_->user_defined_bullets[index];
493 Spacing & BufferParams::spacing()
495 return pimpl_->spacing;
499 Spacing const & BufferParams::spacing() const
501 return pimpl_->spacing;
505 PDFOptions & BufferParams::pdfoptions()
507 return pimpl_->pdfoptions;
511 PDFOptions const & BufferParams::pdfoptions() const
513 return pimpl_->pdfoptions;
517 HSpace const & BufferParams::getIndentation() const
519 return pimpl_->indentation;
523 void BufferParams::setIndentation(HSpace const & indent)
525 pimpl_->indentation = indent;
529 VSpace const & BufferParams::getDefSkip() const
531 return pimpl_->defskip;
535 void BufferParams::setDefSkip(VSpace const & vs)
537 // DEFSKIP will cause an infinite loop
538 LASSERT(vs.kind() != VSpace::DEFSKIP, return);
539 pimpl_->defskip = vs;
543 string BufferParams::readToken(Lexer & lex, string const & token,
544 FileName const & filepath)
546 if (token == "\\textclass") {
548 string const classname = lex.getString();
549 // if there exists a local layout file, ignore the system one
550 // NOTE: in this case, the textclass (.cls file) is assumed to
553 LayoutFileList & bcl = LayoutFileList::get();
554 if (tcp.empty() && !filepath.empty())
555 tcp = bcl.addLocalLayout(classname, filepath.absFileName());
559 setBaseClass(classname);
560 // We assume that a tex class exists for local or unknown
561 // layouts so this warning, will only be given for system layouts.
562 if (!baseClass()->isTeXClassAvailable()) {
563 docstring const desc =
564 translateIfPossible(from_utf8(baseClass()->description()));
565 docstring const prereqs =
566 from_utf8(baseClass()->prerequisites());
567 docstring const msg =
568 bformat(_("The selected document class\n"
570 "requires external files that are not available.\n"
571 "The document class can still be used, but the\n"
572 "document cannot be compiled until the following\n"
573 "prerequisites are installed:\n"
575 "See section 3.1.2.2 of the User's Guide for\n"
576 "more information."), desc, prereqs);
577 frontend::Alert::warning(_("Document class not available"),
580 } else if (token == "\\begin_preamble") {
582 } else if (token == "\\begin_local_layout") {
583 readLocalLayout(lex);
584 } else if (token == "\\begin_modules") {
586 } else if (token == "\\begin_removed_modules") {
587 readRemovedModules(lex);
588 } else if (token == "\\begin_includeonly") {
589 readIncludeonly(lex);
590 } else if (token == "\\maintain_unincluded_children") {
591 lex >> maintain_unincluded_children;
592 } else if (token == "\\options") {
594 options = lex.getString();
595 } else if (token == "\\use_default_options") {
596 lex >> use_default_options;
597 } else if (token == "\\master") {
599 master = lex.getString();
600 } else if (token == "\\suppress_date") {
601 lex >> suppress_date;
602 } else if (token == "\\language") {
604 } else if (token == "\\inputencoding") {
606 } else if (token == "\\graphics") {
607 readGraphicsDriver(lex);
608 } else if (token == "\\default_output_format") {
609 lex >> default_output_format;
610 } else if (token == "\\bibtex_command") {
612 bibtex_command = lex.getString();
613 } else if (token == "\\index_command") {
615 index_command = lex.getString();
616 } else if (token == "\\fontencoding") {
618 fontenc = lex.getString();
619 } else if (token == "\\font_roman") {
621 fonts_roman = lex.getString();
622 } else if (token == "\\font_sans") {
624 fonts_sans = lex.getString();
625 } else if (token == "\\font_typewriter") {
627 fonts_typewriter = lex.getString();
628 } else if (token == "\\font_default_family") {
629 lex >> fonts_default_family;
630 } else if (token == "\\use_non_tex_fonts") {
631 lex >> useNonTeXFonts;
632 } else if (token == "\\font_sc") {
633 lex >> fonts_expert_sc;
634 } else if (token == "\\font_osf") {
635 lex >> fonts_old_figures;
636 } else if (token == "\\font_sf_scale") {
637 lex >> fonts_sans_scale;
638 } else if (token == "\\font_tt_scale") {
639 lex >> fonts_typewriter_scale;
640 } else if (token == "\\font_cjk") {
642 } else if (token == "\\paragraph_separation") {
645 paragraph_separation = parseptranslator().find(parsep);
646 } else if (token == "\\paragraph_indentation") {
648 string indentation = lex.getString();
649 pimpl_->indentation = HSpace(indentation);
650 } else if (token == "\\defskip") {
652 string const defskip = lex.getString();
653 pimpl_->defskip = VSpace(defskip);
654 if (pimpl_->defskip.kind() == VSpace::DEFSKIP)
656 pimpl_->defskip = VSpace(VSpace::MEDSKIP);
657 } else if (token == "\\quotes_language") {
660 quotes_language = quoteslangtranslator().find(quotes_lang);
661 } else if (token == "\\papersize") {
664 papersize = papersizetranslator().find(ppsize);
665 } else if (token == "\\use_geometry") {
667 } else if (token == "\\use_amsmath") {
670 use_amsmath = packagetranslator().find(use_ams);
671 } else if (token == "\\use_esint") {
674 use_esint = packagetranslator().find(useesint);
675 } else if (token == "\\use_mhchem") {
678 use_mhchem = packagetranslator().find(usemhchem);
679 } else if (token == "\\use_mathdots") {
682 use_mathdots = packagetranslator().find(usemathdots);
683 } else if (token == "\\cite_engine") {
686 cite_engine_ = citeenginetranslator().find(engine);
687 } else if (token == "\\use_bibtopic") {
689 } else if (token == "\\use_indices") {
691 } else if (token == "\\tracking_changes") {
693 } else if (token == "\\output_changes") {
694 lex >> outputChanges;
695 } else if (token == "\\branch") {
697 docstring branch = lex.getDocString();
698 branchlist().add(branch);
701 string const tok = lex.getString();
702 if (tok == "\\end_branch")
704 Branch * branch_ptr = branchlist().find(branch);
705 if (tok == "\\selected") {
708 branch_ptr->setSelected(lex.getInteger());
710 if (tok == "\\filename_suffix") {
713 branch_ptr->setFileNameSuffix(lex.getInteger());
715 if (tok == "\\color") {
717 string color = lex.getString();
719 branch_ptr->setColor(color);
720 // Update also the Color table:
722 color = lcolor.getX11Name(Color_background);
724 lcolor.setColor(to_utf8(branch), color);
727 } else if (token == "\\index") {
729 docstring index = lex.getDocString();
731 indiceslist().add(index);
734 string const tok = lex.getString();
735 if (tok == "\\end_index")
737 Index * index_ptr = indiceslist().find(index);
738 if (tok == "\\shortcut") {
740 shortcut = lex.getDocString();
742 index_ptr->setShortcut(shortcut);
744 if (tok == "\\color") {
746 string color = lex.getString();
748 index_ptr->setColor(color);
749 // Update also the Color table:
751 color = lcolor.getX11Name(Color_background);
753 if (!shortcut.empty())
754 lcolor.setColor(to_utf8(shortcut), color);
757 } else if (token == "\\author") {
759 istringstream ss(lex.getString());
762 author_map[a.bufferId()] = pimpl_->authorlist.record(a);
763 } else if (token == "\\paperorientation") {
766 orientation = paperorientationtranslator().find(orient);
767 } else if (token == "\\backgroundcolor") {
769 backgroundcolor = lyx::rgbFromHexName(lex.getString());
770 isbackgroundcolor = true;
771 } else if (token == "\\fontcolor") {
773 fontcolor = lyx::rgbFromHexName(lex.getString());
775 } else if (token == "\\notefontcolor") {
777 string color = lex.getString();
778 notefontcolor = lyx::rgbFromHexName(color);
779 } else if (token == "\\boxbgcolor") {
781 string color = lex.getString();
782 boxbgcolor = lyx::rgbFromHexName(color);
783 } else if (token == "\\paperwidth") {
785 } else if (token == "\\paperheight") {
787 } else if (token == "\\leftmargin") {
789 } else if (token == "\\topmargin") {
791 } else if (token == "\\rightmargin") {
793 } else if (token == "\\bottommargin") {
795 } else if (token == "\\headheight") {
797 } else if (token == "\\headsep") {
799 } else if (token == "\\footskip") {
801 } else if (token == "\\columnsep") {
803 } else if (token == "\\paperfontsize") {
805 } else if (token == "\\papercolumns") {
807 } else if (token == "\\listings_params") {
810 listings_params = InsetListingsParams(par).params();
811 } else if (token == "\\papersides") {
814 sides = sidestranslator().find(psides);
815 } else if (token == "\\paperpagestyle") {
817 } else if (token == "\\bullet") {
819 } else if (token == "\\bulletLaTeX") {
820 readBulletsLaTeX(lex);
821 } else if (token == "\\secnumdepth") {
823 } else if (token == "\\tocdepth") {
825 } else if (token == "\\spacing") {
829 if (nspacing == "other") {
832 spacing().set(spacetranslator().find(nspacing), tmp_val);
833 } else if (token == "\\float_placement") {
834 lex >> float_placement;
836 } else if (prefixIs(token, "\\pdf_") || token == "\\use_hyperref") {
837 string toktmp = pdfoptions().readToken(lex, token);
838 if (!toktmp.empty()) {
839 lyxerr << "PDFOptions::readToken(): Unknown token: " <<
843 } else if (token == "\\html_math_output") {
846 html_math_output = static_cast<MathOutput>(temp);
847 } else if (token == "\\html_be_strict") {
848 lex >> html_be_strict;
849 } else if (token == "\\html_math_img_scale") {
850 lex >> html_math_img_scale;
851 } else if (token == "\\html_latex_start") {
853 html_latex_start = lex.getString();
854 } else if (token == "\\html_latex_end") {
856 html_latex_end = lex.getString();
857 } else if (token == "\\output_sync") {
859 } else if (token == "\\output_sync_macro") {
860 lex >> output_sync_macro;
861 } else if (token == "\\use_refstyle") {
864 lyxerr << "BufferParams::readToken(): Unknown token: " <<
873 void BufferParams::writeFile(ostream & os) const
875 // The top of the file is written by the buffer.
876 // Prints out the buffer info into the .lyx file given by file
879 os << "\\textclass " << baseClass()->name() << '\n';
882 if (!preamble.empty()) {
883 // remove '\n' from the end of preamble
884 string const tmppreamble = rtrim(preamble, "\n");
885 os << "\\begin_preamble\n"
887 << "\n\\end_preamble\n";
891 if (!options.empty()) {
892 os << "\\options " << options << '\n';
895 // use the class options defined in the layout?
896 os << "\\use_default_options "
897 << convert<string>(use_default_options) << "\n";
899 // the master document
900 if (!master.empty()) {
901 os << "\\master " << master << '\n';
905 if (!removed_modules_.empty()) {
906 os << "\\begin_removed_modules" << '\n';
907 list<string>::const_iterator it = removed_modules_.begin();
908 list<string>::const_iterator en = removed_modules_.end();
909 for (; it != en; it++)
911 os << "\\end_removed_modules" << '\n';
915 if (!layout_modules_.empty()) {
916 os << "\\begin_modules" << '\n';
917 LayoutModuleList::const_iterator it = layout_modules_.begin();
918 LayoutModuleList::const_iterator en = layout_modules_.end();
919 for (; it != en; it++)
921 os << "\\end_modules" << '\n';
925 if (!included_children_.empty()) {
926 os << "\\begin_includeonly" << '\n';
927 list<string>::const_iterator it = included_children_.begin();
928 list<string>::const_iterator en = included_children_.end();
929 for (; it != en; it++)
931 os << "\\end_includeonly" << '\n';
933 os << "\\maintain_unincluded_children "
934 << convert<string>(maintain_unincluded_children) << '\n';
936 // local layout information
937 if (!local_layout.empty()) {
938 // remove '\n' from the end
939 string const tmplocal = rtrim(local_layout, "\n");
940 os << "\\begin_local_layout\n"
942 << "\n\\end_local_layout\n";
945 // then the text parameters
946 if (language != ignore_language)
947 os << "\\language " << language->lang() << '\n';
948 os << "\\inputencoding " << inputenc
949 << "\n\\fontencoding " << fontenc
950 << "\n\\font_roman " << fonts_roman
951 << "\n\\font_sans " << fonts_sans
952 << "\n\\font_typewriter " << fonts_typewriter
953 << "\n\\font_default_family " << fonts_default_family
954 << "\n\\use_non_tex_fonts " << convert<string>(useNonTeXFonts)
955 << "\n\\font_sc " << convert<string>(fonts_expert_sc)
956 << "\n\\font_osf " << convert<string>(fonts_old_figures)
957 << "\n\\font_sf_scale " << fonts_sans_scale
958 << "\n\\font_tt_scale " << fonts_typewriter_scale
960 if (!fonts_cjk.empty()) {
961 os << "\\font_cjk " << fonts_cjk << '\n';
963 os << "\n\\graphics " << graphics_driver << '\n';
964 os << "\\default_output_format " << default_output_format << '\n';
965 os << "\\output_sync " << output_sync << '\n';
966 if (!output_sync_macro.empty())
967 os << "\\output_sync_macro \"" << output_sync_macro << "\"\n";
968 os << "\\bibtex_command " << bibtex_command << '\n';
969 os << "\\index_command " << index_command << '\n';
971 if (!float_placement.empty()) {
972 os << "\\float_placement " << float_placement << '\n';
974 os << "\\paperfontsize " << fontsize << '\n';
976 spacing().writeFile(os);
977 pdfoptions().writeFile(os);
979 os << "\\papersize " << string_papersize[papersize]
980 << "\n\\use_geometry " << convert<string>(use_geometry)
981 << "\n\\use_amsmath " << use_amsmath
982 << "\n\\use_esint " << use_esint
983 << "\n\\use_mhchem " << use_mhchem
984 << "\n\\use_mathdots " << use_mathdots
985 << "\n\\cite_engine " << citeenginetranslator().find(cite_engine_)
986 << "\n\\use_bibtopic " << convert<string>(use_bibtopic)
987 << "\n\\use_indices " << convert<string>(use_indices)
988 << "\n\\paperorientation " << string_orientation[orientation]
989 << "\n\\suppress_date " << convert<string>(suppress_date)
990 << "\n\\use_refstyle " << use_refstyle
992 if (isbackgroundcolor == true)
993 os << "\\backgroundcolor " << lyx::X11hexname(backgroundcolor) << '\n';
994 if (isfontcolor == true)
995 os << "\\fontcolor " << lyx::X11hexname(fontcolor) << '\n';
996 if (notefontcolor != lyx::rgbFromHexName("#cccccc"))
997 os << "\\notefontcolor " << lyx::X11hexname(notefontcolor) << '\n';
998 if (boxbgcolor != lyx::rgbFromHexName("#ff0000"))
999 os << "\\boxbgcolor " << lyx::X11hexname(boxbgcolor) << '\n';
1001 BranchList::const_iterator it = branchlist().begin();
1002 BranchList::const_iterator end = branchlist().end();
1003 for (; it != end; ++it) {
1004 os << "\\branch " << to_utf8(it->branch())
1005 << "\n\\selected " << it->isSelected()
1006 << "\n\\filename_suffix " << it->hasFileNameSuffix()
1007 << "\n\\color " << lyx::X11hexname(it->color())
1012 IndicesList::const_iterator iit = indiceslist().begin();
1013 IndicesList::const_iterator iend = indiceslist().end();
1014 for (; iit != iend; ++iit) {
1015 os << "\\index " << to_utf8(iit->index())
1016 << "\n\\shortcut " << to_utf8(iit->shortcut())
1017 << "\n\\color " << lyx::X11hexname(iit->color())
1022 if (!paperwidth.empty())
1023 os << "\\paperwidth "
1024 << VSpace(paperwidth).asLyXCommand() << '\n';
1025 if (!paperheight.empty())
1026 os << "\\paperheight "
1027 << VSpace(paperheight).asLyXCommand() << '\n';
1028 if (!leftmargin.empty())
1029 os << "\\leftmargin "
1030 << VSpace(leftmargin).asLyXCommand() << '\n';
1031 if (!topmargin.empty())
1032 os << "\\topmargin "
1033 << VSpace(topmargin).asLyXCommand() << '\n';
1034 if (!rightmargin.empty())
1035 os << "\\rightmargin "
1036 << VSpace(rightmargin).asLyXCommand() << '\n';
1037 if (!bottommargin.empty())
1038 os << "\\bottommargin "
1039 << VSpace(bottommargin).asLyXCommand() << '\n';
1040 if (!headheight.empty())
1041 os << "\\headheight "
1042 << VSpace(headheight).asLyXCommand() << '\n';
1043 if (!headsep.empty())
1045 << VSpace(headsep).asLyXCommand() << '\n';
1046 if (!footskip.empty())
1048 << VSpace(footskip).asLyXCommand() << '\n';
1049 if (!columnsep.empty())
1050 os << "\\columnsep "
1051 << VSpace(columnsep).asLyXCommand() << '\n';
1052 os << "\\secnumdepth " << secnumdepth
1053 << "\n\\tocdepth " << tocdepth
1054 << "\n\\paragraph_separation "
1055 << string_paragraph_separation[paragraph_separation];
1056 if (!paragraph_separation)
1057 os << "\n\\paragraph_indentation " << getIndentation().asLyXCommand();
1059 os << "\n\\defskip " << getDefSkip().asLyXCommand();
1060 os << "\n\\quotes_language "
1061 << string_quotes_language[quotes_language]
1062 << "\n\\papercolumns " << columns
1063 << "\n\\papersides " << sides
1064 << "\n\\paperpagestyle " << pagestyle << '\n';
1065 if (!listings_params.empty())
1066 os << "\\listings_params \"" <<
1067 InsetListingsParams(listings_params).encodedString() << "\"\n";
1068 for (int i = 0; i < 4; ++i) {
1069 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1070 if (user_defined_bullet(i).getFont() != -1) {
1071 os << "\\bullet " << i << " "
1072 << user_defined_bullet(i).getFont() << " "
1073 << user_defined_bullet(i).getCharacter() << " "
1074 << user_defined_bullet(i).getSize() << "\n";
1078 os << "\\bulletLaTeX " << i << " \""
1079 << lyx::to_ascii(user_defined_bullet(i).getText())
1085 os << "\\tracking_changes " << convert<string>(trackChanges) << '\n'
1086 << "\\output_changes " << convert<string>(outputChanges) << '\n'
1087 << "\\html_math_output " << html_math_output << '\n'
1088 << "\\html_be_strict " << convert<string>(html_be_strict) << '\n';
1090 if (html_math_img_scale != 1.0)
1091 os << "\\html_math_img_scale " << convert<string>(html_math_img_scale) << '\n';
1092 if (!html_latex_start.empty())
1093 os << "\\html_latex_start " << html_latex_start << '\n';
1094 if (!html_latex_end.empty())
1095 os << "\\html_latex_end " << html_latex_end << '\n';
1097 os << pimpl_->authorlist;
1101 void BufferParams::validate(LaTeXFeatures & features) const
1103 features.require(documentClass().requires());
1105 if (outputChanges) {
1106 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1107 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1108 LaTeXFeatures::isAvailable("xcolor");
1110 switch (features.runparams().flavor) {
1111 case OutputParams::LATEX:
1113 features.require("ct-dvipost");
1114 features.require("dvipost");
1115 } else if (xcolorulem) {
1116 features.require("ct-xcolor-ulem");
1117 features.require("ulem");
1118 features.require("xcolor");
1120 features.require("ct-none");
1123 case OutputParams::LUATEX:
1124 case OutputParams::PDFLATEX:
1125 case OutputParams::XETEX:
1127 features.require("ct-xcolor-ulem");
1128 features.require("ulem");
1129 features.require("xcolor");
1130 // improves color handling in PDF output
1131 features.require("pdfcolmk");
1133 features.require("ct-none");
1141 // Floats with 'Here definitely' as default setting.
1142 if (float_placement.find('H') != string::npos)
1143 features.require("float");
1145 // AMS Style is at document level
1146 if (use_amsmath == package_on
1147 || documentClass().provides("amsmath"))
1148 features.require("amsmath");
1149 if (use_esint == package_on)
1150 features.require("esint");
1151 if (use_mhchem == package_on)
1152 features.require("mhchem");
1153 if (use_mathdots == package_on)
1154 features.require("mathdots");
1156 // Document-level line spacing
1157 if (spacing().getSpace() != Spacing::Single && !spacing().isDefault())
1158 features.require("setspace");
1160 // the bullet shapes are buffer level not paragraph level
1161 // so they are tested here
1162 for (int i = 0; i < 4; ++i) {
1163 if (user_defined_bullet(i) == ITEMIZE_DEFAULTS[i])
1165 int const font = user_defined_bullet(i).getFont();
1167 int const c = user_defined_bullet(i).getCharacter();
1173 features.require("latexsym");
1175 } else if (font == 1) {
1176 features.require("amssymb");
1177 } else if (font >= 2 && font <= 5) {
1178 features.require("pifont");
1182 if (pdfoptions().use_hyperref) {
1183 features.require("hyperref");
1184 // due to interferences with babel and hyperref, the color package has to
1185 // be loaded after hyperref when hyperref is used with the colorlinks
1186 // option, see http://www.lyx.org/trac/ticket/5291
1187 if (pdfoptions().colorlinks)
1188 features.require("color");
1191 if (features.runparams().flavor == OutputParams::XETEX
1193 features.require("polyglossia");
1195 if (language->lang() == "vietnamese")
1196 features.require("vietnamese");
1197 else if (language->lang() == "japanese")
1198 features.require("japanese");
1202 bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
1203 TexRow & texrow, FileName const & filepath) const
1205 os << "\\documentclass";
1207 DocumentClass const & tclass = documentClass();
1209 ostringstream clsoptions; // the document class options.
1211 if (tokenPos(tclass.opt_fontsize(),
1212 '|', fontsize) >= 0) {
1213 // only write if existing in list (and not default)
1214 clsoptions << fontsize << "pt,";
1217 // all paper sizes except of A4, A5, B5 and the US sizes need the
1219 bool nonstandard_papersize = papersize != PAPER_DEFAULT
1220 && papersize != PAPER_USLETTER
1221 && papersize != PAPER_USLEGAL
1222 && papersize != PAPER_USEXECUTIVE
1223 && papersize != PAPER_A4
1224 && papersize != PAPER_A5
1225 && papersize != PAPER_B5;
1227 if (!use_geometry) {
1228 switch (papersize) {
1230 clsoptions << "a4paper,";
1232 case PAPER_USLETTER:
1233 clsoptions << "letterpaper,";
1236 clsoptions << "a5paper,";
1239 clsoptions << "b5paper,";
1241 case PAPER_USEXECUTIVE:
1242 clsoptions << "executivepaper,";
1245 clsoptions << "legalpaper,";
1279 if (sides != tclass.sides()) {
1282 clsoptions << "oneside,";
1285 clsoptions << "twoside,";
1291 if (columns != tclass.columns()) {
1293 clsoptions << "twocolumn,";
1295 clsoptions << "onecolumn,";
1299 && orientation == ORIENTATION_LANDSCAPE)
1300 clsoptions << "landscape,";
1302 // language should be a parameter to \documentclass
1303 if (language->babel() == "hebrew"
1304 && default_language->babel() != "hebrew")
1305 // This seems necessary
1306 features.useLanguage(default_language);
1308 ostringstream language_options;
1309 bool const use_babel = features.useBabel() && !tclass.provides("babel");
1310 bool const use_polyglossia = features.usePolyglossia();
1311 bool const global = lyxrc.language_global_options;
1312 if (use_babel || (use_polyglossia && global)) {
1313 language_options << features.getLanguages();
1314 if (!language->babel().empty()) {
1315 if (!language_options.str().empty())
1316 language_options << ',';
1317 language_options << language->babel();
1319 if (global && !features.needBabelLangOptions())
1320 clsoptions << language_options.str() << ',';
1323 // the predefined options from the layout
1324 if (use_default_options && !tclass.options().empty())
1325 clsoptions << tclass.options() << ',';
1327 // the user-defined options
1328 if (!options.empty()) {
1329 clsoptions << options << ',';
1332 string strOptions(clsoptions.str());
1333 if (!strOptions.empty()) {
1334 strOptions = rtrim(strOptions, ",");
1336 os << '[' << from_utf8(strOptions) << ']';
1339 os << '{' << from_ascii(tclass.latexname()) << "}\n";
1341 // end of \documentclass defs
1343 if (useNonTeXFonts) {
1344 os << "\\usepackage{fontspec}\n";
1348 // font selection must be done before loading fontenc.sty
1349 string const fonts =
1350 loadFonts(fonts_roman, fonts_sans,
1351 fonts_typewriter, fonts_expert_sc, fonts_old_figures,
1352 fonts_sans_scale, fonts_typewriter_scale, useNonTeXFonts);
1353 if (!fonts.empty()) {
1354 os << from_ascii(fonts);
1357 if (fonts_default_family != "default")
1358 os << "\\renewcommand{\\familydefault}{\\"
1359 << from_ascii(fonts_default_family) << "}\n";
1361 // set font encoding
1362 // for arabic_arabi and farsi we also need to load the LAE and
1364 // XeTeX and LuaTeX (with OS fonts) work without fontenc
1365 if (font_encoding() != "default" && language->lang() != "japanese"
1366 && !useNonTeXFonts && !tclass.provides("fontenc")) {
1367 size_t fars = language_options.str().find("farsi");
1368 size_t arab = language_options.str().find("arabic");
1369 if (language->lang() == "arabic_arabi"
1370 || language->lang() == "farsi" || fars != string::npos
1371 || arab != string::npos) {
1372 os << "\\usepackage[" << from_ascii(font_encoding())
1373 << ",LFE,LAE]{fontenc}\n";
1376 os << "\\usepackage[" << from_ascii(font_encoding())
1382 // handle inputenc etc.
1383 writeEncodingPreamble(os, features, texrow);
1386 if (!features.runparams().includeall && !included_children_.empty()) {
1387 os << "\\includeonly{";
1388 list<string>::const_iterator it = included_children_.begin();
1389 list<string>::const_iterator en = included_children_.end();
1391 for (; it != en; ++it) {
1392 string incfile = *it;
1393 FileName inc = makeAbsPath(incfile, filepath.absFileName());
1394 string mangled = DocFileName(changeExtension(inc.absFileName(), ".tex")).
1396 if (!features.runparams().nice)
1398 // \includeonly doesn't want an extension
1399 incfile = changeExtension(incfile, string());
1400 incfile = support::latex_path(incfile);
1401 if (!incfile.empty()) {
1404 os << from_utf8(incfile);
1411 if (!listings_params.empty() || features.isRequired("listings")) {
1412 os << "\\usepackage{listings}\n";
1415 if (!listings_params.empty()) {
1417 // do not test validity because listings_params is
1418 // supposed to be valid
1420 InsetListingsParams(listings_params).separatedParams(true);
1421 // we can't support all packages, but we should load the color package
1422 if (par.find("\\color", 0) != string::npos)
1423 features.require("color");
1424 os << from_utf8(par);
1425 // count the number of newlines
1426 for (size_t i = 0; i < par.size(); ++i)
1432 if (!tclass.provides("geometry")
1433 && (use_geometry || nonstandard_papersize)) {
1434 odocstringstream ods;
1435 if (!getGraphicsDriver("geometry").empty())
1436 ods << getGraphicsDriver("geometry");
1437 if (orientation == ORIENTATION_LANDSCAPE)
1438 ods << ",landscape";
1439 switch (papersize) {
1441 if (!paperwidth.empty())
1442 ods << ",paperwidth="
1443 << from_ascii(paperwidth);
1444 if (!paperheight.empty())
1445 ods << ",paperheight="
1446 << from_ascii(paperheight);
1448 case PAPER_USLETTER:
1449 ods << ",letterpaper";
1452 ods << ",legalpaper";
1454 case PAPER_USEXECUTIVE:
1455 ods << ",executivepaper";
1542 // default papersize ie PAPER_DEFAULT
1543 switch (lyxrc.default_papersize) {
1544 case PAPER_DEFAULT: // keep compiler happy
1545 case PAPER_USLETTER:
1546 ods << ",letterpaper";
1549 ods << ",legalpaper";
1551 case PAPER_USEXECUTIVE:
1552 ods << ",executivepaper";
1594 docstring const g_options = trim(ods.str(), ",");
1595 os << "\\usepackage";
1596 if (!g_options.empty())
1597 os << '[' << g_options << ']';
1598 os << "{geometry}\n";
1600 // output this only if use_geometry is true
1602 os << "\\geometry{verbose";
1603 if (!topmargin.empty())
1604 os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1605 if (!bottommargin.empty())
1606 os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1607 if (!leftmargin.empty())
1608 os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1609 if (!rightmargin.empty())
1610 os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1611 if (!headheight.empty())
1612 os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1613 if (!headsep.empty())
1614 os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1615 if (!footskip.empty())
1616 os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1617 if (!columnsep.empty())
1618 os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
1622 } else if (orientation == ORIENTATION_LANDSCAPE
1623 || papersize != PAPER_DEFAULT) {
1624 features.require("papersize");
1627 if (tokenPos(tclass.opt_pagestyle(),
1628 '|', pagestyle) >= 0) {
1629 if (pagestyle == "fancy") {
1630 os << "\\usepackage{fancyhdr}\n";
1633 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1637 // only output when the background color is not default
1638 if (isbackgroundcolor == true) {
1639 // only require color here, the background color will be defined
1640 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1642 features.require("color");
1643 features.require("pagecolor");
1646 // only output when the font color is not default
1647 if (isfontcolor == true) {
1648 // only require color here, the font color will be defined
1649 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1651 features.require("color");
1652 features.require("fontcolor");
1655 // Only if class has a ToC hierarchy
1656 if (tclass.hasTocLevels()) {
1657 if (secnumdepth != tclass.secnumdepth()) {
1658 os << "\\setcounter{secnumdepth}{"
1663 if (tocdepth != tclass.tocdepth()) {
1664 os << "\\setcounter{tocdepth}{"
1671 if (paragraph_separation) {
1672 // when skip separation
1673 switch (getDefSkip().kind()) {
1674 case VSpace::SMALLSKIP:
1675 os << "\\setlength{\\parskip}{\\smallskipamount}\n";
1677 case VSpace::MEDSKIP:
1678 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1680 case VSpace::BIGSKIP:
1681 os << "\\setlength{\\parskip}{\\bigskipamount}\n";
1683 case VSpace::LENGTH:
1684 os << "\\setlength{\\parskip}{"
1685 << from_utf8(getDefSkip().length().asLatexString())
1688 default: // should never happen // Then delete it.
1689 os << "\\setlength{\\parskip}{\\medskipamount}\n";
1693 os << "\\setlength{\\parindent}{0pt}\n";
1696 // when separation by indentation
1697 // only output something when a width is given
1698 if (getIndentation().asLyXCommand() != "default") {
1699 os << "\\setlength{\\parindent}{"
1700 << from_utf8(getIndentation().asLatexCommand())
1706 // Now insert the LyX specific LaTeX commands...
1707 docstring lyxpreamble;
1710 if (!output_sync_macro.empty())
1711 lyxpreamble += from_utf8(output_sync_macro) +"\n";
1712 else if (features.runparams().flavor == OutputParams::LATEX)
1713 lyxpreamble += "\\usepackage[active]{srcltx}\n";
1714 else if (features.runparams().flavor == OutputParams::PDFLATEX)
1715 lyxpreamble += "\\synctex=-1\n";
1718 // due to interferences with babel and hyperref, the color package has to
1719 // be loaded (when it is not already loaded) before babel when hyperref
1720 // is used with the colorlinks option, see
1721 // http://www.lyx.org/trac/ticket/5291
1722 // we decided therefore to load color always before babel, see
1723 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
1724 lyxpreamble += from_ascii(features.getColorOptions());
1726 // If we use hyperref, jurabib, japanese, or vietnamese, we have to call babel before them.
1728 && (features.isRequired("jurabib")
1729 || features.isRequired("hyperref")
1730 || features.isRequired("vietnamese")
1731 || features.isRequired("japanese"))) {
1733 lyxpreamble += from_utf8(features.getBabelPresettings());
1734 lyxpreamble += from_utf8(babelCall(language_options.str(),
1735 features.needBabelLangOptions())) + '\n';
1736 lyxpreamble += from_utf8(features.getBabelPostsettings());
1739 // The optional packages;
1740 lyxpreamble += from_ascii(features.getPackages());
1742 // Additional Indices
1743 if (features.isRequired("splitidx")) {
1744 IndicesList::const_iterator iit = indiceslist().begin();
1745 IndicesList::const_iterator iend = indiceslist().end();
1746 for (; iit != iend; ++iit) {
1747 lyxpreamble += "\\newindex[";
1748 lyxpreamble += iit->index();
1749 lyxpreamble += "]{";
1750 lyxpreamble += iit->shortcut();
1751 lyxpreamble += "}\n";
1756 lyxpreamble += from_utf8(spacing().writePreamble(tclass.provides("SetSpace")));
1759 // * Hyperref manual: "Make sure it comes last of your loaded
1760 // packages, to give it a fighting chance of not being over-written,
1761 // since its job is to redefine many LaTeX commands."
1762 // * Email from Heiko Oberdiek: "It is usually better to load babel
1763 // before hyperref. Then hyperref has a chance to detect babel.
1764 // * Has to be loaded before the "LyX specific LaTeX commands" to
1765 // avoid errors with algorithm floats.
1766 // use hyperref explicitly if it is required
1767 if (features.isRequired("hyperref")) {
1768 // pass what we have to stream here, since we need
1769 // to access the stream itself in PDFOptions.
1773 int(count(lyxpreamble.begin(), lyxpreamble.end(), '\n'));
1775 OutputParams tmp_params = features.runparams();
1776 lines += pdfoptions().writeLaTeX(tmp_params, os,
1777 documentClass().provides("hyperref"));
1778 texrow.newlines(lines);
1779 // set back for the rest
1780 lyxpreamble.clear();
1781 } else if (features.isRequired("nameref"))
1782 // hyperref loads this automatically
1783 lyxpreamble += "\\usepackage{nameref}\n";
1785 // Will be surrounded by \makeatletter and \makeatother when not empty
1786 docstring atlyxpreamble;
1788 // Some macros LyX will need
1789 docstring tmppreamble(features.getMacros());
1791 if (!tmppreamble.empty())
1792 atlyxpreamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1793 "LyX specific LaTeX commands.\n"
1794 + tmppreamble + '\n';
1796 // the text class specific preamble
1797 tmppreamble = features.getTClassPreamble();
1798 if (!tmppreamble.empty())
1799 atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1800 "Textclass specific LaTeX commands.\n"
1801 + tmppreamble + '\n';
1803 // suppress date if selected
1804 // use \@ifundefined because we cannot be sure that every document class
1805 // has a \date command
1807 atlyxpreamble += "\\@ifundefined{date}{}{\\date{}}\n";
1809 /* the user-defined preamble */
1810 if (!containsOnly(preamble, " \n\t"))
1812 atlyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1813 "User specified LaTeX commands.\n"
1814 + from_utf8(preamble) + '\n';
1816 // subfig loads internally the LaTeX package "caption". As
1817 // caption is a very popular package, users will load it in
1818 // the preamble. Therefore we must load subfig behind the
1819 // user-defined preamble and check if the caption package was
1820 // loaded or not. For the case that caption is loaded before
1821 // subfig, there is the subfig option "caption=false". This
1822 // option also works when a koma-script class is used and
1823 // koma's own caption commands are used instead of caption. We
1824 // use \PassOptionsToPackage here because the user could have
1825 // already loaded subfig in the preamble.
1826 if (features.isRequired("subfig")) {
1827 atlyxpreamble += "\\@ifundefined{showcaptionsetup}{}{%\n"
1828 " \\PassOptionsToPackage{caption=false}{subfig}}\n"
1829 "\\usepackage{subfig}\n";
1832 // Itemize bullet settings need to be last in case the user
1833 // defines their own bullets that use a package included
1834 // in the user-defined preamble -- ARRae
1835 // Actually it has to be done much later than that
1836 // since some packages like frenchb make modifications
1837 // at \begin{document} time -- JMarc
1838 docstring bullets_def;
1839 for (int i = 0; i < 4; ++i) {
1840 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1841 if (bullets_def.empty())
1842 bullets_def += "\\AtBeginDocument{\n";
1843 bullets_def += " \\def\\labelitemi";
1845 // `i' is one less than the item to modify
1852 bullets_def += "ii";
1858 bullets_def += '{' +
1859 user_defined_bullet(i).getText()
1864 if (!bullets_def.empty())
1865 atlyxpreamble += bullets_def + "}\n\n";
1867 if (!atlyxpreamble.empty())
1868 lyxpreamble += "\n\\makeatletter\n"
1869 + atlyxpreamble + "\\makeatother\n\n";
1871 // We try to load babel late, in case it interferes with other packages.
1872 // Jurabib and Hyperref have to be called after babel, though.
1873 if (use_babel && !features.isRequired("jurabib")
1874 && !features.isRequired("hyperref")
1875 && !features.isRequired("vietnamese")
1876 && !features.isRequired("japanese")) {
1878 lyxpreamble += from_utf8(features.getBabelPresettings());
1879 lyxpreamble += from_utf8(babelCall(language_options.str(),
1880 features.needBabelLangOptions())) + '\n';
1881 lyxpreamble += from_utf8(features.getBabelPostsettings());
1884 // FIXME Polyglossia?
1885 docstring const i18npreamble = features.getTClassI18nPreamble(use_babel);
1886 if (!i18npreamble.empty())
1887 lyxpreamble += i18npreamble + '\n';
1890 int(count(lyxpreamble.begin(), lyxpreamble.end(), '\n'));
1891 texrow.newlines(nlines);
1895 // xunicode needs to be loaded at least after amsmath, amssymb,
1896 // esint and the other packages that provide special glyphs
1897 if (features.runparams().flavor == OutputParams::XETEX) {
1898 os << "\\usepackage{xunicode}\n";
1901 // Polyglossia must be loaded last
1902 if (use_polyglossia) {
1904 os << "\\usepackage{polyglossia}\n";
1906 // set the main language
1907 os << "\\setdefaultlanguage";
1908 if (!language->polyglossiaOpts().empty())
1909 os << "[" << from_ascii(language->polyglossiaOpts()) << "]";
1910 os << "{" + from_ascii(language->polyglossia()) + "}\n";
1912 // now setup the other languages
1913 std::map<std::string, std::string> const polylangs =
1914 features.getPolyglossiaLanguages();
1915 for (std::map<std::string, std::string>::const_iterator mit = polylangs.begin();
1916 mit != polylangs.end() ; ++mit) {
1917 os << "\\setotherlanguage";
1918 if (!mit->second.empty())
1919 os << "[" << from_ascii(mit->second) << "]";
1920 os << "{" << from_ascii(mit->first) << "}\n";
1928 void BufferParams::useClassDefaults()
1930 DocumentClass const & tclass = documentClass();
1932 sides = tclass.sides();
1933 columns = tclass.columns();
1934 pagestyle = tclass.pagestyle();
1935 use_default_options = true;
1936 // Only if class has a ToC hierarchy
1937 if (tclass.hasTocLevels()) {
1938 secnumdepth = tclass.secnumdepth();
1939 tocdepth = tclass.tocdepth();
1944 bool BufferParams::hasClassDefaults() const
1946 DocumentClass const & tclass = documentClass();
1948 return sides == tclass.sides()
1949 && columns == tclass.columns()
1950 && pagestyle == tclass.pagestyle()
1951 && use_default_options
1952 && secnumdepth == tclass.secnumdepth()
1953 && tocdepth == tclass.tocdepth();
1957 DocumentClass const & BufferParams::documentClass() const
1963 DocumentClass const * BufferParams::documentClassPtr() const
1969 void BufferParams::setDocumentClass(DocumentClass const * const tc)
1971 // evil, but this function is evil
1972 doc_class_ = const_cast<DocumentClass *>(tc);
1976 bool BufferParams::setBaseClass(string const & classname)
1978 LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
1979 LayoutFileList & bcl = LayoutFileList::get();
1980 if (!bcl.haveClass(classname)) {
1982 bformat(_("The layout file:\n"
1984 "could not be found. A default textclass with default\n"
1985 "layouts will be used. LyX will not be able to produce\n"
1987 from_utf8(classname));
1988 frontend::Alert::error(_("Document class not found"), s);
1989 bcl.addEmptyClass(classname);
1992 bool const success = bcl[classname].load();
1995 bformat(_("Due to some error in it, the layout file:\n"
1997 "could not be loaded. A default textclass with default\n"
1998 "layouts will be used. LyX will not be able to produce\n"
2000 from_utf8(classname));
2001 frontend::Alert::error(_("Could not load class"), s);
2002 bcl.addEmptyClass(classname);
2005 pimpl_->baseClass_ = classname;
2006 layout_modules_.adaptToBaseClass(baseClass(), removed_modules_);
2011 LayoutFile const * BufferParams::baseClass() const
2013 if (LayoutFileList::get().haveClass(pimpl_->baseClass_))
2014 return &(LayoutFileList::get()[pimpl_->baseClass_]);
2020 LayoutFileIndex const & BufferParams::baseClassID() const
2022 return pimpl_->baseClass_;
2026 void BufferParams::makeDocumentClass()
2031 doc_class_ = &(DocumentClassBundle::get().makeDocumentClass(*baseClass(), layout_modules_));
2033 if (!local_layout.empty()) {
2034 if (!doc_class_->read(local_layout, TextClass::MODULE)) {
2035 docstring const msg = _("Error reading internal layout information");
2036 frontend::Alert::warning(_("Read Error"), msg);
2042 bool BufferParams::moduleCanBeAdded(string const & modName) const
2044 return layout_modules_.moduleCanBeAdded(modName, baseClass());
2048 bool BufferParams::addLayoutModule(string const & modName)
2050 LayoutModuleList::const_iterator it = layout_modules_.begin();
2051 LayoutModuleList::const_iterator end = layout_modules_.end();
2052 for (; it != end; it++)
2055 layout_modules_.push_back(modName);
2060 Font const BufferParams::getFont() const
2062 FontInfo f = documentClass().defaultfont();
2063 if (fonts_default_family == "rmdefault")
2064 f.setFamily(ROMAN_FAMILY);
2065 else if (fonts_default_family == "sfdefault")
2066 f.setFamily(SANS_FAMILY);
2067 else if (fonts_default_family == "ttdefault")
2068 f.setFamily(TYPEWRITER_FAMILY);
2069 return Font(f, language);
2073 void BufferParams::readPreamble(Lexer & lex)
2075 if (lex.getString() != "\\begin_preamble")
2076 lyxerr << "Error (BufferParams::readPreamble):"
2077 "consistency check failed." << endl;
2079 preamble = lex.getLongString("\\end_preamble");
2083 void BufferParams::readLocalLayout(Lexer & lex)
2085 if (lex.getString() != "\\begin_local_layout")
2086 lyxerr << "Error (BufferParams::readLocalLayout):"
2087 "consistency check failed." << endl;
2089 local_layout = lex.getLongString("\\end_local_layout");
2093 void BufferParams::readLanguage(Lexer & lex)
2095 if (!lex.next()) return;
2097 string const tmptok = lex.getString();
2099 // check if tmptok is part of tex_babel in tex-defs.h
2100 language = languages.getLanguage(tmptok);
2102 // Language tmptok was not found
2103 language = default_language;
2104 lyxerr << "Warning: Setting language `"
2105 << tmptok << "' to `" << language->lang()
2111 void BufferParams::readGraphicsDriver(Lexer & lex)
2116 string const tmptok = lex.getString();
2117 // check if tmptok is part of tex_graphics in tex_defs.h
2120 string const test = tex_graphics[n++];
2122 if (test == tmptok) {
2123 graphics_driver = tmptok;
2128 "Warning: graphics driver `$$Token' not recognized!\n"
2129 " Setting graphics driver to `default'.\n");
2130 graphics_driver = "default";
2137 void BufferParams::readBullets(Lexer & lex)
2142 int const index = lex.getInteger();
2144 int temp_int = lex.getInteger();
2145 user_defined_bullet(index).setFont(temp_int);
2146 temp_bullet(index).setFont(temp_int);
2148 user_defined_bullet(index).setCharacter(temp_int);
2149 temp_bullet(index).setCharacter(temp_int);
2151 user_defined_bullet(index).setSize(temp_int);
2152 temp_bullet(index).setSize(temp_int);
2156 void BufferParams::readBulletsLaTeX(Lexer & lex)
2158 // The bullet class should be able to read this.
2161 int const index = lex.getInteger();
2163 docstring const temp_str = lex.getDocString();
2165 user_defined_bullet(index).setText(temp_str);
2166 temp_bullet(index).setText(temp_str);
2170 void BufferParams::readModules(Lexer & lex)
2172 if (!lex.eatLine()) {
2173 lyxerr << "Error (BufferParams::readModules):"
2174 "Unexpected end of input." << endl;
2178 string mod = lex.getString();
2179 if (mod == "\\end_modules")
2181 addLayoutModule(mod);
2187 void BufferParams::readRemovedModules(Lexer & lex)
2189 if (!lex.eatLine()) {
2190 lyxerr << "Error (BufferParams::readRemovedModules):"
2191 "Unexpected end of input." << endl;
2195 string mod = lex.getString();
2196 if (mod == "\\end_removed_modules")
2198 removed_modules_.push_back(mod);
2201 // now we want to remove any removed modules that were previously
2202 // added. normally, that will be because default modules were added in
2203 // setBaseClass(), which gets called when \textclass is read at the
2204 // start of the read.
2205 list<string>::const_iterator rit = removed_modules_.begin();
2206 list<string>::const_iterator const ren = removed_modules_.end();
2207 for (; rit != ren; rit++) {
2208 LayoutModuleList::iterator const mit = layout_modules_.begin();
2209 LayoutModuleList::iterator const men = layout_modules_.end();
2210 LayoutModuleList::iterator found = find(mit, men, *rit);
2213 layout_modules_.erase(found);
2218 void BufferParams::readIncludeonly(Lexer & lex)
2220 if (!lex.eatLine()) {
2221 lyxerr << "Error (BufferParams::readIncludeonly):"
2222 "Unexpected end of input." << endl;
2226 string child = lex.getString();
2227 if (child == "\\end_includeonly")
2229 included_children_.push_back(child);
2235 string BufferParams::paperSizeName(PapersizePurpose purpose) const
2237 char real_papersize = papersize;
2238 if (real_papersize == PAPER_DEFAULT)
2239 real_papersize = lyxrc.default_papersize;
2241 switch (real_papersize) {
2243 // could be anything, so don't guess
2245 case PAPER_CUSTOM: {
2246 if (purpose == XDVI && !paperwidth.empty() &&
2247 !paperheight.empty()) {
2248 // heightxwidth<unit>
2249 string first = paperwidth;
2250 string second = paperheight;
2251 if (orientation == ORIENTATION_LANDSCAPE)
2254 return first.erase(first.length() - 2)
2260 // dvips and dvipdfm do not know this
2261 if (purpose == DVIPS || purpose == DVIPDFM)
2265 if (purpose == DVIPS || purpose == DVIPDFM)
2269 if (purpose == DVIPS || purpose == DVIPDFM)
2279 if (purpose == DVIPS || purpose == DVIPDFM)
2283 if (purpose == DVIPS || purpose == DVIPDFM)
2287 if (purpose == DVIPS || purpose == DVIPDFM)
2291 if (purpose == DVIPS || purpose == DVIPDFM)
2295 if (purpose == DVIPS || purpose == DVIPDFM)
2299 // dvipdfm does not know this
2300 if (purpose == DVIPDFM)
2304 if (purpose == DVIPDFM)
2308 if (purpose == DVIPS || purpose == DVIPDFM)
2312 if (purpose == DVIPS || purpose == DVIPDFM)
2316 if (purpose == DVIPS || purpose == DVIPDFM)
2320 if (purpose == DVIPS || purpose == DVIPDFM)
2324 if (purpose == DVIPS || purpose == DVIPDFM)
2328 if (purpose == DVIPS || purpose == DVIPDFM)
2332 if (purpose == DVIPS || purpose == DVIPDFM)
2336 if (purpose == DVIPS || purpose == DVIPDFM)
2340 if (purpose == DVIPS || purpose == DVIPDFM)
2344 if (purpose == DVIPS || purpose == DVIPDFM)
2348 if (purpose == DVIPS || purpose == DVIPDFM)
2352 if (purpose == DVIPS || purpose == DVIPDFM)
2356 if (purpose == DVIPS || purpose == DVIPDFM)
2360 if (purpose == DVIPS || purpose == DVIPDFM)
2364 if (purpose == DVIPS || purpose == DVIPDFM)
2367 case PAPER_USEXECUTIVE:
2368 // dvipdfm does not know this
2369 if (purpose == DVIPDFM)
2374 case PAPER_USLETTER:
2376 if (purpose == XDVI)
2383 string const BufferParams::dvips_options() const
2388 && papersize == PAPER_CUSTOM
2389 && !lyxrc.print_paper_dimension_flag.empty()
2390 && !paperwidth.empty()
2391 && !paperheight.empty()) {
2392 // using a custom papersize
2393 result = lyxrc.print_paper_dimension_flag;
2394 result += ' ' + paperwidth;
2395 result += ',' + paperheight;
2397 string const paper_option = paperSizeName(DVIPS);
2398 if (!paper_option.empty() && (paper_option != "letter" ||
2399 orientation != ORIENTATION_LANDSCAPE)) {
2400 // dvips won't accept -t letter -t landscape.
2401 // In all other cases, include the paper size
2403 result = lyxrc.print_paper_flag;
2404 result += ' ' + paper_option;
2407 if (orientation == ORIENTATION_LANDSCAPE &&
2408 papersize != PAPER_CUSTOM)
2409 result += ' ' + lyxrc.print_landscape_flag;
2414 string const BufferParams::font_encoding() const
2416 return (fontenc == "global") ? lyxrc.fontenc : fontenc;
2420 string BufferParams::babelCall(string const & lang_opts, bool const langoptions) const
2422 if (lyxrc.language_package_selection == LyXRC::LP_CUSTOM)
2423 return lyxrc.language_custom_package;
2424 // suppress the babel call if there is no BabelName defined
2425 // for the document language in the lib/languages file and if no
2426 // other languages are used (lang_opts is then empty)
2427 if (lang_opts.empty())
2429 // either a specific language (AsBabelOptions setting in
2430 // lib/languages) or the prefs require the languages to
2431 // be submitted to babel itself (not the class).
2433 return "\\usepackage[" + lang_opts + "]{babel}";
2434 return "\\usepackage{babel}";
2438 docstring BufferParams::getGraphicsDriver(string const & package) const
2442 if (package == "geometry") {
2443 if (graphics_driver == "dvips"
2444 || graphics_driver == "dvipdfm"
2445 || graphics_driver == "pdftex"
2446 || graphics_driver == "vtex")
2447 result = from_ascii(graphics_driver);
2448 else if (graphics_driver == "dvipdfmx")
2449 result = from_ascii("dvipdfm");
2456 void BufferParams::writeEncodingPreamble(odocstream & os,
2457 LaTeXFeatures & features, TexRow & texrow) const
2459 // XeTeX does not need this
2460 if (features.runparams().flavor == OutputParams::XETEX)
2462 // LuaTeX neither, but with tex fonts, we need to load
2463 // the luainputenc package.
2464 if (features.runparams().flavor == OutputParams::LUATEX) {
2465 if (!useNonTeXFonts) {
2466 os << "\\usepackage[utf8]{luainputenc}\n";
2471 if (inputenc == "auto") {
2472 string const doc_encoding =
2473 language->encoding()->latexName();
2474 Encoding::Package const package =
2475 language->encoding()->package();
2477 // Create a list with all the input encodings used
2479 set<string> encodings =
2480 features.getEncodingSet(doc_encoding);
2482 // If the "japanese" package (i.e. pLaTeX) is used,
2483 // inputenc must be omitted.
2484 // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
2485 if (package == Encoding::japanese)
2486 features.require("japanese");
2488 if ((!encodings.empty() || package == Encoding::inputenc)
2489 && !features.isRequired("japanese")) {
2490 os << "\\usepackage[";
2491 set<string>::const_iterator it = encodings.begin();
2492 set<string>::const_iterator const end = encodings.end();
2494 os << from_ascii(*it);
2497 for (; it != end; ++it)
2498 os << ',' << from_ascii(*it);
2499 if (package == Encoding::inputenc) {
2500 if (!encodings.empty())
2502 os << from_ascii(doc_encoding);
2504 os << "]{inputenc}\n";
2507 if (package == Encoding::CJK || features.mustProvide("CJK")) {
2508 if (language->encoding()->name() == "utf8-cjk"
2509 && LaTeXFeatures::isAvailable("CJKutf8"))
2510 os << "\\usepackage{CJKutf8}\n";
2512 os << "\\usepackage{CJK}\n";
2515 } else if (inputenc != "default") {
2516 switch (encoding().package()) {
2517 case Encoding::none:
2518 case Encoding::japanese:
2520 case Encoding::inputenc:
2521 // do not load inputenc if japanese is used
2522 if (features.isRequired("japanese"))
2524 os << "\\usepackage[" << from_ascii(inputenc)
2529 if (encoding().name() == "utf8-cjk"
2530 && LaTeXFeatures::isAvailable("CJKutf8"))
2531 os << "\\usepackage{CJKutf8}\n";
2533 os << "\\usepackage{CJK}\n";
2539 // The encoding "armscii8" (for Armenian) is only available when
2540 // the package "armtex" is loaded.
2541 if (language->encoding()->latexName() == "armscii8"
2542 || inputenc == "armscii8") {
2543 os << "\\usepackage{armtex}\n";
2549 string const BufferParams::parseFontName(string const & name) const
2551 string mangled = name;
2552 size_t const idx = mangled.find('[');
2553 if (idx == string::npos || idx == 0)
2556 return mangled.substr(0, idx - 1);
2560 string const BufferParams::loadFonts(string const & rm,
2561 string const & sf, string const & tt,
2562 bool const & sc, bool const & osf,
2563 int const & sfscale, int const & ttscale,
2564 bool const & use_systemfonts) const
2566 /* The LaTeX font world is in a flux. In the PSNFSS font interface,
2567 several packages have been replaced by others, that might not
2568 be installed on every system. We have to take care for that
2569 (see psnfss.pdf). We try to support all psnfss fonts as well
2570 as the fonts that have become de facto standard in the LaTeX
2571 world (e.g. Latin Modern). We do not support obsolete fonts
2572 (like PSLatex). In general, it should be possible to mix any
2573 rm font with any sf or tt font, respectively. (JSpitzm)
2575 -- separate math fonts.
2578 if (rm == "default" && sf == "default" && tt == "default")
2584 if (use_systemfonts) {
2585 if (rm != "default") {
2586 os << "\\setmainfont[Mapping=tex-text";
2588 os << ",Numbers=OldStyle";
2589 os << "]{" << parseFontName(rm) << "}\n";
2591 if (sf != "default") {
2592 string const sans = parseFontName(sf);
2594 os << "\\setsansfont[Scale="
2595 << float(sfscale) / 100
2596 << ",Mapping=tex-text]{"
2599 os << "\\setsansfont[Mapping=tex-text]{"
2602 if (tt != "default") {
2603 string const mono = parseFontName(tt);
2605 os << "\\setmonofont[Scale="
2606 << float(sfscale) / 100
2610 os << "\\setmonofont[Mapping=tex-text]{"
2617 // Computer Modern (must be explicitly selectable -- there might be classes
2618 // that define a different default font!
2620 os << "\\renewcommand{\\rmdefault}{cmr}\n";
2621 // osf for Computer Modern needs eco.sty
2623 os << "\\usepackage{eco}\n";
2625 // Latin Modern Roman
2626 else if (rm == "lmodern")
2627 os << "\\usepackage{lmodern}\n";
2629 else if (rm == "ae") {
2630 // not needed when using OT1 font encoding.
2631 if (font_encoding() != "default")
2632 os << "\\usepackage{ae,aecompl}\n";
2635 else if (rm == "times") {
2636 // try to load the best available package
2637 if (LaTeXFeatures::isAvailable("mathptmx"))
2638 os << "\\usepackage{mathptmx}\n";
2639 else if (LaTeXFeatures::isAvailable("mathptm"))
2640 os << "\\usepackage{mathptm}\n";
2642 os << "\\usepackage{times}\n";
2645 else if (rm == "palatino") {
2646 // try to load the best available package
2647 if (LaTeXFeatures::isAvailable("mathpazo")) {
2648 os << "\\usepackage";
2654 // "osf" includes "sc"!
2658 os << "{mathpazo}\n";
2660 else if (LaTeXFeatures::isAvailable("mathpple"))
2661 os << "\\usepackage{mathpple}\n";
2663 os << "\\usepackage{palatino}\n";
2666 else if (rm == "utopia") {
2667 // fourier supersedes utopia.sty, but does
2668 // not work with OT1 encoding.
2669 if (LaTeXFeatures::isAvailable("fourier")
2670 && font_encoding() != "default") {
2671 os << "\\usepackage";
2682 os << "{fourier}\n";
2685 os << "\\usepackage{utopia}\n";
2687 // Bera (complete fontset)
2688 else if (rm == "bera" && sf == "default" && tt == "default")
2689 os << "\\usepackage{bera}\n";
2691 else if (rm != "default")
2692 os << "\\usepackage" << "{" << rm << "}\n";
2695 // Helvetica, Bera Sans
2696 if (sf == "helvet" || sf == "berasans") {
2698 os << "\\usepackage[scaled=" << float(sfscale) / 100
2699 << "]{" << sf << "}\n";
2701 os << "\\usepackage{" << sf << "}\n";
2704 else if (sf == "avant")
2705 os << "\\usepackage{" << sf << "}\n";
2706 // Computer Modern, Latin Modern, CM Bright
2707 else if (sf != "default")
2708 os << "\\renewcommand{\\sfdefault}{" << sf << "}\n";
2710 // monospaced/typewriter
2711 // Courier, LuxiMono
2712 if (tt == "luximono" || tt == "beramono") {
2714 os << "\\usepackage[scaled=" << float(ttscale) / 100
2715 << "]{" << tt << "}\n";
2717 os << "\\usepackage{" << tt << "}\n";
2720 else if (tt == "courier" )
2721 os << "\\usepackage{" << tt << "}\n";
2722 // Computer Modern, Latin Modern, CM Bright
2723 else if (tt != "default")
2724 os << "\\renewcommand{\\ttdefault}{" << tt << "}\n";
2730 Encoding const & BufferParams::encoding() const
2732 // FIXME: actually, we should check for the flavor
2733 // or runparams.isFullyUnicode() here:
2734 // This check will not work with XeTeX/LuaTeX and tex fonts.
2735 // Thus we have to reset the encoding in Buffer::makeLaTeXFile.
2737 return *(encodings.fromLaTeXName("utf8-plain"));
2738 if (inputenc == "auto" || inputenc == "default")
2739 return *language->encoding();
2740 Encoding const * const enc = encodings.fromLaTeXName(inputenc);
2743 LYXERR0("Unknown inputenc value `" << inputenc
2744 << "'. Using `auto' instead.");
2745 return *language->encoding();
2749 CiteEngine BufferParams::citeEngine() const
2751 // FIXME the class should provide the numerical/
2752 // authoryear choice
2753 if (documentClass().provides("natbib")
2754 && cite_engine_ != ENGINE_NATBIB_NUMERICAL)
2755 return ENGINE_NATBIB_AUTHORYEAR;
2756 return cite_engine_;
2760 void BufferParams::setCiteEngine(CiteEngine cite_engine)
2762 cite_engine_ = cite_engine;