1 /* This file is part of
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
7 * Copyright 1995-2000 The LyX Team.
9 * ====================================================== */
16 #pragma implementation
26 #include "FontLoader.h"
27 #include "support/lstrings.h"
28 #include "bufferparams.h" // stateText
39 char const * GUIFamilyNames[6] =
40 { N_("Roman"), N_("Sans serif"), N_("Typewriter"), N_("Symbol"), N_("Inherit"),
43 char const * GUISeriesNames[4] =
44 { N_("Medium"), N_("Bold"), N_("Inherit"), N_("Ignore") };
46 char const * GUIShapeNames[6] =
47 { N_("Upright"), N_("Italic"), N_("Slanted"), N_("Smallcaps"), N_("Inherit"),
50 char const * GUISizeNames[14] =
51 { N_("Tiny"), N_("Smallest"), N_("Smaller"), N_("Small"), N_("Normal"), N_("Large"),
52 N_("Larger"), N_("Largest"), N_("Huge"), N_("Huger"), N_("Increase"), N_("Decrease"),
53 N_("Inherit"), N_("Ignore") };
55 char const * GUIMiscNames[5] =
56 { N_("Off"), N_("On"), N_("Toggle"), N_("Inherit"), N_("Ignore") };
60 // Strings used to read and write .lyx format files
62 char const * LyXFamilyNames[6] =
63 { "roman", "sans", "typewriter", "symbol", "default", "error" };
65 char const * LyXSeriesNames[4] =
66 { "medium", "bold", "default", "error" };
68 char const * LyXShapeNames[6] =
69 { "up", "italic", "slanted", "smallcaps", "default", "error" };
71 char const * LyXSizeNames[14] =
72 { "tiny", "scriptsize", "footnotesize", "small", "normal", "large",
73 "larger", "largest", "huge", "giant",
74 "increase-error", "decrease-error", "default", "error" };
76 char const * LyXMiscNames[5] =
77 { "off", "on", "toggle", "default", "error" };
80 // Strings used to write LaTeX files
82 char const * LaTeXFamilyNames[6] =
83 { "textrm", "textsf", "texttt", "error1", "error2", "error3" };
85 char const * LaTeXSeriesNames[4] =
86 { "textmd", "textbf", "error4", "error5" };
88 char const * LaTeXShapeNames[6] =
89 { "textup", "textit", "textsl", "textsc", "error6", "error7" };
91 char const * LaTeXSizeNames[14] =
92 { "tiny", "scriptsize", "footnotesize", "small", "normalsize", "large",
93 "Large", "LARGE", "huge", "Huge", "error8", "error9", "error10", "error11" };
98 // Initialize static member
99 LyXFont::FontBits LyXFont::sane = {
111 // Initialize static member
112 LyXFont::FontBits LyXFont::inherit = {
124 // Initialize static member
125 LyXFont::FontBits LyXFont::ignore = {
138 bool LyXFont::FontBits::operator==(LyXFont::FontBits const & fb1) const
140 return fb1.family == family &&
141 fb1.series == series &&
142 fb1.shape == shape &&
144 fb1.color == color &&
146 fb1.underbar == underbar &&
148 fb1.latex == latex &&
149 fb1.number == number;
153 bool LyXFont::FontBits::operator!=(LyXFont::FontBits const & fb1) const
155 return !(fb1 == *this);
160 : bits(sane), lang(default_language)
164 LyXFont::LyXFont(LyXFont::FONT_INIT1)
165 : bits(inherit), lang(default_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_FAMILY LyXFont::family() const
200 LyXFont::FONT_SERIES LyXFont::series() const
206 LyXFont::FONT_SIZE LyXFont::size() const
212 LyXFont::FONT_MISC_STATE LyXFont::underbar() const
214 return bits.underbar;
218 LyXFont::FONT_MISC_STATE LyXFont::noun() const
224 LyXFont::FONT_MISC_STATE LyXFont::latex() const
230 LColor::color LyXFont::color() const
236 Language const * LyXFont::language() const
242 LyXFont::FONT_MISC_STATE LyXFont::number() const
248 bool LyXFont::isRightToLeft() const
250 return lang->RightToLeft();
254 bool LyXFont::isVisibleRightToLeft() const
256 return (lang->RightToLeft() && latex() != ON && number() != ON);
260 LyXFont & LyXFont::setFamily(LyXFont::FONT_FAMILY f)
267 LyXFont & LyXFont::setSeries(LyXFont::FONT_SERIES s)
274 LyXFont & LyXFont::setShape(LyXFont::FONT_SHAPE s)
281 LyXFont & LyXFont::setSize(LyXFont::FONT_SIZE s)
288 LyXFont & LyXFont::setEmph(LyXFont::FONT_MISC_STATE e)
295 LyXFont & LyXFont::setUnderbar(LyXFont::FONT_MISC_STATE u)
302 LyXFont & LyXFont::setNoun(LyXFont::FONT_MISC_STATE n)
309 LyXFont & LyXFont::setLatex(LyXFont::FONT_MISC_STATE l)
316 LyXFont & LyXFont::setColor(LColor::color c)
323 LyXFont & LyXFont::setLanguage(Language const * l)
330 LyXFont & LyXFont::setNumber(LyXFont::FONT_MISC_STATE n)
337 /// Decreases font size by one
338 LyXFont & LyXFont::decSize()
341 case SIZE_HUGER: setSize(SIZE_HUGE); break;
342 case SIZE_HUGE: setSize(SIZE_LARGEST); break;
343 case SIZE_LARGEST: setSize(SIZE_LARGER); break;
344 case SIZE_LARGER: setSize(SIZE_LARGE); break;
345 case SIZE_LARGE: setSize(SIZE_NORMAL); break;
346 case SIZE_NORMAL: setSize(SIZE_SMALL); break;
347 case SIZE_SMALL: setSize(SIZE_FOOTNOTE); break;
348 case SIZE_FOOTNOTE: setSize(SIZE_SCRIPT); break;
349 case SIZE_SCRIPT: setSize(SIZE_TINY); break;
350 case SIZE_TINY: break;
352 lyxerr << "Can't LyXFont::decSize on INCREASE_SIZE" << endl;
355 lyxerr <<"Can't LyXFont::decSize on DECREASE_SIZE" << endl;
358 lyxerr <<"Can't LyXFont::decSize on INHERIT_SIZE" << endl;
361 lyxerr <<"Can't LyXFont::decSize on IGNORE_SIZE" << endl;
368 /// Increases font size by one
369 LyXFont & LyXFont::incSize()
372 case SIZE_HUGER: break;
373 case SIZE_HUGE: setSize(SIZE_HUGER); break;
374 case SIZE_LARGEST: setSize(SIZE_HUGE); break;
375 case SIZE_LARGER: setSize(SIZE_LARGEST); break;
376 case SIZE_LARGE: setSize(SIZE_LARGER); break;
377 case SIZE_NORMAL: setSize(SIZE_LARGE); break;
378 case SIZE_SMALL: setSize(SIZE_NORMAL); break;
379 case SIZE_FOOTNOTE: setSize(SIZE_SMALL); break;
380 case SIZE_SCRIPT: setSize(SIZE_FOOTNOTE); break;
381 case SIZE_TINY: setSize(SIZE_SCRIPT); break;
383 lyxerr <<"Can't LyXFont::incSize on INCREASE_SIZE" << endl;
386 lyxerr <<"Can't LyXFont::incSize on DECREASE_SIZE" << endl;
389 lyxerr <<"Can't LyXFont::incSize on INHERIT_SIZE" << endl;
392 lyxerr <<"Can't LyXFont::incSize on IGNORE_SIZE" << endl;
399 /// Updates a misc setting according to request
400 LyXFont::FONT_MISC_STATE LyXFont::setMisc(FONT_MISC_STATE newfont,
403 if (newfont == TOGGLE) {
409 lyxerr <<"LyXFont::setMisc: Need state"
410 " ON or OFF to toggle. Setting to ON" << endl;
413 } else if (newfont == IGNORE)
420 /// Updates font settings according to request
421 void LyXFont::update(LyXFont const & newfont,
422 Language const * document_language, bool toggleall)
424 if (newfont.family() == family() && toggleall)
425 setFamily(INHERIT_FAMILY); // toggle 'back'
426 else if (newfont.family() != IGNORE_FAMILY)
427 setFamily(newfont.family());
428 // else it's IGNORE_SHAPE
430 // "Old" behaviour: "Setting" bold will toggle bold on/off.
431 switch (newfont.series()) {
434 if (series() == BOLD_SERIES && toggleall)
435 setSeries(MEDIUM_SERIES);
437 setSeries(BOLD_SERIES);
441 setSeries(newfont.series());
447 if (newfont.shape() == shape() && toggleall)
448 setShape(INHERIT_SHAPE); // toggle 'back'
449 else if (newfont.shape() != IGNORE_SHAPE)
450 setShape(newfont.shape());
451 // else it's IGNORE_SHAPE
453 if (newfont.size() != IGNORE_SIZE) {
454 if (newfont.size() == INCREASE_SIZE)
456 else if (newfont.size() == DECREASE_SIZE)
459 setSize(newfont.size());
462 setEmph(setMisc(newfont.emph(), emph()));
463 setUnderbar(setMisc(newfont.underbar(), underbar()));
464 setNoun(setMisc(newfont.noun(), noun()));
465 setLatex(setMisc(newfont.latex(), latex()));
467 setNumber(setMisc(newfont.number(), number()));
468 if (newfont.language() == language() && toggleall)
469 if (language() == document_language)
470 setLanguage(default_language);
472 setLanguage(document_language);
473 else if (newfont.language() != ignore_language)
474 setLanguage(newfont.language());
476 if (newfont.color() == color() && toggleall)
477 setColor(LColor::inherit); // toggle 'back'
478 else if (newfont.color() != LColor::ignore)
479 setColor(newfont.color());
483 /// Reduce font to fall back to template where possible
484 void LyXFont::reduce(LyXFont const & tmplt)
486 if (family() == tmplt.family())
487 setFamily(INHERIT_FAMILY);
488 if (series() == tmplt.series())
489 setSeries(INHERIT_SERIES);
490 if (shape() == tmplt.shape())
491 setShape(INHERIT_SHAPE);
492 if (size() == tmplt.size())
493 setSize(INHERIT_SIZE);
494 if (emph() == tmplt.emph())
496 if (underbar() == tmplt.underbar())
497 setUnderbar(INHERIT);
498 if (noun() == tmplt.noun())
500 if (latex() == tmplt.latex())
502 if (color() == tmplt.color())
503 setColor(LColor::inherit);
507 /// Realize font from a template
508 LyXFont & LyXFont::realize(LyXFont const & tmplt)
510 if (bits == inherit) {
515 if (bits.family == INHERIT_FAMILY) {
516 bits.family = tmplt.bits.family;
518 if (bits.series == INHERIT_SERIES) {
519 bits.series = tmplt.bits.series;
521 if (bits.shape == INHERIT_SHAPE) {
522 bits.shape = tmplt.bits.shape;
524 if (bits.size == INHERIT_SIZE) {
525 bits.size = tmplt.bits.size;
527 if (bits.emph == INHERIT) {
528 bits.emph = tmplt.bits.emph;
530 if (bits.underbar == INHERIT) {
531 bits.underbar = tmplt.bits.underbar;
533 if (bits.noun == INHERIT) {
534 bits.noun = tmplt.bits.noun;
536 if (bits.latex == INHERIT) {
537 bits.latex = tmplt.bits.latex;
539 if (bits.color == LColor::inherit) {
540 bits.color = tmplt.bits.color;
546 /// Is font resolved?
547 bool LyXFont::resolved() const
549 return (family() != INHERIT_FAMILY && series() != INHERIT_SERIES &&
550 shape() != INHERIT_SHAPE && size() != INHERIT_SIZE &&
551 emph() != INHERIT && underbar() != INHERIT &&
552 noun() != INHERIT && latex() != INHERIT &&
553 color() != LColor::inherit);
557 /// Build GUI description of font state
558 string const LyXFont::stateText(BufferParams * params) const
560 std::ostringstream ost;
561 if (family() != INHERIT_FAMILY)
562 ost << _(GUIFamilyNames[family()]) << ", ";
563 if (series() != INHERIT_SERIES)
564 ost << _(GUISeriesNames[series()]) << ", ";
565 if (shape() != INHERIT_SHAPE)
566 ost << _(GUIShapeNames[shape()]) << ", ";
567 if (size() != INHERIT_SIZE)
568 ost << _(GUISizeNames[size()]) << ", ";
569 if (color() != LColor::inherit)
570 ost << lcolor.getGUIName(color()) << ", ";
571 if (emph() != INHERIT)
572 ost << _("Emphasis ")
573 << _(GUIMiscNames[emph()]) << ", ";
574 if (underbar() != INHERIT)
575 ost << _("Underline ")
576 << _(GUIMiscNames[underbar()]) << ", ";
577 if (noun() != INHERIT)
578 ost << _("Noun ") << _(GUIMiscNames[noun()]) << ", ";
579 if (latex() != INHERIT)
580 ost << _("Latex ") << _(GUIMiscNames[latex()]) << ", ";
582 ost << _("Default") << ", ";
583 if (!params || (language() != params->language))
584 ost << _("Language: ") << _(language()->display()) << ", ";
586 ost << _(" Number ") << _(GUIMiscNames[number()]);
588 string buf(ost.str().c_str());
589 buf = strip(buf, ' ');
590 buf = strip(buf, ',');
595 // Set family according to lyx format string
596 LyXFont & LyXFont::setLyXFamily(string const & fam)
598 string const s = lowercase(fam);
601 while (s != LyXFamilyNames[i] && LyXFamilyNames[i] != "error") ++i;
602 if (s == LyXFamilyNames[i]) {
603 setFamily(LyXFont::FONT_FAMILY(i));
605 lyxerr << "LyXFont::setLyXFamily: Unknown family `"
606 << s << '\'' << endl;
611 // Set series according to lyx format string
612 LyXFont & LyXFont::setLyXSeries(string const & ser)
614 string const s = lowercase(ser);
617 while (s != LyXSeriesNames[i] && LyXSeriesNames[i] != "error") ++i;
618 if (s == LyXSeriesNames[i]) {
619 setSeries(LyXFont::FONT_SERIES(i));
621 lyxerr << "LyXFont::setLyXSeries: Unknown series `"
622 << s << '\'' << endl;
627 // Set shape according to lyx format string
628 LyXFont & LyXFont::setLyXShape(string const & sha)
630 string const s = lowercase(sha);
633 while (s != LyXShapeNames[i] && LyXShapeNames[i] != "error") ++i;
634 if (s == LyXShapeNames[i]) {
635 setShape(LyXFont::FONT_SHAPE(i));
637 lyxerr << "LyXFont::setLyXShape: Unknown shape `"
638 << s << '\'' << endl;
643 // Set size according to lyx format string
644 LyXFont & LyXFont::setLyXSize(string const & siz)
646 string const s = lowercase(siz);
648 while (s != LyXSizeNames[i] && LyXSizeNames[i] != "error") ++i;
649 if (s == LyXSizeNames[i]) {
650 setSize(LyXFont::FONT_SIZE(i));
652 lyxerr << "LyXFont::setLyXSize: Unknown size `"
653 << s << '\'' << endl;
658 // Set size according to lyx format string
659 LyXFont::FONT_MISC_STATE LyXFont::setLyXMisc(string const & siz)
661 string const s = lowercase(siz);
663 while (s != LyXMiscNames[i] && LyXMiscNames[i] != "error") ++i;
664 if (s == LyXMiscNames[i])
665 return FONT_MISC_STATE(i);
666 lyxerr << "LyXFont::setLyXMisc: Unknown misc flag `"
667 << s << '\'' << endl;
672 /// Sets color after LyX text format
673 LyXFont & LyXFont::setLyXColor(string const & col)
675 setColor(lcolor.getFromLyXName(col));
680 // Returns size in latex format
681 string const LyXFont::latexSize() const
683 return LaTeXSizeNames[size()];
687 // Read a font definition from given file in lyx format
689 LyXFont & LyXFont::lyxRead(LyXLex & lex)
692 bool finished = false;
693 while (!finished && lex.IsOK() && !error) {
695 string const tok = lowercase(lex.GetString());
699 } else if (tok == "endfont") {
701 } else if (tok == "family") {
703 string const ttok = lex.GetString();
705 } else if (tok == "series") {
707 string const ttok = lex.GetString();
709 } else if (tok == "shape") {
711 string const ttok = lex.GetString();
713 } else if (tok == "size") {
715 string const ttok = lex.GetString();
717 } else if (tok == "latex") {
719 string const ttok = lowercase(lex.GetString());
721 if (ttok == "no_latex") {
723 } else if (ttok == "latex") {
726 lex.printError("Illegal LaTeX type`$$Token'");
728 } else if (tok == "misc") {
730 string const ttok = lowercase(lex.GetString());
732 if (ttok == "no_bar") {
734 } else if (ttok == "no_emph") {
736 } else if (ttok == "no_noun") {
738 } else if (ttok == "emph") {
740 } else if (ttok == "underbar") {
742 } else if (ttok == "noun") {
745 lex.printError("Illegal misc type `$$Token´");
747 } else if (tok == "color") {
749 string const ttok = lex.GetString();
752 lex.printError("Unknown tag `$$Token'");
760 /// Writes the changes from this font to orgfont in .lyx format in file
761 void LyXFont::lyxWriteChanges(LyXFont const & orgfont, ostream & os) const
764 if (orgfont.family() != family()) {
765 os << "\\family " << LyXFamilyNames[family()] << " \n";
767 if (orgfont.series() != series()) {
768 os << "\\series " << LyXSeriesNames[series()] << " \n";
770 if (orgfont.shape() != shape()) {
771 os << "\\shape " << LyXShapeNames[shape()] << " \n";
773 if (orgfont.size() != size()) {
774 os << "\\size " << LyXSizeNames[size()] << " \n";
776 if (orgfont.emph() != emph()) {
777 os << "\\emph " << LyXMiscNames[emph()] << " \n";
779 if (orgfont.number() != number()) {
780 os << "\\numeric " << LyXMiscNames[number()] << " \n";
782 if (orgfont.underbar() != underbar()) {
783 // This is only for backwards compatibility
784 switch (underbar()) {
785 case OFF: os << "\\bar no \n"; break;
786 case ON: os << "\\bar under \n"; break;
787 case TOGGLE: lyxerr << "LyXFont::lyxWriteFontChanges: "
788 "TOGGLE should not appear here!"
791 case INHERIT: os << "\\bar default \n"; break;
792 case IGNORE: lyxerr << "LyXFont::lyxWriteFontChanges: "
793 "IGNORE should not appear here!"
798 if (orgfont.noun() != noun()) {
799 os << "\\noun " << LyXMiscNames[noun()] << " \n";
801 if (orgfont.latex() != latex()) {
802 // This is only for backwards compatibility
804 case OFF: os << "\\latex no_latex \n"; break;
805 case ON: os << "\\latex latex \n"; break;
806 case TOGGLE: lyxerr << "LyXFont::lyxWriteFontChanges: "
807 "TOGGLE should not appear here!"
810 case INHERIT: os << "\\latex default \n"; break;
811 case IGNORE: lyxerr << "LyXFont::lyxWriteFontChanges: "
812 "IGNORE should not appear here!"
817 if (orgfont.color() != color()) {
818 // To make us file compatible with older
819 // lyx versions we emit "default" instead
821 string col_str(lcolor.getLyXName(color()));
822 if (col_str == "inherit") col_str = "default";
823 os << "\\color " << col_str << "\n";
825 if (orgfont.language() != language()) {
827 os << "\\lang " << language()->lang() << "\n";
829 os << "\\lang unknown\n";
834 /// Writes the head of the LaTeX needed to impose this font
835 // Returns number of chars written.
836 int LyXFont::latexWriteStartChanges(ostream & os, LyXFont const & base,
837 LyXFont const & prev) const
842 if (language()->babel() != base.language()->babel() &&
843 language()->babel() != prev.language()->babel()) {
844 if (isRightToLeft() != prev.isRightToLeft()) {
845 if (isRightToLeft()) {
854 subst(lyxrc.language_command_local,
855 "$$lang", language()->babel());
857 count += tmp.length();
861 if (number() == ON && prev.number() != ON &&
862 language()->lang() == "hebrew") {
870 if (f.family() != INHERIT_FAMILY) {
872 << LaTeXFamilyNames[f.family()]
874 count += strlen(LaTeXFamilyNames[f.family()]) + 2;
875 env = true; //We have opened a new environment
877 if (f.series() != INHERIT_SERIES) {
879 << LaTeXSeriesNames[f.series()]
881 count += strlen(LaTeXSeriesNames[f.series()]) + 2;
882 env = true; //We have opened a new environment
884 if (f.shape() != INHERIT_SHAPE) {
886 << LaTeXShapeNames[f.shape()]
888 count += strlen(LaTeXShapeNames[f.shape()]) + 2;
889 env = true; //We have opened a new environment
891 if (f.color() != LColor::inherit && f.color() != LColor::ignore) {
893 << lcolor.getLaTeXName(f.color())
895 count += lcolor.getLaTeXName(f.color()).length() + 13;
896 env = true; //We have opened a new environment
898 if (f.emph() == ON) {
901 env = true; //We have opened a new environment
903 if (f.underbar() == ON) {
906 env = true; //We have opened a new environment
908 // \noun{} is a LyX special macro
909 if (f.noun() == ON) {
912 env = true; //We have opened a new environment
914 if (f.size() != INHERIT_SIZE) {
915 // If we didn't open an environment above, we open one here
921 << LaTeXSizeNames[f.size()]
923 count += strlen(LaTeXSizeNames[f.size()]) + 2;
929 /// Writes ending block of LaTeX needed to close use of this font
930 // Returns number of chars written
931 // This one corresponds to latexWriteStartChanges(). (Asger)
932 int LyXFont::latexWriteEndChanges(ostream & os, LyXFont const & base,
933 LyXFont const & next) const
938 LyXFont f = *this; // why do you need this?
939 f.reduce(base); // why isn't this just "reduce(base);" (Lgb)
940 // Because this function is const. Everything breaks if this
941 // method changes the font it represents. There is no speed penalty
942 // by using the temporary. (Asger)
945 if (f.family() != INHERIT_FAMILY) {
948 env = true; // Size change need not bother about closing env.
950 if (f.series() != INHERIT_SERIES) {
953 env = true; // Size change need not bother about closing env.
955 if (f.shape() != INHERIT_SHAPE) {
958 env = true; // Size change need not bother about closing env.
960 if (f.color() != LColor::inherit && f.color() != LColor::ignore) {
963 env = true; // Size change need not bother about closing env.
965 if (f.emph() == ON) {
968 env = true; // Size change need not bother about closing env.
970 if (f.underbar() == ON) {
973 env = true; // Size change need not bother about closing env.
975 if (f.noun() == ON) {
978 env = true; // Size change need not bother about closing env.
980 if (f.size() != INHERIT_SIZE) {
981 // We only have to close if only size changed
988 if (number() == ON && next.number() != ON &&
989 language()->lang() == "hebrew") {
994 if (language() != base.language() && language() != next.language()) {
1003 LColor::color LyXFont::realColor() const
1006 return LColor::latex;
1007 if (color() == LColor::none)
1008 return LColor::foreground;
1013 // Convert logical attributes to concrete shape attribute
1014 LyXFont::FONT_SHAPE LyXFont::realShape() const
1016 register FONT_SHAPE s = shape();
1025 s = SMALLCAPS_SHAPE;
1030 bool LyXFont::equalExceptLatex(LyXFont const & f) const
1033 f1.setLatex(f.latex());
1038 ostream & operator<<(ostream & o, LyXFont::FONT_MISC_STATE fms)
1040 return o << int(fms);