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"
29 using lyx::odocstream;
30 using lyx::support::ascii_lowercase;
31 using lyx::support::bformat;
32 using lyx::support::rtrim;
33 using lyx::support::subst;
38 using std::ostringstream;
40 #ifndef CXX_GLOBAL_CSTD
50 char const * GUIFamilyNames[LyXFont::NUM_FAMILIES + 2 /* default & error */] =
51 { N_("Roman"), N_("Sans Serif"), N_("Typewriter"), N_("Symbol"),
52 "cmr", "cmsy", "cmm", "cmex", "msa", "msb", "eufrak", "wasy",
53 N_("Inherit"), N_("Ignore") };
55 char const * GUISeriesNames[4] =
56 { N_("Medium"), N_("Bold"), N_("Inherit"), N_("Ignore") };
58 char const * GUIShapeNames[6] =
59 { N_("Upright"), N_("Italic"), N_("Slanted"), N_("Smallcaps"), N_("Inherit"),
62 char const * GUISizeNames[14] =
63 { N_("Tiny"), N_("Smallest"), N_("Smaller"), N_("Small"), N_("Normal"), N_("Large"),
64 N_("Larger"), N_("Largest"), N_("Huge"), N_("Huger"), N_("Increase"), N_("Decrease"),
65 N_("Inherit"), N_("Ignore") };
67 char const * GUIMiscNames[5] =
68 { N_("Off"), N_("On"), N_("Toggle"), N_("Inherit"), N_("Ignore") };
72 // Strings used to read and write .lyx format files
74 char const * LyXFamilyNames[LyXFont::NUM_FAMILIES + 2 /* default & error */] =
75 { "roman", "sans", "typewriter", "symbol",
76 "cmr", "cmsy", "cmm", "cmex", "msa", "msb", "eufrak", "wasy",
79 char const * LyXSeriesNames[4] =
80 { "medium", "bold", "default", "error" };
82 char const * LyXShapeNames[6] =
83 { "up", "italic", "slanted", "smallcaps", "default", "error" };
85 char const * LyXSizeNames[14] =
86 { "tiny", "scriptsize", "footnotesize", "small", "normal", "large",
87 "larger", "largest", "huge", "giant",
88 "increase", "decrease", "default", "error" };
90 char const * LyXMiscNames[5] =
91 { "off", "on", "toggle", "default", "error" };
94 // Strings used to write LaTeX files
96 char const * LaTeXFamilyNames[6] =
97 { "textrm", "textsf", "texttt", "error1", "error2", "error3" };
99 char const * LaTeXSeriesNames[4] =
100 { "textmd", "textbf", "error4", "error5" };
102 char const * LaTeXShapeNames[6] =
103 { "textup", "textit", "textsl", "textsc", "error6", "error7" };
105 char const * LaTeXSizeNames[14] =
106 { "tiny", "scriptsize", "footnotesize", "small", "normalsize", "large",
107 "Large", "LARGE", "huge", "Huge", "error8", "error9", "error10", "error11" };
112 // Initialize static member
113 LyXFont::FontBits LyXFont::sane = {
124 // Initialize static member
125 LyXFont::FontBits LyXFont::inherit = {
136 // Initialize static member
137 LyXFont::FontBits LyXFont::ignore = {
149 bool operator==(LyXFont::FontBits const & lhs,
150 LyXFont::FontBits const & rhs)
152 return lhs.family == rhs.family &&
153 lhs.series == rhs.series &&
154 lhs.shape == rhs.shape &&
155 lhs.size == rhs.size &&
156 lhs.color == rhs.color &&
157 lhs.emph == rhs.emph &&
158 lhs.underbar == rhs.underbar &&
159 lhs.noun == rhs.noun &&
160 lhs.number == rhs.number;
165 : bits(sane), lang(default_language)
169 LyXFont::LyXFont(LyXFont::FONT_INIT1)
170 : bits(inherit), lang(default_language)
174 LyXFont::LyXFont(LyXFont::FONT_INIT2)
175 : bits(ignore), lang(ignore_language)
179 LyXFont::LyXFont(LyXFont::FONT_INIT3)
180 : bits(sane), lang(default_language)
184 LyXFont::LyXFont(LyXFont::FONT_INIT1, Language const * l)
185 : bits(inherit), lang(l)
189 LyXFont::LyXFont(LyXFont::FONT_INIT2, Language const * l)
190 : bits(ignore), lang(l)
194 LyXFont::LyXFont(LyXFont::FONT_INIT3, Language const * l)
195 : bits(sane), lang(l)
200 LColor_color LyXFont::color() const
202 return LColor::color(bits.color);
206 bool LyXFont::isRightToLeft() const
208 return lang->rightToLeft();
212 bool LyXFont::isVisibleRightToLeft() const
214 return (lang->rightToLeft() &&
219 void LyXFont::setFamily(LyXFont::FONT_FAMILY f)
225 void LyXFont::setSeries(LyXFont::FONT_SERIES s)
231 void LyXFont::setShape(LyXFont::FONT_SHAPE s)
237 void LyXFont::setSize(LyXFont::FONT_SIZE s)
243 void LyXFont::setEmph(LyXFont::FONT_MISC_STATE e)
249 void LyXFont::setUnderbar(LyXFont::FONT_MISC_STATE u)
255 void LyXFont::setNoun(LyXFont::FONT_MISC_STATE n)
261 void LyXFont::setColor(LColor_color c)
267 void LyXFont::setLanguage(Language const * l)
273 void LyXFont::setNumber(LyXFont::FONT_MISC_STATE n)
279 /// Decreases font size by one
280 LyXFont & LyXFont::decSize()
283 case SIZE_HUGER: setSize(SIZE_HUGE); break;
284 case SIZE_HUGE: setSize(SIZE_LARGEST); break;
285 case SIZE_LARGEST: setSize(SIZE_LARGER); break;
286 case SIZE_LARGER: setSize(SIZE_LARGE); break;
287 case SIZE_LARGE: setSize(SIZE_NORMAL); break;
288 case SIZE_NORMAL: setSize(SIZE_SMALL); break;
289 case SIZE_SMALL: setSize(SIZE_FOOTNOTE); break;
290 case SIZE_FOOTNOTE: setSize(SIZE_SCRIPT); break;
291 case SIZE_SCRIPT: setSize(SIZE_TINY); break;
292 case SIZE_TINY: break;
294 lyxerr << "Can't LyXFont::decSize on INCREASE_SIZE" << endl;
297 lyxerr <<"Can't LyXFont::decSize on DECREASE_SIZE" << endl;
300 lyxerr <<"Can't LyXFont::decSize on INHERIT_SIZE" << endl;
303 lyxerr <<"Can't LyXFont::decSize on IGNORE_SIZE" << endl;
310 /// Increases font size by one
311 LyXFont & LyXFont::incSize()
314 case SIZE_HUGER: break;
315 case SIZE_HUGE: setSize(SIZE_HUGER); break;
316 case SIZE_LARGEST: setSize(SIZE_HUGE); break;
317 case SIZE_LARGER: setSize(SIZE_LARGEST); break;
318 case SIZE_LARGE: setSize(SIZE_LARGER); break;
319 case SIZE_NORMAL: setSize(SIZE_LARGE); break;
320 case SIZE_SMALL: setSize(SIZE_NORMAL); break;
321 case SIZE_FOOTNOTE: setSize(SIZE_SMALL); break;
322 case SIZE_SCRIPT: setSize(SIZE_FOOTNOTE); break;
323 case SIZE_TINY: setSize(SIZE_SCRIPT); break;
325 lyxerr <<"Can't LyXFont::incSize on INCREASE_SIZE" << endl;
328 lyxerr <<"Can't LyXFont::incSize on DECREASE_SIZE" << endl;
331 lyxerr <<"Can't LyXFont::incSize on INHERIT_SIZE" << endl;
334 lyxerr <<"Can't LyXFont::incSize on IGNORE_SIZE" << endl;
341 /// Updates a misc setting according to request
342 LyXFont::FONT_MISC_STATE LyXFont::setMisc(FONT_MISC_STATE newfont,
345 if (newfont == TOGGLE) {
351 lyxerr <<"LyXFont::setMisc: Need state"
352 " ON or OFF to toggle. Setting to ON" << endl;
355 } else if (newfont == IGNORE)
362 /// Updates font settings according to request
363 void LyXFont::update(LyXFont const & newfont,
364 Language const * document_language,
367 if (newfont.family() == family() && toggleall)
368 setFamily(INHERIT_FAMILY); // toggle 'back'
369 else if (newfont.family() != IGNORE_FAMILY)
370 setFamily(newfont.family());
371 // else it's IGNORE_SHAPE
373 // "Old" behaviour: "Setting" bold will toggle bold on/off.
374 switch (newfont.series()) {
377 if (series() == BOLD_SERIES && toggleall)
378 setSeries(MEDIUM_SERIES);
380 setSeries(BOLD_SERIES);
384 setSeries(newfont.series());
390 if (newfont.shape() == shape() && toggleall)
391 setShape(INHERIT_SHAPE); // toggle 'back'
392 else if (newfont.shape() != IGNORE_SHAPE)
393 setShape(newfont.shape());
394 // else it's IGNORE_SHAPE
396 if (newfont.size() != IGNORE_SIZE) {
397 if (newfont.size() == INCREASE_SIZE)
399 else if (newfont.size() == DECREASE_SIZE)
402 setSize(newfont.size());
405 setEmph(setMisc(newfont.emph(), emph()));
406 setUnderbar(setMisc(newfont.underbar(), underbar()));
407 setNoun(setMisc(newfont.noun(), noun()));
409 setNumber(setMisc(newfont.number(), number()));
410 if (newfont.language() == language() && toggleall)
411 if (language() == document_language)
412 setLanguage(default_language);
414 setLanguage(document_language);
415 else if (newfont.language() != ignore_language)
416 setLanguage(newfont.language());
418 if (newfont.color() == color() && toggleall)
419 setColor(LColor::inherit); // toggle 'back'
420 else if (newfont.color() != LColor::ignore)
421 setColor(newfont.color());
425 /// Reduce font to fall back to template where possible
426 void LyXFont::reduce(LyXFont const & tmplt)
428 if (family() == tmplt.family())
429 setFamily(INHERIT_FAMILY);
430 if (series() == tmplt.series())
431 setSeries(INHERIT_SERIES);
432 if (shape() == tmplt.shape())
433 setShape(INHERIT_SHAPE);
434 if (size() == tmplt.size())
435 setSize(INHERIT_SIZE);
436 if (emph() == tmplt.emph())
438 if (underbar() == tmplt.underbar())
439 setUnderbar(INHERIT);
440 if (noun() == tmplt.noun())
442 if (color() == tmplt.color())
443 setColor(LColor::inherit);
447 /// Realize font from a template
448 LyXFont & LyXFont::realize(LyXFont const & tmplt)
450 if (bits == inherit) {
455 if (bits.family == INHERIT_FAMILY)
456 bits.family = tmplt.bits.family;
458 if (bits.series == INHERIT_SERIES)
459 bits.series = tmplt.bits.series;
461 if (bits.shape == INHERIT_SHAPE)
462 bits.shape = tmplt.bits.shape;
464 if (bits.size == INHERIT_SIZE)
465 bits.size = tmplt.bits.size;
467 if (bits.emph == INHERIT)
468 bits.emph = tmplt.bits.emph;
470 if (bits.underbar == INHERIT)
471 bits.underbar = tmplt.bits.underbar;
473 if (bits.noun == INHERIT)
474 bits.noun = tmplt.bits.noun;
476 if (bits.color == LColor::inherit)
477 bits.color = tmplt.bits.color;
483 /// Is font resolved?
484 bool LyXFont::resolved() const
486 return (family() != INHERIT_FAMILY && series() != INHERIT_SERIES &&
487 shape() != INHERIT_SHAPE && size() != INHERIT_SIZE &&
488 emph() != INHERIT && underbar() != INHERIT &&
490 color() != LColor::inherit);
494 /// Build GUI description of font state
495 string const LyXFont::stateText(BufferParams * params) const
498 if (family() != INHERIT_FAMILY)
499 os << lyx::to_utf8(_(GUIFamilyNames[family()])) << ", ";
500 if (series() != INHERIT_SERIES)
501 os << lyx::to_utf8(_(GUISeriesNames[series()])) << ", ";
502 if (shape() != INHERIT_SHAPE)
503 os << lyx::to_utf8(_(GUIShapeNames[shape()])) << ", ";
504 if (size() != INHERIT_SIZE)
505 os << lyx::to_utf8(_(GUISizeNames[size()])) << ", ";
506 if (color() != LColor::inherit)
507 os << lcolor.getGUIName(color()) << ", ";
508 if (emph() != INHERIT)
509 os << lyx::to_utf8(bformat(_("Emphasis %1$s, "),
510 _(GUIMiscNames[emph()])));
511 if (underbar() != INHERIT)
512 os << lyx::to_utf8(bformat(_("Underline %1$s, "),
513 _(GUIMiscNames[underbar()])));
514 if (noun() != INHERIT)
515 os << lyx::to_utf8(bformat(_("Noun %1$s, "),
516 _(GUIMiscNames[noun()])));
518 os << lyx::to_utf8(_("Default")) << ", ";
519 if (!params || (language() != params->language))
520 os << lyx::to_utf8(bformat(_("Language: %1$s, "),
521 _(language()->display())));
523 os << lyx::to_utf8(bformat(_(" Number %1$s"),
524 _(GUIMiscNames[number()])));
525 return rtrim(os.str(), ", ");
529 // Set family according to lyx format string
530 LyXFont & LyXFont::setLyXFamily(string const & fam)
532 string const s = ascii_lowercase(fam);
535 while (LyXFamilyNames[i] != s &&
536 LyXFamilyNames[i] != string("error"))
538 if (s == LyXFamilyNames[i])
539 setFamily(LyXFont::FONT_FAMILY(i));
541 lyxerr << "LyXFont::setLyXFamily: Unknown family `"
542 << s << '\'' << endl;
547 // Set series according to lyx format string
548 LyXFont & LyXFont::setLyXSeries(string const & ser)
550 string const s = ascii_lowercase(ser);
553 while (LyXSeriesNames[i] != s &&
554 LyXSeriesNames[i] != string("error")) ++i;
555 if (s == LyXSeriesNames[i]) {
556 setSeries(LyXFont::FONT_SERIES(i));
558 lyxerr << "LyXFont::setLyXSeries: Unknown series `"
559 << s << '\'' << endl;
564 // Set shape according to lyx format string
565 LyXFont & LyXFont::setLyXShape(string const & sha)
567 string const s = ascii_lowercase(sha);
570 while (LyXShapeNames[i] != s && LyXShapeNames[i] != string("error"))
572 if (s == LyXShapeNames[i])
573 setShape(LyXFont::FONT_SHAPE(i));
575 lyxerr << "LyXFont::setLyXShape: Unknown shape `"
576 << s << '\'' << endl;
581 // Set size according to lyx format string
582 LyXFont & LyXFont::setLyXSize(string const & siz)
584 string const s = ascii_lowercase(siz);
586 while (LyXSizeNames[i] != s && LyXSizeNames[i] != string("error"))
588 if (s == LyXSizeNames[i]) {
589 setSize(LyXFont::FONT_SIZE(i));
591 lyxerr << "LyXFont::setLyXSize: Unknown size `"
592 << s << '\'' << endl;
597 // Set size according to lyx format string
598 LyXFont::FONT_MISC_STATE LyXFont::setLyXMisc(string const & siz)
600 string const s = ascii_lowercase(siz);
602 while (LyXMiscNames[i] != s &&
603 LyXMiscNames[i] != string("error")) ++i;
604 if (s == LyXMiscNames[i])
605 return FONT_MISC_STATE(i);
606 lyxerr << "LyXFont::setLyXMisc: Unknown misc flag `"
607 << s << '\'' << endl;
612 /// Sets color after LyX text format
613 LyXFont & LyXFont::setLyXColor(string const & col)
615 setColor(lcolor.getFromLyXName(col));
620 // Returns size in latex format
621 string const LyXFont::latexSize() const
623 return LaTeXSizeNames[size()];
627 // Read a font definition from given file in lyx format
629 LyXFont & LyXFont::lyxRead(LyXLex & lex)
632 bool finished = false;
633 while (!finished && lex.isOK() && !error) {
635 string const tok = ascii_lowercase(lex.getString());
639 } else if (tok == "endfont") {
641 } else if (tok == "family") {
643 string const ttok = lex.getString();
645 } else if (tok == "series") {
647 string const ttok = lex.getString();
649 } else if (tok == "shape") {
651 string const ttok = lex.getString();
653 } else if (tok == "size") {
655 string const ttok = lex.getString();
657 } else if (tok == "misc") {
659 string const ttok = ascii_lowercase(lex.getString());
661 if (ttok == "no_bar") {
663 } else if (ttok == "no_emph") {
665 } else if (ttok == "no_noun") {
667 } else if (ttok == "emph") {
669 } else if (ttok == "underbar") {
671 } else if (ttok == "noun") {
674 lex.printError("Illegal misc type `$$Token´");
676 } else if (tok == "color") {
678 string const ttok = lex.getString();
681 lex.printError("Unknown tag `$$Token'");
689 /// Writes the changes from this font to orgfont in .lyx format in file
690 void LyXFont::lyxWriteChanges(LyXFont const & orgfont,
694 if (orgfont.family() != family())
695 os << "\\family " << LyXFamilyNames[family()] << "\n";
696 if (orgfont.series() != series())
697 os << "\\series " << LyXSeriesNames[series()] << "\n";
698 if (orgfont.shape() != shape())
699 os << "\\shape " << LyXShapeNames[shape()] << "\n";
700 if (orgfont.size() != size())
701 os << "\\size " << LyXSizeNames[size()] << "\n";
702 if (orgfont.emph() != emph())
703 os << "\\emph " << LyXMiscNames[emph()] << "\n";
704 if (orgfont.number() != number())
705 os << "\\numeric " << LyXMiscNames[number()] << "\n";
706 if (orgfont.underbar() != underbar()) {
707 // This is only for backwards compatibility
708 switch (underbar()) {
709 case OFF: os << "\\bar no\n"; break;
710 case ON: os << "\\bar under\n"; break;
711 case TOGGLE: lyxerr << "LyXFont::lyxWriteFontChanges: "
712 "TOGGLE should not appear here!"
715 case INHERIT: os << "\\bar default\n"; break;
716 case IGNORE: lyxerr << "LyXFont::lyxWriteFontChanges: "
717 "IGNORE should not appear here!"
722 if (orgfont.noun() != noun()) {
723 os << "\\noun " << LyXMiscNames[noun()] << "\n";
725 if (orgfont.color() != color()) {
726 // To make us file compatible with older
727 // lyx versions we emit "default" instead
729 string col_str(lcolor.getLyXName(color()));
730 if (col_str == "inherit") col_str = "default";
731 os << "\\color " << col_str << "\n";
733 if (orgfont.language() != language() &&
734 language() != latex_language) {
736 os << "\\lang " << language()->lang() << "\n";
738 os << "\\lang unknown\n";
743 /// Writes the head of the LaTeX needed to impose this font
744 // Returns number of chars written.
745 int LyXFont::latexWriteStartChanges(odocstream & os, LyXFont const & base,
746 LyXFont const & prev) const
751 if (language()->babel() != base.language()->babel() &&
752 language() != prev.language()) {
753 if (isRightToLeft() != prev.isRightToLeft()) {
754 if (isRightToLeft()) {
763 subst(lyxrc.language_command_local,
764 "$$lang", language()->babel());
765 os << lyx::from_ascii(tmp);
766 count += tmp.length();
770 if (number() == ON && prev.number() != ON &&
771 language()->lang() == "hebrew") {
779 if (f.family() != INHERIT_FAMILY) {
781 << LaTeXFamilyNames[f.family()]
783 count += strlen(LaTeXFamilyNames[f.family()]) + 2;
784 env = true; //We have opened a new environment
786 if (f.series() != INHERIT_SERIES) {
788 << LaTeXSeriesNames[f.series()]
790 count += strlen(LaTeXSeriesNames[f.series()]) + 2;
791 env = true; //We have opened a new environment
793 if (f.shape() != INHERIT_SHAPE) {
795 << LaTeXShapeNames[f.shape()]
797 count += strlen(LaTeXShapeNames[f.shape()]) + 2;
798 env = true; //We have opened a new environment
800 if (f.color() != LColor::inherit && f.color() != LColor::ignore) {
802 << lyx::from_ascii(lcolor.getLaTeXName(f.color()))
804 count += lcolor.getLaTeXName(f.color()).length() + 13;
805 env = true; //We have opened a new environment
807 if (f.emph() == ON) {
810 env = true; //We have opened a new environment
812 if (f.underbar() == ON) {
815 env = true; //We have opened a new environment
817 // \noun{} is a LyX special macro
818 if (f.noun() == ON) {
821 env = true; //We have opened a new environment
823 if (f.size() != INHERIT_SIZE) {
824 // If we didn't open an environment above, we open one here
830 << LaTeXSizeNames[f.size()]
832 count += strlen(LaTeXSizeNames[f.size()]) + 2;
838 /// Writes ending block of LaTeX needed to close use of this font
839 // Returns number of chars written
840 // This one corresponds to latexWriteStartChanges(). (Asger)
841 int LyXFont::latexWriteEndChanges(odocstream & os, LyXFont const & base,
842 LyXFont const & next) const
847 // reduce the current font to changes against the base
848 // font (of the layout). We use a temporary for this to
849 // avoid changing this font instance, as that would break
853 if (f.family() != INHERIT_FAMILY) {
856 env = true; // Size change need not bother about closing env.
858 if (f.series() != INHERIT_SERIES) {
861 env = true; // Size change need not bother about closing env.
863 if (f.shape() != INHERIT_SHAPE) {
866 env = true; // Size change need not bother about closing env.
868 if (f.color() != LColor::inherit && f.color() != LColor::ignore) {
871 env = true; // Size change need not bother about closing env.
873 if (f.emph() == ON) {
876 env = true; // Size change need not bother about closing env.
878 if (f.underbar() == ON) {
881 env = true; // Size change need not bother about closing env.
883 if (f.noun() == ON) {
886 env = true; // Size change need not bother about closing env.
888 if (f.size() != INHERIT_SIZE) {
889 // We only have to close if only size changed
896 if (number() == ON && next.number() != ON &&
897 language()->lang() == "hebrew") {
902 if (language() != base.language() && language() != next.language()) {
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);