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
26 #include "output_latex.h"
28 #include "support/lstrings.h"
33 using support::ascii_lowercase;
34 using support::bformat;
42 #ifndef CXX_GLOBAL_CSTD
52 char const * GUIFamilyNames[LyXFont::NUM_FAMILIES + 2 /* default & error */] =
53 { N_("Roman"), N_("Sans Serif"), N_("Typewriter"), N_("Symbol"),
54 "cmr", "cmsy", "cmm", "cmex", "msa", "msb", "eufrak", "wasy", "esint",
55 N_("Inherit"), N_("Ignore") };
57 char const * GUISeriesNames[4] =
58 { N_("Medium"), N_("Bold"), N_("Inherit"), N_("Ignore") };
60 char const * GUIShapeNames[6] =
61 { N_("Upright"), N_("Italic"), N_("Slanted"), N_("Smallcaps"), N_("Inherit"),
64 char const * GUISizeNames[14] =
65 { N_("Tiny"), N_("Smallest"), N_("Smaller"), N_("Small"), N_("Normal"), N_("Large"),
66 N_("Larger"), N_("Largest"), N_("Huge"), N_("Huger"), N_("Increase"), N_("Decrease"),
67 N_("Inherit"), N_("Ignore") };
69 char const * GUIMiscNames[5] =
70 { N_("Off"), N_("On"), N_("Toggle"), N_("Inherit"), N_("Ignore") };
74 // Strings used to read and write .lyx format files
76 char const * LyXFamilyNames[LyXFont::NUM_FAMILIES + 2 /* default & error */] =
77 { "roman", "sans", "typewriter", "symbol",
78 "cmr", "cmsy", "cmm", "cmex", "msa", "msb", "eufrak", "wasy", "esint",
81 char const * LyXSeriesNames[4] =
82 { "medium", "bold", "default", "error" };
84 char const * LyXShapeNames[6] =
85 { "up", "italic", "slanted", "smallcaps", "default", "error" };
87 char const * LyXSizeNames[14] =
88 { "tiny", "scriptsize", "footnotesize", "small", "normal", "large",
89 "larger", "largest", "huge", "giant",
90 "increase", "decrease", "default", "error" };
92 char const * LyXMiscNames[5] =
93 { "off", "on", "toggle", "default", "error" };
96 // Strings used to write LaTeX files
98 char const * LaTeXFamilyNames[6] =
99 { "textrm", "textsf", "texttt", "error1", "error2", "error3" };
101 char const * LaTeXSeriesNames[4] =
102 { "textmd", "textbf", "error4", "error5" };
104 char const * LaTeXShapeNames[6] =
105 { "textup", "textit", "textsl", "textsc", "error6", "error7" };
107 char const * LaTeXSizeNames[14] =
108 { "tiny", "scriptsize", "footnotesize", "small", "normalsize", "large",
109 "Large", "LARGE", "huge", "Huge", "error8", "error9", "error10", "error11" };
114 // Initialize static member
115 LyXFont::FontBits LyXFont::sane = {
126 // Initialize static member
127 LyXFont::FontBits LyXFont::inherit = {
138 // Initialize static member
139 LyXFont::FontBits LyXFont::ignore = {
151 bool operator==(LyXFont::FontBits const & lhs,
152 LyXFont::FontBits const & rhs)
154 return lhs.family == rhs.family &&
155 lhs.series == rhs.series &&
156 lhs.shape == rhs.shape &&
157 lhs.size == rhs.size &&
158 lhs.color == rhs.color &&
159 lhs.emph == rhs.emph &&
160 lhs.underbar == rhs.underbar &&
161 lhs.noun == rhs.noun &&
162 lhs.number == rhs.number;
167 : bits(sane), lang(default_language)
171 LyXFont::LyXFont(LyXFont::FONT_INIT1)
172 : bits(inherit), lang(default_language)
176 LyXFont::LyXFont(LyXFont::FONT_INIT2)
177 : bits(ignore), lang(ignore_language)
181 LyXFont::LyXFont(LyXFont::FONT_INIT3)
182 : bits(sane), lang(default_language)
186 LyXFont::LyXFont(LyXFont::FONT_INIT1, Language const * l)
187 : bits(inherit), lang(l)
191 LyXFont::LyXFont(LyXFont::FONT_INIT2, Language const * l)
192 : bits(ignore), lang(l)
196 LyXFont::LyXFont(LyXFont::FONT_INIT3, Language const * l)
197 : bits(sane), lang(l)
202 LColor_color LyXFont::color() const
204 return LColor::color(bits.color);
208 bool LyXFont::isRightToLeft() const
210 return lang->rightToLeft();
214 bool LyXFont::isVisibleRightToLeft() const
216 return (lang->rightToLeft() &&
221 void LyXFont::setFamily(LyXFont::FONT_FAMILY f)
227 void LyXFont::setSeries(LyXFont::FONT_SERIES s)
233 void LyXFont::setShape(LyXFont::FONT_SHAPE s)
239 void LyXFont::setSize(LyXFont::FONT_SIZE s)
245 void LyXFont::setEmph(LyXFont::FONT_MISC_STATE e)
251 void LyXFont::setUnderbar(LyXFont::FONT_MISC_STATE u)
257 void LyXFont::setNoun(LyXFont::FONT_MISC_STATE n)
263 void LyXFont::setColor(LColor_color c)
269 void LyXFont::setLanguage(Language const * l)
275 void LyXFont::setNumber(LyXFont::FONT_MISC_STATE n)
281 /// Decreases font size by one
282 LyXFont & LyXFont::decSize()
285 case SIZE_HUGER: setSize(SIZE_HUGE); break;
286 case SIZE_HUGE: setSize(SIZE_LARGEST); break;
287 case SIZE_LARGEST: setSize(SIZE_LARGER); break;
288 case SIZE_LARGER: setSize(SIZE_LARGE); break;
289 case SIZE_LARGE: setSize(SIZE_NORMAL); break;
290 case SIZE_NORMAL: setSize(SIZE_SMALL); break;
291 case SIZE_SMALL: setSize(SIZE_FOOTNOTE); break;
292 case SIZE_FOOTNOTE: setSize(SIZE_SCRIPT); break;
293 case SIZE_SCRIPT: setSize(SIZE_TINY); break;
294 case SIZE_TINY: break;
296 lyxerr << "Can't LyXFont::decSize on INCREASE_SIZE" << endl;
299 lyxerr <<"Can't LyXFont::decSize on DECREASE_SIZE" << endl;
302 lyxerr <<"Can't LyXFont::decSize on INHERIT_SIZE" << endl;
305 lyxerr <<"Can't LyXFont::decSize on IGNORE_SIZE" << endl;
312 /// Increases font size by one
313 LyXFont & LyXFont::incSize()
316 case SIZE_HUGER: break;
317 case SIZE_HUGE: setSize(SIZE_HUGER); break;
318 case SIZE_LARGEST: setSize(SIZE_HUGE); break;
319 case SIZE_LARGER: setSize(SIZE_LARGEST); break;
320 case SIZE_LARGE: setSize(SIZE_LARGER); break;
321 case SIZE_NORMAL: setSize(SIZE_LARGE); break;
322 case SIZE_SMALL: setSize(SIZE_NORMAL); break;
323 case SIZE_FOOTNOTE: setSize(SIZE_SMALL); break;
324 case SIZE_SCRIPT: setSize(SIZE_FOOTNOTE); break;
325 case SIZE_TINY: setSize(SIZE_SCRIPT); break;
327 lyxerr <<"Can't LyXFont::incSize on INCREASE_SIZE" << endl;
330 lyxerr <<"Can't LyXFont::incSize on DECREASE_SIZE" << endl;
333 lyxerr <<"Can't LyXFont::incSize on INHERIT_SIZE" << endl;
336 lyxerr <<"Can't LyXFont::incSize on IGNORE_SIZE" << endl;
343 /// Updates a misc setting according to request
344 LyXFont::FONT_MISC_STATE LyXFont::setMisc(FONT_MISC_STATE newfont,
347 if (newfont == TOGGLE) {
353 lyxerr <<"LyXFont::setMisc: Need state"
354 " ON or OFF to toggle. Setting to ON" << endl;
357 } else if (newfont == IGNORE)
364 /// Updates font settings according to request
365 void LyXFont::update(LyXFont const & newfont,
366 Language const * document_language,
369 if (newfont.family() == family() && toggleall)
370 setFamily(INHERIT_FAMILY); // toggle 'back'
371 else if (newfont.family() != IGNORE_FAMILY)
372 setFamily(newfont.family());
373 // else it's IGNORE_SHAPE
375 // "Old" behaviour: "Setting" bold will toggle bold on/off.
376 switch (newfont.series()) {
379 if (series() == BOLD_SERIES && toggleall)
380 setSeries(MEDIUM_SERIES);
382 setSeries(BOLD_SERIES);
386 setSeries(newfont.series());
392 if (newfont.shape() == shape() && toggleall)
393 setShape(INHERIT_SHAPE); // toggle 'back'
394 else if (newfont.shape() != IGNORE_SHAPE)
395 setShape(newfont.shape());
396 // else it's IGNORE_SHAPE
398 if (newfont.size() != IGNORE_SIZE) {
399 if (newfont.size() == INCREASE_SIZE)
401 else if (newfont.size() == DECREASE_SIZE)
404 setSize(newfont.size());
407 setEmph(setMisc(newfont.emph(), emph()));
408 setUnderbar(setMisc(newfont.underbar(), underbar()));
409 setNoun(setMisc(newfont.noun(), noun()));
411 setNumber(setMisc(newfont.number(), number()));
412 if (newfont.language() == language() && toggleall)
413 if (language() == document_language)
414 setLanguage(default_language);
416 setLanguage(document_language);
417 else if (newfont.language() != ignore_language)
418 setLanguage(newfont.language());
420 if (newfont.color() == color() && toggleall)
421 setColor(LColor::inherit); // toggle 'back'
422 else if (newfont.color() != LColor::ignore)
423 setColor(newfont.color());
427 /// Reduce font to fall back to template where possible
428 void LyXFont::reduce(LyXFont const & tmplt)
430 if (family() == tmplt.family())
431 setFamily(INHERIT_FAMILY);
432 if (series() == tmplt.series())
433 setSeries(INHERIT_SERIES);
434 if (shape() == tmplt.shape())
435 setShape(INHERIT_SHAPE);
436 if (size() == tmplt.size())
437 setSize(INHERIT_SIZE);
438 if (emph() == tmplt.emph())
440 if (underbar() == tmplt.underbar())
441 setUnderbar(INHERIT);
442 if (noun() == tmplt.noun())
444 if (color() == tmplt.color())
445 setColor(LColor::inherit);
449 /// Realize font from a template
450 LyXFont & LyXFont::realize(LyXFont const & tmplt)
452 if (bits == inherit) {
457 if (bits.family == INHERIT_FAMILY)
458 bits.family = tmplt.bits.family;
460 if (bits.series == INHERIT_SERIES)
461 bits.series = tmplt.bits.series;
463 if (bits.shape == INHERIT_SHAPE)
464 bits.shape = tmplt.bits.shape;
466 if (bits.size == INHERIT_SIZE)
467 bits.size = tmplt.bits.size;
469 if (bits.emph == INHERIT)
470 bits.emph = tmplt.bits.emph;
472 if (bits.underbar == INHERIT)
473 bits.underbar = tmplt.bits.underbar;
475 if (bits.noun == INHERIT)
476 bits.noun = tmplt.bits.noun;
478 if (bits.color == LColor::inherit)
479 bits.color = tmplt.bits.color;
485 /// Is font resolved?
486 bool LyXFont::resolved() const
488 return (family() != INHERIT_FAMILY && series() != INHERIT_SERIES &&
489 shape() != INHERIT_SHAPE && size() != INHERIT_SIZE &&
490 emph() != INHERIT && underbar() != INHERIT &&
492 color() != LColor::inherit);
496 docstring const LyXFont::stateText(BufferParams * params) const
499 if (family() != INHERIT_FAMILY)
500 os << _(GUIFamilyNames[family()]) << ", ";
501 if (series() != INHERIT_SERIES)
502 os << _(GUISeriesNames[series()]) << ", ";
503 if (shape() != INHERIT_SHAPE)
504 os << _(GUIShapeNames[shape()]) << ", ";
505 if (size() != INHERIT_SIZE)
506 os << _(GUISizeNames[size()]) << ", ";
507 if (color() != LColor::inherit)
508 os << lcolor.getGUIName(color()) << ", ";
509 if (emph() != INHERIT)
510 os << bformat(_("Emphasis %1$s, "),
511 _(GUIMiscNames[emph()]));
512 if (underbar() != INHERIT)
513 os << bformat(_("Underline %1$s, "),
514 _(GUIMiscNames[underbar()]));
515 if (noun() != INHERIT)
516 os << bformat(_("Noun %1$s, "),
517 _(GUIMiscNames[noun()]));
519 os << _("Default") << ", ";
520 if (!params || (language() != params->language))
521 os << bformat(_("Language: %1$s, "),
522 _(language()->display()));
524 os << bformat(_(" Number %1$s"),
525 _(GUIMiscNames[number()]));
526 return rtrim(os.str(), ", ");
530 // Set family according to lyx format string
531 LyXFont & LyXFont::setLyXFamily(string const & fam)
533 string const s = ascii_lowercase(fam);
536 while (LyXFamilyNames[i] != s &&
537 LyXFamilyNames[i] != string("error"))
539 if (s == LyXFamilyNames[i])
540 setFamily(LyXFont::FONT_FAMILY(i));
542 lyxerr << "LyXFont::setLyXFamily: Unknown family `"
543 << s << '\'' << endl;
548 // Set series according to lyx format string
549 LyXFont & LyXFont::setLyXSeries(string const & ser)
551 string const s = ascii_lowercase(ser);
554 while (LyXSeriesNames[i] != s &&
555 LyXSeriesNames[i] != string("error")) ++i;
556 if (s == LyXSeriesNames[i]) {
557 setSeries(LyXFont::FONT_SERIES(i));
559 lyxerr << "LyXFont::setLyXSeries: Unknown series `"
560 << s << '\'' << endl;
565 // Set shape according to lyx format string
566 LyXFont & LyXFont::setLyXShape(string const & sha)
568 string const s = ascii_lowercase(sha);
571 while (LyXShapeNames[i] != s && LyXShapeNames[i] != string("error"))
573 if (s == LyXShapeNames[i])
574 setShape(LyXFont::FONT_SHAPE(i));
576 lyxerr << "LyXFont::setLyXShape: Unknown shape `"
577 << s << '\'' << endl;
582 // Set size according to lyx format string
583 LyXFont & LyXFont::setLyXSize(string const & siz)
585 string const s = ascii_lowercase(siz);
587 while (LyXSizeNames[i] != s && LyXSizeNames[i] != string("error"))
589 if (s == LyXSizeNames[i]) {
590 setSize(LyXFont::FONT_SIZE(i));
592 lyxerr << "LyXFont::setLyXSize: Unknown size `"
593 << s << '\'' << endl;
598 // Set size according to lyx format string
599 LyXFont::FONT_MISC_STATE LyXFont::setLyXMisc(string const & siz)
601 string const s = ascii_lowercase(siz);
603 while (LyXMiscNames[i] != s &&
604 LyXMiscNames[i] != string("error")) ++i;
605 if (s == LyXMiscNames[i])
606 return FONT_MISC_STATE(i);
607 lyxerr << "LyXFont::setLyXMisc: Unknown misc flag `"
608 << s << '\'' << endl;
613 /// Sets color after LyX text format
614 LyXFont & LyXFont::setLyXColor(string const & col)
616 setColor(lcolor.getFromLyXName(col));
621 // Returns size in latex format
622 string const LyXFont::latexSize() const
624 return LaTeXSizeNames[size()];
628 // Read a font definition from given file in lyx format
630 LyXFont & LyXFont::lyxRead(LyXLex & lex)
633 bool finished = false;
634 while (!finished && lex.isOK() && !error) {
636 string const tok = ascii_lowercase(lex.getString());
640 } else if (tok == "endfont") {
642 } else if (tok == "family") {
644 string const ttok = lex.getString();
646 } else if (tok == "series") {
648 string const ttok = lex.getString();
650 } else if (tok == "shape") {
652 string const ttok = lex.getString();
654 } else if (tok == "size") {
656 string const ttok = lex.getString();
658 } else if (tok == "misc") {
660 string const ttok = ascii_lowercase(lex.getString());
662 if (ttok == "no_bar") {
664 } else if (ttok == "no_emph") {
666 } else if (ttok == "no_noun") {
668 } else if (ttok == "emph") {
670 } else if (ttok == "underbar") {
672 } else if (ttok == "noun") {
675 lex.printError("Illegal misc type `$$Token´");
677 } else if (tok == "color") {
679 string const ttok = lex.getString();
682 lex.printError("Unknown tag `$$Token'");
690 /// Writes the changes from this font to orgfont in .lyx format in file
691 void LyXFont::lyxWriteChanges(LyXFont const & orgfont,
695 if (orgfont.family() != family())
696 os << "\\family " << LyXFamilyNames[family()] << "\n";
697 if (orgfont.series() != series())
698 os << "\\series " << LyXSeriesNames[series()] << "\n";
699 if (orgfont.shape() != shape())
700 os << "\\shape " << LyXShapeNames[shape()] << "\n";
701 if (orgfont.size() != size())
702 os << "\\size " << LyXSizeNames[size()] << "\n";
703 if (orgfont.emph() != emph())
704 os << "\\emph " << LyXMiscNames[emph()] << "\n";
705 if (orgfont.number() != number())
706 os << "\\numeric " << LyXMiscNames[number()] << "\n";
707 if (orgfont.underbar() != underbar()) {
708 // This is only for backwards compatibility
709 switch (underbar()) {
710 case OFF: os << "\\bar no\n"; break;
711 case ON: os << "\\bar under\n"; break;
712 case TOGGLE: lyxerr << "LyXFont::lyxWriteFontChanges: "
713 "TOGGLE should not appear here!"
716 case INHERIT: os << "\\bar default\n"; break;
717 case IGNORE: lyxerr << "LyXFont::lyxWriteFontChanges: "
718 "IGNORE should not appear here!"
723 if (orgfont.noun() != noun()) {
724 os << "\\noun " << LyXMiscNames[noun()] << "\n";
726 if (orgfont.color() != color())
727 os << "\\color " << lcolor.getLyXName(color()) << '\n';
728 if (orgfont.language() != language() &&
729 language() != latex_language) {
731 os << "\\lang " << language()->lang() << "\n";
733 os << "\\lang unknown\n";
738 /// Writes the head of the LaTeX needed to impose this font
739 // Returns number of chars written.
740 int LyXFont::latexWriteStartChanges(odocstream & os, LyXFont const & base,
741 LyXFont const & prev,
742 BufferParams const & bparams) const
746 int count = switchEncoding(os, bparams, *(prev.language()->encoding()),
747 *(language()->encoding()));
748 if (language()->babel() != base.language()->babel() &&
749 language() != prev.language()) {
750 if (isRightToLeft() != prev.isRightToLeft()) {
751 if (isRightToLeft()) {
760 subst(lyxrc.language_command_local,
761 "$$lang", language()->babel());
762 os << from_ascii(tmp);
763 count += tmp.length();
767 if (number() == ON && prev.number() != ON &&
768 language()->lang() == "hebrew") {
776 if (f.family() != INHERIT_FAMILY) {
778 << LaTeXFamilyNames[f.family()]
780 count += strlen(LaTeXFamilyNames[f.family()]) + 2;
781 env = true; //We have opened a new environment
783 if (f.series() != INHERIT_SERIES) {
785 << LaTeXSeriesNames[f.series()]
787 count += strlen(LaTeXSeriesNames[f.series()]) + 2;
788 env = true; //We have opened a new environment
790 if (f.shape() != INHERIT_SHAPE) {
792 << LaTeXShapeNames[f.shape()]
794 count += strlen(LaTeXShapeNames[f.shape()]) + 2;
795 env = true; //We have opened a new environment
797 if (f.color() != LColor::inherit && f.color() != LColor::ignore) {
799 << from_ascii(lcolor.getLaTeXName(f.color()))
801 count += lcolor.getLaTeXName(f.color()).length() + 13;
802 env = true; //We have opened a new environment
804 if (f.emph() == ON) {
807 env = true; //We have opened a new environment
809 if (f.underbar() == ON) {
812 env = true; //We have opened a new environment
814 // \noun{} is a LyX special macro
815 if (f.noun() == ON) {
818 env = true; //We have opened a new environment
820 if (f.size() != INHERIT_SIZE) {
821 // If we didn't open an environment above, we open one here
827 << LaTeXSizeNames[f.size()]
829 count += strlen(LaTeXSizeNames[f.size()]) + 2;
835 /// Writes ending block of LaTeX needed to close use of this font
836 // Returns number of chars written
837 // This one corresponds to latexWriteStartChanges(). (Asger)
838 int LyXFont::latexWriteEndChanges(odocstream & os, LyXFont const & base,
839 LyXFont const & next,
840 BufferParams const & bparams) const
845 // reduce the current font to changes against the base
846 // font (of the layout). We use a temporary for this to
847 // avoid changing this font instance, as that would break
851 if (f.family() != INHERIT_FAMILY) {
854 env = true; // Size change need not bother about closing env.
856 if (f.series() != INHERIT_SERIES) {
859 env = true; // Size change need not bother about closing env.
861 if (f.shape() != INHERIT_SHAPE) {
864 env = true; // Size change need not bother about closing env.
866 if (f.color() != LColor::inherit && f.color() != LColor::ignore) {
869 env = true; // Size change need not bother about closing env.
871 if (f.emph() == ON) {
874 env = true; // Size change need not bother about closing env.
876 if (f.underbar() == ON) {
879 env = true; // Size change need not bother about closing env.
881 if (f.noun() == ON) {
884 env = true; // Size change need not bother about closing env.
886 if (f.size() != INHERIT_SIZE) {
887 // We only have to close if only size changed
894 if (number() == ON && next.number() != ON &&
895 language()->lang() == "hebrew") {
900 if (language() != base.language() && language() != next.language()) {
904 count += switchEncoding(os, bparams, *(language()->encoding()),
905 *(next.language()->encoding()));
911 LColor_color LyXFont::realColor() const
913 if (color() == LColor::none)
914 return LColor::foreground;
919 ostream & operator<<(ostream & os, LyXFont::FONT_MISC_STATE fms)
921 return os << int(fms);
925 std::ostream & operator<<(std::ostream & os, LyXFont const & font)
928 << " family " << font.bits.family
929 << " series " << font.bits.series
930 << " shape " << font.bits.shape
931 << " size " << font.bits.size
932 << " color " << font.bits.color
933 << " emph " << font.bits.emph
934 << " underbar " << font.bits.underbar
935 << " noun " << font.bits.noun
936 << " number " << font.bits.number
937 << " lang: " << (font.lang ? font.lang->lang() : 0);