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
27 #include "support/lstrings.h"
31 using lyx::support::ascii_lowercase;
32 using lyx::support::bformat;
33 using lyx::support::rtrim;
34 using lyx::support::subst;
39 using std::ostringstream;
41 #ifndef CXX_GLOBAL_CSTD
51 char const * GUIFamilyNames[LyXFont::NUM_FAMILIES + 2 /* default & error */] =
52 { N_("Roman"), N_("Sans Serif"), N_("Typewriter"), N_("Symbol"),
53 "cmr", "cmsy", "cmm", "cmex", "msa", "msb", "eufrak", "wasy",
54 N_("Inherit"), N_("Ignore") };
56 char const * GUISeriesNames[4] =
57 { N_("Medium"), N_("Bold"), N_("Inherit"), N_("Ignore") };
59 char const * GUIShapeNames[6] =
60 { N_("Upright"), N_("Italic"), N_("Slanted"), N_("Smallcaps"), N_("Inherit"),
63 char const * GUISizeNames[14] =
64 { N_("Tiny"), N_("Smallest"), N_("Smaller"), N_("Small"), N_("Normal"), N_("Large"),
65 N_("Larger"), N_("Largest"), N_("Huge"), N_("Huger"), N_("Increase"), N_("Decrease"),
66 N_("Inherit"), N_("Ignore") };
68 char const * GUIMiscNames[5] =
69 { N_("Off"), N_("On"), N_("Toggle"), N_("Inherit"), N_("Ignore") };
73 // Strings used to read and write .lyx format files
75 char const * LyXFamilyNames[LyXFont::NUM_FAMILIES + 2 /* default & error */] =
76 { "roman", "sans", "typewriter", "symbol",
77 "cmr", "cmsy", "cmm", "cmex", "msa", "msb", "eufrak", "wasy",
80 char const * LyXSeriesNames[4] =
81 { "medium", "bold", "default", "error" };
83 char const * LyXShapeNames[6] =
84 { "up", "italic", "slanted", "smallcaps", "default", "error" };
86 char const * LyXSizeNames[14] =
87 { "tiny", "scriptsize", "footnotesize", "small", "normal", "large",
88 "larger", "largest", "huge", "giant",
89 "increase", "decrease", "default", "error" };
91 char const * LyXMiscNames[5] =
92 { "off", "on", "toggle", "default", "error" };
95 // Strings used to write LaTeX files
97 char const * LaTeXFamilyNames[6] =
98 { "textrm", "textsf", "texttt", "error1", "error2", "error3" };
100 char const * LaTeXSeriesNames[4] =
101 { "textmd", "textbf", "error4", "error5" };
103 char const * LaTeXShapeNames[6] =
104 { "textup", "textit", "textsl", "textsc", "error6", "error7" };
106 char const * LaTeXSizeNames[14] =
107 { "tiny", "scriptsize", "footnotesize", "small", "normalsize", "large",
108 "Large", "LARGE", "huge", "Huge", "error8", "error9", "error10", "error11" };
113 // Initialize static member
114 LyXFont::FontBits LyXFont::sane = {
125 // Initialize static member
126 LyXFont::FontBits LyXFont::inherit = {
137 // Initialize static member
138 LyXFont::FontBits LyXFont::ignore = {
150 bool operator==(LyXFont::FontBits const & lhs,
151 LyXFont::FontBits const & rhs)
153 return lhs.family == rhs.family &&
154 lhs.series == rhs.series &&
155 lhs.shape == rhs.shape &&
156 lhs.size == rhs.size &&
157 lhs.color == rhs.color &&
158 lhs.emph == rhs.emph &&
159 lhs.underbar == rhs.underbar &&
160 lhs.noun == rhs.noun &&
161 lhs.number == rhs.number;
166 : bits(sane), lang(default_language)
170 LyXFont::LyXFont(LyXFont::FONT_INIT1)
171 : bits(inherit), lang(default_language)
175 LyXFont::LyXFont(LyXFont::FONT_INIT2)
176 : bits(ignore), lang(ignore_language)
180 LyXFont::LyXFont(LyXFont::FONT_INIT3)
181 : bits(sane), lang(default_language)
185 LyXFont::LyXFont(LyXFont::FONT_INIT1, Language const * l)
186 : bits(inherit), lang(l)
190 LyXFont::LyXFont(LyXFont::FONT_INIT2, Language const * l)
191 : bits(ignore), lang(l)
195 LyXFont::LyXFont(LyXFont::FONT_INIT3, Language const * l)
196 : bits(sane), lang(l)
201 LColor_color LyXFont::color() const
203 return LColor::color(bits.color);
207 Language const * LyXFont::language() const
213 bool LyXFont::isRightToLeft() const
215 return lang->RightToLeft();
219 bool LyXFont::isVisibleRightToLeft() const
221 return (lang->RightToLeft() &&
226 void LyXFont::setFamily(LyXFont::FONT_FAMILY f)
232 void LyXFont::setSeries(LyXFont::FONT_SERIES s)
238 void LyXFont::setShape(LyXFont::FONT_SHAPE s)
244 void LyXFont::setSize(LyXFont::FONT_SIZE s)
250 void LyXFont::setEmph(LyXFont::FONT_MISC_STATE e)
256 void LyXFont::setUnderbar(LyXFont::FONT_MISC_STATE u)
262 void LyXFont::setNoun(LyXFont::FONT_MISC_STATE n)
268 void LyXFont::setColor(LColor_color c)
274 void LyXFont::setLanguage(Language const * l)
280 void LyXFont::setNumber(LyXFont::FONT_MISC_STATE n)
286 /// Decreases font size by one
287 LyXFont & LyXFont::decSize()
290 case SIZE_HUGER: setSize(SIZE_HUGE); break;
291 case SIZE_HUGE: setSize(SIZE_LARGEST); break;
292 case SIZE_LARGEST: setSize(SIZE_LARGER); break;
293 case SIZE_LARGER: setSize(SIZE_LARGE); break;
294 case SIZE_LARGE: setSize(SIZE_NORMAL); break;
295 case SIZE_NORMAL: setSize(SIZE_SMALL); break;
296 case SIZE_SMALL: setSize(SIZE_FOOTNOTE); break;
297 case SIZE_FOOTNOTE: setSize(SIZE_SCRIPT); break;
298 case SIZE_SCRIPT: setSize(SIZE_TINY); break;
299 case SIZE_TINY: break;
301 lyxerr << "Can't LyXFont::decSize on INCREASE_SIZE" << endl;
304 lyxerr <<"Can't LyXFont::decSize on DECREASE_SIZE" << endl;
307 lyxerr <<"Can't LyXFont::decSize on INHERIT_SIZE" << endl;
310 lyxerr <<"Can't LyXFont::decSize on IGNORE_SIZE" << endl;
317 /// Increases font size by one
318 LyXFont & LyXFont::incSize()
321 case SIZE_HUGER: break;
322 case SIZE_HUGE: setSize(SIZE_HUGER); break;
323 case SIZE_LARGEST: setSize(SIZE_HUGE); break;
324 case SIZE_LARGER: setSize(SIZE_LARGEST); break;
325 case SIZE_LARGE: setSize(SIZE_LARGER); break;
326 case SIZE_NORMAL: setSize(SIZE_LARGE); break;
327 case SIZE_SMALL: setSize(SIZE_NORMAL); break;
328 case SIZE_FOOTNOTE: setSize(SIZE_SMALL); break;
329 case SIZE_SCRIPT: setSize(SIZE_FOOTNOTE); break;
330 case SIZE_TINY: setSize(SIZE_SCRIPT); break;
332 lyxerr <<"Can't LyXFont::incSize on INCREASE_SIZE" << endl;
335 lyxerr <<"Can't LyXFont::incSize on DECREASE_SIZE" << endl;
338 lyxerr <<"Can't LyXFont::incSize on INHERIT_SIZE" << endl;
341 lyxerr <<"Can't LyXFont::incSize on IGNORE_SIZE" << endl;
348 /// Updates a misc setting according to request
349 LyXFont::FONT_MISC_STATE LyXFont::setMisc(FONT_MISC_STATE newfont,
352 if (newfont == TOGGLE) {
358 lyxerr <<"LyXFont::setMisc: Need state"
359 " ON or OFF to toggle. Setting to ON" << endl;
362 } else if (newfont == IGNORE)
369 /// Updates font settings according to request
370 void LyXFont::update(LyXFont const & newfont,
371 Language const * document_language,
374 if (newfont.family() == family() && toggleall)
375 setFamily(INHERIT_FAMILY); // toggle 'back'
376 else if (newfont.family() != IGNORE_FAMILY)
377 setFamily(newfont.family());
378 // else it's IGNORE_SHAPE
380 // "Old" behaviour: "Setting" bold will toggle bold on/off.
381 switch (newfont.series()) {
384 if (series() == BOLD_SERIES && toggleall)
385 setSeries(MEDIUM_SERIES);
387 setSeries(BOLD_SERIES);
391 setSeries(newfont.series());
397 if (newfont.shape() == shape() && toggleall)
398 setShape(INHERIT_SHAPE); // toggle 'back'
399 else if (newfont.shape() != IGNORE_SHAPE)
400 setShape(newfont.shape());
401 // else it's IGNORE_SHAPE
403 if (newfont.size() != IGNORE_SIZE) {
404 if (newfont.size() == INCREASE_SIZE)
406 else if (newfont.size() == DECREASE_SIZE)
409 setSize(newfont.size());
412 setEmph(setMisc(newfont.emph(), emph()));
413 setUnderbar(setMisc(newfont.underbar(), underbar()));
414 setNoun(setMisc(newfont.noun(), noun()));
416 setNumber(setMisc(newfont.number(), number()));
417 if (newfont.language() == language() && toggleall)
418 if (language() == document_language)
419 setLanguage(default_language);
421 setLanguage(document_language);
422 else if (newfont.language() != ignore_language)
423 setLanguage(newfont.language());
425 if (newfont.color() == color() && toggleall)
426 setColor(LColor::inherit); // toggle 'back'
427 else if (newfont.color() != LColor::ignore)
428 setColor(newfont.color());
432 /// Reduce font to fall back to template where possible
433 void LyXFont::reduce(LyXFont const & tmplt)
435 if (family() == tmplt.family())
436 setFamily(INHERIT_FAMILY);
437 if (series() == tmplt.series())
438 setSeries(INHERIT_SERIES);
439 if (shape() == tmplt.shape())
440 setShape(INHERIT_SHAPE);
441 if (size() == tmplt.size())
442 setSize(INHERIT_SIZE);
443 if (emph() == tmplt.emph())
445 if (underbar() == tmplt.underbar())
446 setUnderbar(INHERIT);
447 if (noun() == tmplt.noun())
449 if (color() == tmplt.color())
450 setColor(LColor::inherit);
454 /// Realize font from a template
455 LyXFont & LyXFont::realize(LyXFont const & tmplt)
457 if (bits == inherit) {
462 if (bits.family == INHERIT_FAMILY)
463 bits.family = tmplt.bits.family;
465 if (bits.series == INHERIT_SERIES)
466 bits.series = tmplt.bits.series;
468 if (bits.shape == INHERIT_SHAPE)
469 bits.shape = tmplt.bits.shape;
471 if (bits.size == INHERIT_SIZE)
472 bits.size = tmplt.bits.size;
474 if (bits.emph == INHERIT)
475 bits.emph = tmplt.bits.emph;
477 if (bits.underbar == INHERIT)
478 bits.underbar = tmplt.bits.underbar;
480 if (bits.noun == INHERIT)
481 bits.noun = tmplt.bits.noun;
483 if (bits.color == LColor::inherit)
484 bits.color = tmplt.bits.color;
490 /// Is font resolved?
491 bool LyXFont::resolved() const
493 return (family() != INHERIT_FAMILY && series() != INHERIT_SERIES &&
494 shape() != INHERIT_SHAPE && size() != INHERIT_SIZE &&
495 emph() != INHERIT && underbar() != INHERIT &&
497 color() != LColor::inherit);
501 /// Build GUI description of font state
502 string const LyXFont::stateText(BufferParams * params) const
505 if (family() != INHERIT_FAMILY)
506 os << _(GUIFamilyNames[family()]) << ", ";
507 if (series() != INHERIT_SERIES)
508 os << _(GUISeriesNames[series()]) << ", ";
509 if (shape() != INHERIT_SHAPE)
510 os << _(GUIShapeNames[shape()]) << ", ";
511 if (size() != INHERIT_SIZE)
512 os << _(GUISizeNames[size()]) << ", ";
513 if (color() != LColor::inherit)
514 os << lcolor.getGUIName(color()) << ", ";
515 if (emph() != INHERIT)
516 os << bformat(_("Emphasis %1$s, "), _(GUIMiscNames[emph()]));
517 if (underbar() != INHERIT)
518 os << bformat(_("Underline %1$s, "), _(GUIMiscNames[underbar()]));
519 if (noun() != INHERIT)
520 os << bformat(_("Noun %1$s, "), _(GUIMiscNames[noun()]));
522 os << _("Default") << ", ";
523 if (!params || (language() != params->language))
524 os << bformat(_("Language: %1$s, "), _(language()->display()));
526 os << bformat(_(" Number %1$s"), _(GUIMiscNames[number()]));
527 return rtrim(os.str(), ", ");
531 // Set family according to lyx format string
532 LyXFont & LyXFont::setLyXFamily(string const & fam)
534 string const s = ascii_lowercase(fam);
537 while (LyXFamilyNames[i] != s &&
538 LyXFamilyNames[i] != string("error"))
540 if (s == LyXFamilyNames[i])
541 setFamily(LyXFont::FONT_FAMILY(i));
543 lyxerr << "LyXFont::setLyXFamily: Unknown family `"
544 << s << '\'' << endl;
549 // Set series according to lyx format string
550 LyXFont & LyXFont::setLyXSeries(string const & ser)
552 string const s = ascii_lowercase(ser);
555 while (LyXSeriesNames[i] != s &&
556 LyXSeriesNames[i] != string("error")) ++i;
557 if (s == LyXSeriesNames[i]) {
558 setSeries(LyXFont::FONT_SERIES(i));
560 lyxerr << "LyXFont::setLyXSeries: Unknown series `"
561 << s << '\'' << endl;
566 // Set shape according to lyx format string
567 LyXFont & LyXFont::setLyXShape(string const & sha)
569 string const s = ascii_lowercase(sha);
572 while (LyXShapeNames[i] != s && LyXShapeNames[i] != string("error"))
574 if (s == LyXShapeNames[i])
575 setShape(LyXFont::FONT_SHAPE(i));
577 lyxerr << "LyXFont::setLyXShape: Unknown shape `"
578 << s << '\'' << endl;
583 // Set size according to lyx format string
584 LyXFont & LyXFont::setLyXSize(string const & siz)
586 string const s = ascii_lowercase(siz);
588 while (LyXSizeNames[i] != s && LyXSizeNames[i] != string("error"))
590 if (s == LyXSizeNames[i]) {
591 setSize(LyXFont::FONT_SIZE(i));
593 lyxerr << "LyXFont::setLyXSize: Unknown size `"
594 << s << '\'' << endl;
599 // Set size according to lyx format string
600 LyXFont::FONT_MISC_STATE LyXFont::setLyXMisc(string const & siz)
602 string const s = ascii_lowercase(siz);
604 while (LyXMiscNames[i] != s &&
605 LyXMiscNames[i] != string("error")) ++i;
606 if (s == LyXMiscNames[i])
607 return FONT_MISC_STATE(i);
608 lyxerr << "LyXFont::setLyXMisc: Unknown misc flag `"
609 << s << '\'' << endl;
614 /// Sets color after LyX text format
615 LyXFont & LyXFont::setLyXColor(string const & col)
617 setColor(lcolor.getFromLyXName(col));
622 // Returns size in latex format
623 string const LyXFont::latexSize() const
625 return LaTeXSizeNames[size()];
629 // Read a font definition from given file in lyx format
631 LyXFont & LyXFont::lyxRead(LyXLex & lex)
634 bool finished = false;
635 while (!finished && lex.isOK() && !error) {
637 string const tok = ascii_lowercase(lex.getString());
641 } else if (tok == "endfont") {
643 } else if (tok == "family") {
645 string const ttok = lex.getString();
647 } else if (tok == "series") {
649 string const ttok = lex.getString();
651 } else if (tok == "shape") {
653 string const ttok = lex.getString();
655 } else if (tok == "size") {
657 string const ttok = lex.getString();
659 } else if (tok == "misc") {
661 string const ttok = ascii_lowercase(lex.getString());
663 if (ttok == "no_bar") {
665 } else if (ttok == "no_emph") {
667 } else if (ttok == "no_noun") {
669 } else if (ttok == "emph") {
671 } else if (ttok == "underbar") {
673 } else if (ttok == "noun") {
676 lex.printError("Illegal misc type `$$Token´");
678 } else if (tok == "color") {
680 string const ttok = lex.getString();
683 lex.printError("Unknown tag `$$Token'");
691 /// Writes the changes from this font to orgfont in .lyx format in file
692 void LyXFont::lyxWriteChanges(LyXFont const & orgfont,
696 if (orgfont.family() != family())
697 os << "\\family " << LyXFamilyNames[family()] << "\n";
698 if (orgfont.series() != series())
699 os << "\\series " << LyXSeriesNames[series()] << "\n";
700 if (orgfont.shape() != shape())
701 os << "\\shape " << LyXShapeNames[shape()] << "\n";
702 if (orgfont.size() != size())
703 os << "\\size " << LyXSizeNames[size()] << "\n";
704 if (orgfont.emph() != emph())
705 os << "\\emph " << LyXMiscNames[emph()] << "\n";
706 if (orgfont.number() != number())
707 os << "\\numeric " << LyXMiscNames[number()] << "\n";
708 if (orgfont.underbar() != underbar()) {
709 // This is only for backwards compatibility
710 switch (underbar()) {
711 case OFF: os << "\\bar no\n"; break;
712 case ON: os << "\\bar under\n"; break;
713 case TOGGLE: lyxerr << "LyXFont::lyxWriteFontChanges: "
714 "TOGGLE should not appear here!"
717 case INHERIT: os << "\\bar default\n"; break;
718 case IGNORE: lyxerr << "LyXFont::lyxWriteFontChanges: "
719 "IGNORE should not appear here!"
724 if (orgfont.noun() != noun()) {
725 os << "\\noun " << LyXMiscNames[noun()] << "\n";
727 if (orgfont.color() != color()) {
728 // To make us file compatible with older
729 // lyx versions we emit "default" instead
731 string col_str(lcolor.getLyXName(color()));
732 if (col_str == "inherit") col_str = "default";
733 os << "\\color " << col_str << "\n";
735 if (orgfont.language() != language()) {
737 os << "\\lang " << language()->lang() << "\n";
739 os << "\\lang unknown\n";
744 /// Writes the head of the LaTeX needed to impose this font
745 // Returns number of chars written.
746 int LyXFont::latexWriteStartChanges(ostream & os, LyXFont const & base,
747 LyXFont const & prev) const
752 if (language()->babel() != base.language()->babel() &&
753 language() != prev.language()) {
754 if (isRightToLeft() != prev.isRightToLeft()) {
755 if (isRightToLeft()) {
764 subst(lyxrc.language_command_local,
765 "$$lang", language()->babel());
767 count += tmp.length();
771 if (number() == ON && prev.number() != ON &&
772 language()->lang() == "hebrew") {
780 if (f.family() != INHERIT_FAMILY) {
782 << LaTeXFamilyNames[f.family()]
784 count += strlen(LaTeXFamilyNames[f.family()]) + 2;
785 env = true; //We have opened a new environment
787 if (f.series() != INHERIT_SERIES) {
789 << LaTeXSeriesNames[f.series()]
791 count += strlen(LaTeXSeriesNames[f.series()]) + 2;
792 env = true; //We have opened a new environment
794 if (f.shape() != INHERIT_SHAPE) {
796 << LaTeXShapeNames[f.shape()]
798 count += strlen(LaTeXShapeNames[f.shape()]) + 2;
799 env = true; //We have opened a new environment
801 if (f.color() != LColor::inherit && f.color() != LColor::ignore) {
803 << lcolor.getLaTeXName(f.color())
805 count += lcolor.getLaTeXName(f.color()).length() + 13;
806 env = true; //We have opened a new environment
808 if (f.emph() == ON) {
811 env = true; //We have opened a new environment
813 if (f.underbar() == ON) {
816 env = true; //We have opened a new environment
818 // \noun{} is a LyX special macro
819 if (f.noun() == ON) {
822 env = true; //We have opened a new environment
824 if (f.size() != INHERIT_SIZE) {
825 // If we didn't open an environment above, we open one here
831 << LaTeXSizeNames[f.size()]
833 count += strlen(LaTeXSizeNames[f.size()]) + 2;
839 /// Writes ending block of LaTeX needed to close use of this font
840 // Returns number of chars written
841 // This one corresponds to latexWriteStartChanges(). (Asger)
842 int LyXFont::latexWriteEndChanges(ostream & os, LyXFont const & base,
843 LyXFont const & next) const
848 // reduce the current font to changes against the base
849 // font (of the layout). We use a temporary for this to
850 // avoid changing this font instance, as that would break
854 if (f.family() != INHERIT_FAMILY) {
857 env = true; // Size change need not bother about closing env.
859 if (f.series() != INHERIT_SERIES) {
862 env = true; // Size change need not bother about closing env.
864 if (f.shape() != INHERIT_SHAPE) {
867 env = true; // Size change need not bother about closing env.
869 if (f.color() != LColor::inherit && f.color() != LColor::ignore) {
872 env = true; // Size change need not bother about closing env.
874 if (f.emph() == ON) {
877 env = true; // Size change need not bother about closing env.
879 if (f.underbar() == ON) {
882 env = true; // Size change need not bother about closing env.
884 if (f.noun() == ON) {
887 env = true; // Size change need not bother about closing env.
889 if (f.size() != INHERIT_SIZE) {
890 // We only have to close if only size changed
897 if (number() == ON && next.number() != ON &&
898 language()->lang() == "hebrew") {
903 if (language() != base.language() && language() != next.language()) {
912 LColor_color LyXFont::realColor() const
914 if (color() == LColor::none)
915 return LColor::foreground;
920 // Convert logical attributes to concrete shape attribute
921 LyXFont::FONT_SHAPE LyXFont::realShape() const
923 register FONT_SHAPE s = shape();
937 ostream & operator<<(ostream & os, LyXFont::FONT_MISC_STATE fms)
939 return os << int(fms);
943 std::ostream & operator<<(std::ostream & os, LyXFont const & font)
946 << " family " << font.bits.family
947 << " series " << font.bits.series
948 << " shape " << font.bits.shape
949 << " size " << font.bits.size
950 << " color " << font.bits.color
951 << " emph " << font.bits.emph
952 << " underbar " << font.bits.underbar
953 << " noun " << font.bits.noun
954 << " number " << font.bits.number
955 << " lang: " << (font.lang ? font.lang->lang() : 0);