3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Jean-Marc Lasgouttes
8 * \author Angus Leeming
12 * Full author contact details are available in file CREDITS.
19 #include "BufferParams.h" // stateText
23 #include "LaTeXFeatures.h"
26 #include "output_latex.h"
27 #include "OutputParams.h"
28 #include "texstream.h"
30 #include "support/lassert.h"
31 #include "support/convert.h"
32 #include "support/debug.h"
33 #include "support/gettext.h"
34 #include "support/lstrings.h"
39 using namespace lyx::support;
44 // Strings used to read and write .lyx format files
46 // These are defined in FontInfo.cpp
47 extern char const * LyXFamilyNames[NUM_FAMILIES + 2];
48 extern char const * LyXSeriesNames[NUM_SERIES + 2];
49 extern char const * LyXShapeNames[NUM_SHAPE + 2];
50 extern char const * LyXSizeNames[NUM_SIZE + 4];
51 extern char const * LyXMiscNames[5];
59 char const * GUIFamilyNames[NUM_FAMILIES + 2 /* default & error */] =
60 { N_("Roman"), N_("Sans Serif"), N_("Typewriter"), N_("Symbol"),
61 "cmr", "cmsy", "cmm", "cmex", "msa", "msb", "eufrak", "rsfs", "stmry",
62 "wasy", "esint", N_("Inherit"), N_("Ignore") };
64 char const * GUISeriesNames[NUM_SERIES + 2 /* default & error */] =
65 { N_("Medium"), N_("Bold"), N_("Inherit"), N_("Ignore") };
67 char const * GUIShapeNames[NUM_SHAPE + 2 /* default & error */] =
68 { N_("Upright"), N_("Italic"), N_("Slanted"), N_("Smallcaps"), N_("Inherit"),
71 char const * GUISizeNames[NUM_SIZE + 4 /* increase, decrease, default & error */] =
72 { N_("Tiny"), N_("Smallest"), N_("Smaller"), N_("Small"), N_("Normal"), N_("Large"),
73 N_("Larger"), N_("Largest"), N_("Huge"), N_("Huger"), N_("Increase"), N_("Decrease"),
74 N_("Inherit"), N_("Ignore") };
76 char const * GUIMiscNames[5] =
77 { N_("Off"), N_("On"), N_("Toggle"), N_("Inherit"), N_("Ignore") };
80 // Strings used to write LaTeX files
82 char const * LaTeXFamilyNames[NUM_FAMILIES + 2] =
83 { "textrm", "textsf", "texttt", "error1", "error2", "error3", "error4",
84 "error5", "error6", "error7", "error8", "error9", "error10", "error11",
85 "error12", "error13" };
87 char const * LaTeXSeriesNames[NUM_SERIES + 2] =
88 { "textmd", "textbf", "error4", "error5" };
90 char const * LaTeXShapeNames[NUM_SHAPE + 2] =
91 { "textup", "textit", "textsl", "textsc", "error6", "error7" };
93 char const * LaTeXSizeNames[NUM_SIZE + 4] =
94 { "tiny", "scriptsize", "footnotesize", "small", "normalsize", "large",
95 "Large", "LARGE", "huge", "Huge", "error8", "error9", "error10", "error11" };
100 Font::Font(FontInfo bits, Language const * l)
101 : bits_(bits), lang_(l), open_encoding_(false)
104 lang_ = default_language;
108 bool Font::isRightToLeft() const
110 return lang_->rightToLeft();
114 bool Font::isVisibleRightToLeft() const
116 return (lang_->rightToLeft() &&
117 bits_.number() != FONT_ON);
121 void Font::setLanguage(Language const * l)
127 /// Updates font settings according to request
128 void Font::update(Font const & newfont,
129 Language const * document_language,
132 bits_.update(newfont.fontInfo(), toggleall);
134 if (newfont.language() == language() && toggleall)
135 if (language() == document_language)
136 setLanguage(default_language);
138 setLanguage(document_language);
139 else if (newfont.language() == reset_language)
140 setLanguage(document_language);
141 else if (newfont.language() != ignore_language)
142 setLanguage(newfont.language());
146 docstring const stateText(FontInfo const & f)
149 if (f.family() != INHERIT_FAMILY)
150 os << _(GUIFamilyNames[f.family()]) << ", ";
151 if (f.series() != INHERIT_SERIES)
152 os << _(GUISeriesNames[f.series()]) << ", ";
153 if (f.shape() != INHERIT_SHAPE)
154 os << _(GUIShapeNames[f.shape()]) << ", ";
155 if (f.size() != FONT_SIZE_INHERIT)
156 os << _(GUISizeNames[f.size()]) << ", ";
157 if (f.color() != Color_inherit)
158 os << lcolor.getGUIName(f.color()) << ", ";
159 // FIXME: uncomment this when we support background.
160 //if (f.background() != Color_inherit)
161 // os << lcolor.getGUIName(f.background()) << ", ";
162 if (f.emph() != FONT_INHERIT)
163 os << bformat(_("Emphasis %1$s, "),
164 _(GUIMiscNames[f.emph()]));
165 if (f.underbar() != FONT_INHERIT)
166 os << bformat(_("Underline %1$s, "),
167 _(GUIMiscNames[f.underbar()]));
168 if (f.strikeout() != FONT_INHERIT)
169 os << bformat(_("Strike out %1$s, "),
170 _(GUIMiscNames[f.strikeout()]));
171 if (f.xout() != FONT_INHERIT)
172 os << bformat(_("Cross out %1$s, "),
173 _(GUIMiscNames[f.xout()]));
174 if (f.uuline() != FONT_INHERIT)
175 os << bformat(_("Double underline %1$s, "),
176 _(GUIMiscNames[f.uuline()]));
177 if (f.uwave() != FONT_INHERIT)
178 os << bformat(_("Wavy underline %1$s, "),
179 _(GUIMiscNames[f.uwave()]));
180 if (f.noun() != FONT_INHERIT)
181 os << bformat(_("Noun %1$s, "),
182 _(GUIMiscNames[f.noun()]));
183 if (f == inherit_font)
184 os << _("Default") << ", ";
190 docstring const Font::stateText(BufferParams * params) const
193 os << lyx::stateText(bits_);
194 if (!params || (language() != params->language))
195 os << bformat(_("Language: %1$s, "),
196 _(language()->display()));
197 if (bits_.number() != FONT_OFF)
198 os << " " << bformat(_("Number %1$s"),
199 _(GUIMiscNames[bits_.number()]));
200 return rtrim(os.str(), ", ");
204 // Returns size in latex format
205 string const Font::latexSize() const
207 return LaTeXSizeNames[bits_.size()];
211 /// Writes the changes from this font to orgfont in .lyx format in file
212 void Font::lyxWriteChanges(Font const & orgfont,
216 if (orgfont.fontInfo().family() != bits_.family())
217 os << "\\family " << LyXFamilyNames[bits_.family()] << "\n";
218 if (orgfont.fontInfo().series() != bits_.series())
219 os << "\\series " << LyXSeriesNames[bits_.series()] << "\n";
220 if (orgfont.fontInfo().shape() != bits_.shape())
221 os << "\\shape " << LyXShapeNames[bits_.shape()] << "\n";
222 if (orgfont.fontInfo().size() != bits_.size())
223 os << "\\size " << LyXSizeNames[bits_.size()] << "\n";
224 if (orgfont.fontInfo().emph() != bits_.emph())
225 os << "\\emph " << LyXMiscNames[bits_.emph()] << "\n";
226 if (orgfont.fontInfo().number() != bits_.number())
227 os << "\\numeric " << LyXMiscNames[bits_.number()] << "\n";
228 if (orgfont.fontInfo().underbar() != bits_.underbar()) {
229 // This is only for backwards compatibility
230 switch (bits_.underbar()) {
231 case FONT_OFF: os << "\\bar no\n"; break;
232 case FONT_ON: os << "\\bar under\n"; break;
233 case FONT_TOGGLE: lyxerr << "Font::lyxWriteFontChanges: "
234 "FONT_TOGGLE should not appear here!"
237 case FONT_INHERIT: os << "\\bar default\n"; break;
238 case FONT_IGNORE: lyxerr << "Font::lyxWriteFontChanges: "
239 "IGNORE should not appear here!"
244 if (orgfont.fontInfo().strikeout() != bits_.strikeout()) {
245 os << "\\strikeout " << LyXMiscNames[bits_.strikeout()] << "\n";
247 if (orgfont.fontInfo().xout() != bits_.xout()) {
248 os << "\\xout " << LyXMiscNames[bits_.xout()] << "\n";
250 if (orgfont.fontInfo().uuline() != bits_.uuline()) {
251 os << "\\uuline " << LyXMiscNames[bits_.uuline()] << "\n";
253 if (orgfont.fontInfo().uwave() != bits_.uwave()) {
254 os << "\\uwave " << LyXMiscNames[bits_.uwave()] << "\n";
256 if (orgfont.fontInfo().noun() != bits_.noun()) {
257 os << "\\noun " << LyXMiscNames[bits_.noun()] << "\n";
259 if (orgfont.fontInfo().color() != bits_.color())
260 os << "\\color " << lcolor.getLyXName(bits_.color()) << '\n';
261 // FIXME: uncomment this when we support background.
262 //if (orgfont.fontInfo().background() != bits_.background())
263 // os << "\\color " << lcolor.getLyXName(bits_.background()) << '\n';
264 if (orgfont.language() != language() &&
265 language() != latex_language) {
267 os << "\\lang " << language()->lang() << "\n";
269 os << "\\lang unknown\n";
274 /// Writes the head of the LaTeX needed to impose this font
275 // Returns number of chars written.
276 int Font::latexWriteStartChanges(odocstream & os, BufferParams const & bparams,
277 OutputParams const & runparams,
279 Font const & prev) const
285 // polyglossia or babel?
286 if (runparams.use_polyglossia
287 && language()->lang() != base.language()->lang()
288 && language() != prev.language()) {
289 if (!language()->polyglossia().empty()) {
290 string tmp = "\\text" + language()->polyglossia();
291 if (!language()->polyglossiaOpts().empty())
292 tmp += "[" + language()->polyglossiaOpts() + "]";
294 os << from_ascii(tmp);
295 count += tmp.length();
296 pushLanguageName(language()->polyglossia(), true);
297 } else if (language()->encoding()->package() != Encoding::CJK) {
301 } else if (language()->babel() != base.language()->babel() &&
302 language() != prev.language()) {
303 if (language()->lang() == "farsi") {
306 } else if (!isRightToLeft() &&
307 base.language()->lang() == "farsi") {
310 } else if (language()->lang() == "arabic_arabi") {
313 } else if (!isRightToLeft() &&
314 base.language()->lang() == "arabic_arabi") {
317 // currently the remaining RTL languages are arabic_arabtex and hebrew
318 } else if (isRightToLeft() != prev.isRightToLeft()) {
319 if (isRightToLeft()) {
326 } else if (!language()->babel().empty()) {
328 subst(lyxrc.language_command_local,
329 "$$lang", language()->babel());
330 os << from_ascii(tmp);
331 count += tmp.length();
332 if (!lyxrc.language_command_end.empty())
333 pushLanguageName(language()->babel(), true);
334 } else if (language()->encoding()->package() != Encoding::CJK) {
340 if (language()->encoding()->package() == Encoding::CJK) {
341 pair<bool, int> const c = switchEncoding(os, bparams,
342 runparams, *(language()->encoding()));
344 open_encoding_ = true;
346 runparams.encoding = language()->encoding();
351 f.reduce(base.bits_);
353 p.reduce(prev.bits_);
355 if (f.family() != INHERIT_FAMILY) {
357 << LaTeXFamilyNames[f.family()]
359 count += strlen(LaTeXFamilyNames[f.family()]) + 2;
360 env = true; //We have opened a new environment
362 if (f.series() != INHERIT_SERIES) {
364 << LaTeXSeriesNames[f.series()]
366 count += strlen(LaTeXSeriesNames[f.series()]) + 2;
367 env = true; //We have opened a new environment
369 if (f.shape() != INHERIT_SHAPE) {
371 << LaTeXShapeNames[f.shape()]
373 count += strlen(LaTeXShapeNames[f.shape()]) + 2;
374 env = true; //We have opened a new environment
376 if (f.color() != Color_inherit && f.color() != Color_ignore) {
377 if (f.color() == Color_none && p.color() != Color_none) {
378 // Color none: Close previous color, if any
381 } else if (f.color() != Color_none) {
383 << from_ascii(lcolor.getLaTeXName(f.color()))
385 count += lcolor.getLaTeXName(f.color()).length() + 13;
387 env = true; //We have opened a new environment
389 // FIXME: uncomment this when we support background.
391 if (f.background() != Color_inherit && f.background() != Color_ignore) {
393 << from_ascii(lcolor.getLaTeXName(f.background()))
395 count += lcolor.getLaTeXName(f.background()).length() + 13;
396 env = true; //We have opened a new environment
399 // If the current language is Hebrew, Arabic, or Farsi
400 // the numbers are written Left-to-Right. ArabTeX package
401 // and bidi (polyglossia) reorder the number automatically
402 // but the packages used for Hebrew and Farsi (Arabi) do not.
403 if (!runparams.use_polyglossia
404 && !runparams.pass_thru
405 && bits_.number() == FONT_ON
406 && prev.fontInfo().number() != FONT_ON
407 && (language()->lang() == "hebrew"
408 || language()->lang() == "farsi"
409 || language()->lang() == "arabic_arabi")) {
413 if (f.emph() == FONT_ON) {
416 env = true; //We have opened a new environment
418 // \noun{} is a LyX special macro
419 if (f.noun() == FONT_ON) {
422 env = true; //We have opened a new environment
424 if (f.size() != FONT_SIZE_INHERIT) {
425 // If we didn't open an environment above, we open one here
431 << LaTeXSizeNames[f.size()]
433 count += strlen(LaTeXSizeNames[f.size()]) + 3;
435 // The ulem commands need to be on the deepest nesting level
436 // because ulem puts every nested group or macro in a box,
437 // which prevents linebreaks (#8424, #8733)
438 if (f.underbar() == FONT_ON) {
441 ++runparams.inulemcmd;
443 if (f.uuline() == FONT_ON) {
446 ++runparams.inulemcmd;
448 if (f.strikeout() == FONT_ON) {
451 ++runparams.inulemcmd;
453 if (f.xout() == FONT_ON) {
456 ++runparams.inulemcmd;
458 if (f.uwave() == FONT_ON) {
459 if (runparams.inulemcmd) {
460 // needed with nested uwave in xout
461 // see https://tex.stackexchange.com/a/263042
462 os << "\\ULdepth=1000pt";
467 ++runparams.inulemcmd;
473 /// Writes ending block of LaTeX needed to close use of this font
474 // Returns number of chars written
475 // This one corresponds to latexWriteStartChanges(). (Asger)
476 int Font::latexWriteEndChanges(otexstream & os, BufferParams const & bparams,
477 OutputParams const & runparams,
481 bool const & closeLanguage) const
486 // reduce the current font to changes against the base
487 // font (of the layout). We use a temporary for this to
488 // avoid changing this font instance, as that would break
490 f.reduce(base.bits_);
492 if (f.family() != INHERIT_FAMILY) {
495 env = true; // Size change need not bother about closing env.
497 if (f.series() != INHERIT_SERIES) {
500 env = true; // Size change need not bother about closing env.
502 if (f.shape() != INHERIT_SHAPE) {
505 env = true; // Size change need not bother about closing env.
507 if (f.color() != Color_inherit && f.color() != Color_ignore && f.color() != Color_none) {
510 env = true; // Size change need not bother about closing env.
512 if (f.emph() == FONT_ON) {
515 env = true; // Size change need not bother about closing env.
517 if (f.noun() == FONT_ON) {
520 env = true; // Size change need not bother about closing env.
522 if (f.size() != FONT_SIZE_INHERIT) {
523 // We only have to close if only size changed
525 if (needPar && !closeLanguage) {
534 if (f.underbar() == FONT_ON) {
537 --runparams.inulemcmd;
539 if (f.strikeout() == FONT_ON) {
542 --runparams.inulemcmd;
544 if (f.xout() == FONT_ON) {
547 --runparams.inulemcmd;
549 if (f.uuline() == FONT_ON) {
552 --runparams.inulemcmd;
554 if (f.uwave() == FONT_ON) {
557 --runparams.inulemcmd;
560 // If the current language is Hebrew, Arabic, or Farsi
561 // the numbers are written Left-to-Right. ArabTeX package
562 // and bidi (polyglossia) reorder the number automatically
563 // but the packages used for Hebrew and Farsi (Arabi) do not.
564 if (!runparams.use_polyglossia
565 && !runparams.pass_thru
566 && bits_.number() == FONT_ON
567 && next.fontInfo().number() != FONT_ON
568 && (language()->lang() == "hebrew"
569 || language()->lang() == "farsi"
570 || language()->lang() == "arabic_arabi")) {
575 if (open_encoding_) {
576 // We need to close the encoding even if it does not change
577 // to do correct environment nesting
578 Encoding const * const ascii = encodings.fromLyXName("ascii");
579 pair<bool, int> const c = switchEncoding(os.os(), bparams,
583 runparams.encoding = ascii;
584 open_encoding_ = false;
588 && language() != base.language() && language() != next.language()
589 && language()->encoding()->package() != Encoding::CJK) {
592 bool const using_begin_end =
593 runparams.use_polyglossia ||
594 !lyxrc.language_command_end.empty();
603 string Font::toString(bool const toggle) const
605 string const lang = (language() == reset_language)
606 ? "reset" : language()->lang();
609 os << "family " << bits_.family() << '\n'
610 << "series " << bits_.series() << '\n'
611 << "shape " << bits_.shape() << '\n'
612 << "size " << bits_.size() << '\n'
613 << "emph " << bits_.emph() << '\n'
614 << "underbar " << bits_.underbar() << '\n'
615 << "strikeout " << bits_.strikeout() << '\n'
616 << "xout " << bits_.xout() << '\n'
617 << "uuline " << bits_.uuline() << '\n'
618 << "uwave " << bits_.uwave() << '\n'
619 << "noun " << bits_.noun() << '\n'
620 << "number " << bits_.number() << '\n'
621 << "color " << bits_.color() << '\n'
622 << "language " << lang << '\n'
623 << "toggleall " << convert<string>(toggle);
628 bool Font::fromString(string const & data, bool & toggle)
630 istringstream is(data);
638 token = lex.getString();
640 if (token.empty() || !lex.next())
643 if (token == "family") {
644 int const next = lex.getInteger();
645 bits_.setFamily(FontFamily(next));
647 } else if (token == "series") {
648 int const next = lex.getInteger();
649 bits_.setSeries(FontSeries(next));
651 } else if (token == "shape") {
652 int const next = lex.getInteger();
653 bits_.setShape(FontShape(next));
655 } else if (token == "size") {
656 int const next = lex.getInteger();
657 bits_.setSize(FontSize(next));
659 } else if (token == "emph" || token == "underbar"
660 || token == "noun" || token == "number"
661 || token == "uuline" || token == "uwave"
662 || token == "strikeout" || token == "xout") {
664 int const next = lex.getInteger();
665 FontState const misc = FontState(next);
669 else if (token == "underbar")
670 bits_.setUnderbar(misc);
671 else if (token == "strikeout")
672 bits_.setStrikeout(misc);
673 else if (token == "xout")
675 else if (token == "uuline")
676 bits_.setUuline(misc);
677 else if (token == "uwave")
678 bits_.setUwave(misc);
679 else if (token == "noun")
681 else if (token == "number")
682 bits_.setNumber(misc);
684 } else if (token == "color") {
685 int const next = lex.getInteger();
686 bits_.setColor(ColorCode(next));
689 } else if (token == "background") {
690 int const next = lex.getInteger();
691 bits_.setBackground(ColorCode(next));
694 } else if (token == "language") {
695 string const next = lex.getString();
696 setLanguage(languages.getLanguage(next));
698 } else if (token == "toggleall") {
699 toggle = lex.getBool();
702 // Unrecognised token
712 void Font::validate(LaTeXFeatures & features) const
714 BufferParams const & bparams = features.bufferParams();
715 Language const * doc_language = bparams.language;
717 if (bits_.noun() == FONT_ON) {
718 LYXERR(Debug::LATEX, "font.noun: " << bits_.noun());
719 features.require("noun");
720 LYXERR(Debug::LATEX, "Noun enabled. Font: " << to_utf8(stateText(0)));
722 if (bits_.underbar() == FONT_ON) {
723 LYXERR(Debug::LATEX, "font.underline: " << bits_.underbar());
724 features.require("ulem");
725 LYXERR(Debug::LATEX, "Underline enabled. Font: " << to_utf8(stateText(0)));
727 if (bits_.strikeout() == FONT_ON) {
728 LYXERR(Debug::LATEX, "font.strikeout: " << bits_.strikeout());
729 features.require("ulem");
730 LYXERR(Debug::LATEX, "Strike out enabled. Font: " << to_utf8(stateText(0)));
732 if (bits_.xout() == FONT_ON) {
733 LYXERR(Debug::LATEX, "font.xout: " << bits_.xout());
734 features.require("ulem");
735 LYXERR(Debug::LATEX, "Cross out enabled. Font: " << to_utf8(stateText(0)));
737 if (bits_.uuline() == FONT_ON) {
738 LYXERR(Debug::LATEX, "font.uuline: " << bits_.uuline());
739 features.require("ulem");
740 LYXERR(Debug::LATEX, "Double underline enabled. Font: " << to_utf8(stateText(0)));
742 if (bits_.uwave() == FONT_ON) {
743 LYXERR(Debug::LATEX, "font.uwave: " << bits_.uwave());
744 features.require("ulem");
745 LYXERR(Debug::LATEX, "Wavy underline enabled. Font: " << to_utf8(stateText(0)));
747 switch (bits_.color()) {
751 // probably we should put here all interface colors used for
752 // font displaying! For now I just add this ones I know of (Jug)
754 case Color_notelabel:
759 case Color_lightgray:
767 features.require("xcolor");
770 features.require("color");
771 LYXERR(Debug::LATEX, "Color enabled. Font: " << to_utf8(stateText(0)));
774 // FIXME: Do something for background and soul package?
776 if (((features.usePolyglossia() && lang_->polyglossia() != doc_language->polyglossia())
777 || (features.useBabel() && lang_->babel() != doc_language->babel())
778 || (doc_language->encoding()->package() == Encoding::CJK && lang_ != doc_language))
779 && lang_ != ignore_language
780 && lang_ != latex_language)
782 features.useLanguage(lang_);
783 LYXERR(Debug::LATEX, "Found language " << lang_->lang());
788 ostream & operator<<(ostream & os, FontState fms)
790 return os << int(fms);
794 ostream & operator<<(ostream & os, FontInfo const & f)
797 << " family " << f.family()
798 << " series " << f.series()
799 << " shape " << f.shape()
800 << " size " << f.size()
801 << " color " << f.color()
802 // FIXME: uncomment this when we support background.
803 //<< " background " << f.background()
804 << " emph " << f.emph()
805 << " underbar " << f.underbar()
806 << " strikeout " << f.strikeout()
807 << " xout " << f.xout()
808 << " uuline " << f.uuline()
809 << " uwave " << f.uwave()
810 << " noun " << f.noun()
811 << " number " << f.number();
815 ostream & operator<<(ostream & os, Font const & font)
817 return os << font.bits_
818 << " lang: " << (font.lang_ ? font.lang_->lang() : 0);