1 /* This file is part of
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
7 * Copyright 1995-2001 The LyX Team.
9 * ====================================================== */
16 #pragma implementation
25 #include "FontLoader.h"
26 #include "support/lstrings.h"
27 #include "bufferparams.h" // stateText
32 #ifndef CXX_GLOBAL_CSTD
42 char const * GUIFamilyNames[11] =
43 { N_("Roman"), N_("Sans serif"), N_("Typewriter"), N_("Symbol"),
44 "cmsy", "cmm", "cmex", "msa", "msb",
45 N_("Inherit"), N_("Ignore") };
47 char const * GUISeriesNames[4] =
48 { N_("Medium"), N_("Bold"), N_("Inherit"), N_("Ignore") };
50 char const * GUIShapeNames[6] =
51 { N_("Upright"), N_("Italic"), N_("Slanted"), N_("Smallcaps"), N_("Inherit"),
54 char const * GUISizeNames[14] =
55 { N_("Tiny"), N_("Smallest"), N_("Smaller"), N_("Small"), N_("Normal"), N_("Large"),
56 N_("Larger"), N_("Largest"), N_("Huge"), N_("Huger"), N_("Increase"), N_("Decrease"),
57 N_("Inherit"), N_("Ignore") };
59 char const * GUIMiscNames[5] =
60 { N_("Off"), N_("On"), N_("Toggle"), N_("Inherit"), N_("Ignore") };
64 // Strings used to read and write .lyx format files
66 char const * LyXFamilyNames[12] =
67 { "roman", "sans", "typewriter", "symbol", "symbol2", "symbol3",
68 "symbolex", "fraktur", "mathscr", "mathbb", "default", "error" };
70 char const * LyXSeriesNames[4] =
71 { "medium", "bold", "default", "error" };
73 char const * LyXShapeNames[6] =
74 { "up", "italic", "slanted", "smallcaps", "default", "error" };
76 char const * LyXSizeNames[14] =
77 { "tiny", "scriptsize", "footnotesize", "small", "normal", "large",
78 "larger", "largest", "huge", "giant",
79 "increase-error", "decrease-error", "default", "error" };
81 char const * LyXMiscNames[5] =
82 { "off", "on", "toggle", "default", "error" };
85 // Strings used to write LaTeX files
87 char const * LaTeXFamilyNames[6] =
88 { "textrm", "textsf", "texttt", "error1", "error2", "error3" };
90 char const * LaTeXSeriesNames[4] =
91 { "textmd", "textbf", "error4", "error5" };
93 char const * LaTeXShapeNames[6] =
94 { "textup", "textit", "textsl", "textsc", "error6", "error7" };
96 char const * LaTeXSizeNames[14] =
97 { "tiny", "scriptsize", "footnotesize", "small", "normalsize", "large",
98 "Large", "LARGE", "huge", "Huge", "error8", "error9", "error10", "error11" };
103 // Initialize static member
104 LyXFont::FontBits LyXFont::sane = {
115 // Initialize static member
116 LyXFont::FontBits LyXFont::inherit = {
127 // Initialize static member
128 LyXFont::FontBits LyXFont::ignore = {
140 bool LyXFont::FontBits::operator==(LyXFont::FontBits const & fb1) const
142 return fb1.family == family &&
143 fb1.series == series &&
144 fb1.shape == shape &&
146 fb1.color == color &&
148 fb1.underbar == underbar &&
150 fb1.number == number;
154 bool LyXFont::FontBits::operator!=(LyXFont::FontBits const & fb1) const
156 return !(fb1 == *this);
160 LyXFont::LyXFont(LyXFont::FONT_INIT1)
161 #ifndef INHERIT_LANGUAGE
162 : bits(inherit), lang(default_language)
164 : bits(inherit), lang(inherit_language)
169 LyXFont::LyXFont(LyXFont::FONT_INIT2)
170 : bits(ignore), lang(ignore_language)
174 LyXFont::LyXFont(LyXFont::FONT_INIT3)
175 : bits(sane), lang(default_language)
179 LyXFont::LyXFont(LyXFont::FONT_INIT1, Language const * l)
180 : bits(inherit), lang(l)
184 LyXFont::LyXFont(LyXFont::FONT_INIT2, Language const * l)
185 : bits(ignore), lang(l)
189 LyXFont::LyXFont(LyXFont::FONT_INIT3, Language const * l)
190 : bits(sane), lang(l)
194 LyXFont::FONT_MISC_STATE LyXFont::underbar() const
196 return bits.underbar;
200 LColor::color LyXFont::color() const
206 Language const * LyXFont::language() const
212 LyXFont::FONT_MISC_STATE LyXFont::number() const
218 bool LyXFont::isRightToLeft() const
220 return lang->RightToLeft();
224 bool LyXFont::isVisibleRightToLeft() const
226 return (lang->RightToLeft() &&
231 LyXFont & LyXFont::setFamily(LyXFont::FONT_FAMILY f)
238 LyXFont & LyXFont::setSeries(LyXFont::FONT_SERIES s)
245 LyXFont & LyXFont::setShape(LyXFont::FONT_SHAPE s)
252 LyXFont & LyXFont::setSize(LyXFont::FONT_SIZE s)
259 LyXFont & LyXFont::setEmph(LyXFont::FONT_MISC_STATE e)
266 LyXFont & LyXFont::setUnderbar(LyXFont::FONT_MISC_STATE u)
273 LyXFont & LyXFont::setNoun(LyXFont::FONT_MISC_STATE n)
280 LyXFont & LyXFont::setColor(LColor::color c)
287 LyXFont & LyXFont::setLanguage(Language const * l)
294 LyXFont & LyXFont::setNumber(LyXFont::FONT_MISC_STATE n)
301 /// Decreases font size by one
302 LyXFont & LyXFont::decSize()
305 case SIZE_HUGER: setSize(SIZE_HUGE); break;
306 case SIZE_HUGE: setSize(SIZE_LARGEST); break;
307 case SIZE_LARGEST: setSize(SIZE_LARGER); break;
308 case SIZE_LARGER: setSize(SIZE_LARGE); break;
309 case SIZE_LARGE: setSize(SIZE_NORMAL); break;
310 case SIZE_NORMAL: setSize(SIZE_SMALL); break;
311 case SIZE_SMALL: setSize(SIZE_FOOTNOTE); break;
312 case SIZE_FOOTNOTE: setSize(SIZE_SCRIPT); break;
313 case SIZE_SCRIPT: setSize(SIZE_TINY); break;
314 case SIZE_TINY: break;
316 lyxerr << "Can't LyXFont::decSize on INCREASE_SIZE" << endl;
319 lyxerr <<"Can't LyXFont::decSize on DECREASE_SIZE" << endl;
322 lyxerr <<"Can't LyXFont::decSize on INHERIT_SIZE" << endl;
325 lyxerr <<"Can't LyXFont::decSize on IGNORE_SIZE" << endl;
332 /// Increases font size by one
333 LyXFont & LyXFont::incSize()
336 case SIZE_HUGER: break;
337 case SIZE_HUGE: setSize(SIZE_HUGER); break;
338 case SIZE_LARGEST: setSize(SIZE_HUGE); break;
339 case SIZE_LARGER: setSize(SIZE_LARGEST); break;
340 case SIZE_LARGE: setSize(SIZE_LARGER); break;
341 case SIZE_NORMAL: setSize(SIZE_LARGE); break;
342 case SIZE_SMALL: setSize(SIZE_NORMAL); break;
343 case SIZE_FOOTNOTE: setSize(SIZE_SMALL); break;
344 case SIZE_SCRIPT: setSize(SIZE_FOOTNOTE); break;
345 case SIZE_TINY: setSize(SIZE_SCRIPT); break;
347 lyxerr <<"Can't LyXFont::incSize on INCREASE_SIZE" << endl;
350 lyxerr <<"Can't LyXFont::incSize on DECREASE_SIZE" << endl;
353 lyxerr <<"Can't LyXFont::incSize on INHERIT_SIZE" << endl;
356 lyxerr <<"Can't LyXFont::incSize on IGNORE_SIZE" << endl;
363 /// Updates a misc setting according to request
364 LyXFont::FONT_MISC_STATE LyXFont::setMisc(FONT_MISC_STATE newfont,
367 if (newfont == TOGGLE) {
373 lyxerr <<"LyXFont::setMisc: Need state"
374 " ON or OFF to toggle. Setting to ON" << endl;
377 } else if (newfont == IGNORE)
384 /// Updates font settings according to request
385 void LyXFont::update(LyXFont const & newfont,
386 Language const * document_language,
389 if (newfont.family() == family() && toggleall)
390 setFamily(INHERIT_FAMILY); // toggle 'back'
391 else if (newfont.family() != IGNORE_FAMILY)
392 setFamily(newfont.family());
393 // else it's IGNORE_SHAPE
395 // "Old" behaviour: "Setting" bold will toggle bold on/off.
396 switch (newfont.series()) {
399 if (series() == BOLD_SERIES && toggleall)
400 setSeries(MEDIUM_SERIES);
402 setSeries(BOLD_SERIES);
406 setSeries(newfont.series());
412 if (newfont.shape() == shape() && toggleall)
413 setShape(INHERIT_SHAPE); // toggle 'back'
414 else if (newfont.shape() != IGNORE_SHAPE)
415 setShape(newfont.shape());
416 // else it's IGNORE_SHAPE
418 if (newfont.size() != IGNORE_SIZE) {
419 if (newfont.size() == INCREASE_SIZE)
421 else if (newfont.size() == DECREASE_SIZE)
424 setSize(newfont.size());
427 setEmph(setMisc(newfont.emph(), emph()));
428 setUnderbar(setMisc(newfont.underbar(), underbar()));
429 setNoun(setMisc(newfont.noun(), noun()));
431 setNumber(setMisc(newfont.number(), number()));
432 if (newfont.language() == language() && toggleall)
433 if (language() == document_language)
434 setLanguage(default_language);
436 #ifndef INHERIT_LANGUAGE
437 setLanguage(document_language);
439 setLanguage(inherit_language);
441 else if (newfont.language() != ignore_language)
442 setLanguage(newfont.language());
444 if (newfont.color() == color() && toggleall)
445 setColor(LColor::inherit); // toggle 'back'
446 else if (newfont.color() != LColor::ignore)
447 setColor(newfont.color());
451 /// Reduce font to fall back to template where possible
452 void LyXFont::reduce(LyXFont const & tmplt)
454 if (family() == tmplt.family())
455 setFamily(INHERIT_FAMILY);
456 if (series() == tmplt.series())
457 setSeries(INHERIT_SERIES);
458 if (shape() == tmplt.shape())
459 setShape(INHERIT_SHAPE);
460 if (size() == tmplt.size())
461 setSize(INHERIT_SIZE);
462 if (emph() == tmplt.emph())
464 if (underbar() == tmplt.underbar())
465 setUnderbar(INHERIT);
466 if (noun() == tmplt.noun())
468 if (color() == tmplt.color())
469 setColor(LColor::inherit);
470 #ifdef INHERIT_LANGUAGE
471 if (language() == tmplt.language())
472 setLanguage(inherit_language);
477 /// Realize font from a template
478 #ifndef INHERIT_LANGUAGE
479 LyXFont & LyXFont::realize(LyXFont const & tmplt)
481 LyXFont & LyXFont::realize(LyXFont const & tmplt, Language const * deflang)
484 #ifdef INHERIT_LANGUAGE
485 if (language() == inherit_language) {
486 if (tmplt.language() == inherit_language ||
487 tmplt.language() == ignore_language ||
488 tmplt.language() == default_language)
490 setLanguage(deflang);
492 setLanguage(tmplt.language());
496 if (bits == inherit) {
501 if (bits.family == INHERIT_FAMILY) {
502 bits.family = tmplt.bits.family;
504 if (bits.series == INHERIT_SERIES) {
505 bits.series = tmplt.bits.series;
507 if (bits.shape == INHERIT_SHAPE) {
508 bits.shape = tmplt.bits.shape;
510 if (bits.size == INHERIT_SIZE) {
511 bits.size = tmplt.bits.size;
513 if (bits.emph == INHERIT) {
514 bits.emph = tmplt.bits.emph;
516 if (bits.underbar == INHERIT) {
517 bits.underbar = tmplt.bits.underbar;
519 if (bits.noun == INHERIT) {
520 bits.noun = tmplt.bits.noun;
522 if (bits.color == LColor::inherit) {
523 bits.color = tmplt.bits.color;
529 /// Is font resolved?
530 bool LyXFont::resolved() const
532 return (family() != INHERIT_FAMILY && series() != INHERIT_SERIES &&
533 shape() != INHERIT_SHAPE && size() != INHERIT_SIZE &&
534 emph() != INHERIT && underbar() != INHERIT &&
536 #ifdef INHERIT_LANGUAGE
537 language() != inherit_language &&
539 color() != LColor::inherit);
543 /// Build GUI description of font state
544 string const LyXFont::stateText(BufferParams * params) const
547 if (family() != INHERIT_FAMILY)
548 ost << _(GUIFamilyNames[family()]) << ", ";
549 if (series() != INHERIT_SERIES)
550 ost << _(GUISeriesNames[series()]) << ", ";
551 if (shape() != INHERIT_SHAPE)
552 ost << _(GUIShapeNames[shape()]) << ", ";
553 if (size() != INHERIT_SIZE)
554 ost << _(GUISizeNames[size()]) << ", ";
555 if (color() != LColor::inherit)
556 ost << lcolor.getGUIName(color()) << ", ";
557 if (emph() != INHERIT)
558 ost << _("Emphasis ")
559 << _(GUIMiscNames[emph()]) << ", ";
560 if (underbar() != INHERIT)
561 ost << _("Underline ")
562 << _(GUIMiscNames[underbar()]) << ", ";
563 if (noun() != INHERIT)
564 ost << _("Noun ") << _(GUIMiscNames[noun()]) << ", ";
566 ost << _("Default") << ", ";
567 if (!params || (language() != params->language))
568 ost << _("Language: ") << _(language()->display()) << ", ";
570 ost << _(" Number ") << _(GUIMiscNames[number()]);
572 string buf(ost.str().c_str());
573 buf = strip(buf, ' ');
574 buf = strip(buf, ',');
579 // Set family according to lyx format string
580 LyXFont & LyXFont::setLyXFamily(string const & fam)
582 string const s = lowercase(fam);
585 while (s != LyXFamilyNames[i] && LyXFamilyNames[i] != "error") ++i;
586 if (s == LyXFamilyNames[i]) {
587 setFamily(LyXFont::FONT_FAMILY(i));
589 lyxerr << "LyXFont::setLyXFamily: Unknown family `"
590 << s << '\'' << endl;
595 // Set series according to lyx format string
596 LyXFont & LyXFont::setLyXSeries(string const & ser)
598 string const s = lowercase(ser);
601 while (s != LyXSeriesNames[i] && LyXSeriesNames[i] != "error") ++i;
602 if (s == LyXSeriesNames[i]) {
603 setSeries(LyXFont::FONT_SERIES(i));
605 lyxerr << "LyXFont::setLyXSeries: Unknown series `"
606 << s << '\'' << endl;
611 // Set shape according to lyx format string
612 LyXFont & LyXFont::setLyXShape(string const & sha)
614 string const s = lowercase(sha);
617 while (s != LyXShapeNames[i] && LyXShapeNames[i] != "error") ++i;
618 if (s == LyXShapeNames[i]) {
619 setShape(LyXFont::FONT_SHAPE(i));
621 lyxerr << "LyXFont::setLyXShape: Unknown shape `"
622 << s << '\'' << endl;
627 // Set size according to lyx format string
628 LyXFont & LyXFont::setLyXSize(string const & siz)
630 string const s = lowercase(siz);
632 while (s != LyXSizeNames[i] && LyXSizeNames[i] != "error") ++i;
633 if (s == LyXSizeNames[i]) {
634 setSize(LyXFont::FONT_SIZE(i));
636 lyxerr << "LyXFont::setLyXSize: Unknown size `"
637 << s << '\'' << endl;
642 // Set size according to lyx format string
643 LyXFont::FONT_MISC_STATE LyXFont::setLyXMisc(string const & siz)
645 string const s = lowercase(siz);
647 while (s != LyXMiscNames[i] && LyXMiscNames[i] != "error") ++i;
648 if (s == LyXMiscNames[i])
649 return FONT_MISC_STATE(i);
650 lyxerr << "LyXFont::setLyXMisc: Unknown misc flag `"
651 << s << '\'' << endl;
656 /// Sets color after LyX text format
657 LyXFont & LyXFont::setLyXColor(string const & col)
659 setColor(lcolor.getFromLyXName(col));
664 // Returns size in latex format
665 string const LyXFont::latexSize() const
667 return LaTeXSizeNames[size()];
671 // Read a font definition from given file in lyx format
673 LyXFont & LyXFont::lyxRead(LyXLex & lex)
676 bool finished = false;
677 while (!finished && lex.isOK() && !error) {
679 string const tok = lowercase(lex.getString());
683 } else if (tok == "endfont") {
685 } else if (tok == "family") {
687 string const ttok = lex.getString();
689 } else if (tok == "series") {
691 string const ttok = lex.getString();
693 } else if (tok == "shape") {
695 string const ttok = lex.getString();
697 } else if (tok == "size") {
699 string const ttok = lex.getString();
701 } else if (tok == "misc") {
703 string const ttok = lowercase(lex.getString());
705 if (ttok == "no_bar") {
707 } else if (ttok == "no_emph") {
709 } else if (ttok == "no_noun") {
711 } else if (ttok == "emph") {
713 } else if (ttok == "underbar") {
715 } else if (ttok == "noun") {
718 lex.printError("Illegal misc type `$$Token´");
720 } else if (tok == "color") {
722 string const ttok = lex.getString();
725 lex.printError("Unknown tag `$$Token'");
733 /// Writes the changes from this font to orgfont in .lyx format in file
734 void LyXFont::lyxWriteChanges(LyXFont const & orgfont,
735 #ifdef INHERIT_LANGUAGE
736 Language const * doclang,
741 if (orgfont.family() != family()) {
742 os << "\\family " << LyXFamilyNames[family()] << " \n";
744 if (orgfont.series() != series()) {
745 os << "\\series " << LyXSeriesNames[series()] << " \n";
747 if (orgfont.shape() != shape()) {
748 os << "\\shape " << LyXShapeNames[shape()] << " \n";
750 if (orgfont.size() != size()) {
751 os << "\\size " << LyXSizeNames[size()] << " \n";
753 if (orgfont.emph() != emph()) {
754 os << "\\emph " << LyXMiscNames[emph()] << " \n";
756 if (orgfont.number() != number()) {
757 os << "\\numeric " << LyXMiscNames[number()] << " \n";
759 if (orgfont.underbar() != underbar()) {
760 // This is only for backwards compatibility
761 switch (underbar()) {
762 case OFF: os << "\\bar no \n"; break;
763 case ON: os << "\\bar under \n"; break;
764 case TOGGLE: lyxerr << "LyXFont::lyxWriteFontChanges: "
765 "TOGGLE should not appear here!"
768 case INHERIT: os << "\\bar default \n"; break;
769 case IGNORE: lyxerr << "LyXFont::lyxWriteFontChanges: "
770 "IGNORE should not appear here!"
775 if (orgfont.noun() != noun()) {
776 os << "\\noun " << LyXMiscNames[noun()] << " \n";
778 if (orgfont.color() != color()) {
779 // To make us file compatible with older
780 // lyx versions we emit "default" instead
782 string col_str(lcolor.getLyXName(color()));
783 if (col_str == "inherit") col_str = "default";
784 os << "\\color " << col_str << "\n";
786 if (orgfont.language() != language()) {
787 #ifndef INHERIT_LANGUAGE
790 if (language() == inherit_language)
791 os << "\\lang " << doclang->lang() << "\n";
794 os << "\\lang " << language()->lang() << "\n";
796 os << "\\lang unknown\n";
801 /// Writes the head of the LaTeX needed to impose this font
802 // Returns number of chars written.
803 int LyXFont::latexWriteStartChanges(ostream & os, LyXFont const & base,
804 LyXFont const & prev) const
809 if (language()->babel() != base.language()->babel() &&
810 language()->babel() != prev.language()->babel()) {
811 if (isRightToLeft() != prev.isRightToLeft()) {
812 if (isRightToLeft()) {
821 subst(lyxrc.language_command_local,
822 "$$lang", language()->babel());
824 count += tmp.length();
828 if (number() == ON && prev.number() != ON &&
829 language()->lang() == "hebrew") {
837 if (f.family() != INHERIT_FAMILY) {
839 << LaTeXFamilyNames[f.family()]
841 count += strlen(LaTeXFamilyNames[f.family()]) + 2;
842 env = true; //We have opened a new environment
844 if (f.series() != INHERIT_SERIES) {
846 << LaTeXSeriesNames[f.series()]
848 count += strlen(LaTeXSeriesNames[f.series()]) + 2;
849 env = true; //We have opened a new environment
851 if (f.shape() != INHERIT_SHAPE) {
853 << LaTeXShapeNames[f.shape()]
855 count += strlen(LaTeXShapeNames[f.shape()]) + 2;
856 env = true; //We have opened a new environment
858 if (f.color() != LColor::inherit && f.color() != LColor::ignore) {
860 << lcolor.getLaTeXName(f.color())
862 count += lcolor.getLaTeXName(f.color()).length() + 13;
863 env = true; //We have opened a new environment
865 if (f.emph() == ON) {
868 env = true; //We have opened a new environment
870 if (f.underbar() == ON) {
873 env = true; //We have opened a new environment
875 // \noun{} is a LyX special macro
876 if (f.noun() == ON) {
879 env = true; //We have opened a new environment
881 if (f.size() != INHERIT_SIZE) {
882 // If we didn't open an environment above, we open one here
888 << LaTeXSizeNames[f.size()]
890 count += strlen(LaTeXSizeNames[f.size()]) + 2;
896 /// Writes ending block of LaTeX needed to close use of this font
897 // Returns number of chars written
898 // This one corresponds to latexWriteStartChanges(). (Asger)
899 int LyXFont::latexWriteEndChanges(ostream & os, LyXFont const & base,
900 LyXFont const & next) const
905 LyXFont f = *this; // why do you need this?
906 f.reduce(base); // why isn't this just "reduce(base);" (Lgb)
907 // Because this function is const. Everything breaks if this
908 // method changes the font it represents. There is no speed penalty
909 // by using the temporary. (Asger)
912 if (f.family() != INHERIT_FAMILY) {
915 env = true; // Size change need not bother about closing env.
917 if (f.series() != INHERIT_SERIES) {
920 env = true; // Size change need not bother about closing env.
922 if (f.shape() != INHERIT_SHAPE) {
925 env = true; // Size change need not bother about closing env.
927 if (f.color() != LColor::inherit && f.color() != LColor::ignore) {
930 env = true; // Size change need not bother about closing env.
932 if (f.emph() == ON) {
935 env = true; // Size change need not bother about closing env.
937 if (f.underbar() == ON) {
940 env = true; // Size change need not bother about closing env.
942 if (f.noun() == ON) {
945 env = true; // Size change need not bother about closing env.
947 if (f.size() != INHERIT_SIZE) {
948 // We only have to close if only size changed
955 if (number() == ON && next.number() != ON &&
956 language()->lang() == "hebrew") {
961 if (language() != base.language() && language() != next.language()) {
970 LColor::color LyXFont::realColor() const
972 if (color() == LColor::none)
973 return LColor::foreground;
978 // Convert logical attributes to concrete shape attribute
979 LyXFont::FONT_SHAPE LyXFont::realShape() const
981 register FONT_SHAPE s = shape();
995 ostream & operator<<(ostream & o, LyXFont::FONT_MISC_STATE fms)
997 return o << int(fms);