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
43 char const * GUIFamilyNames[6] =
44 { N_("Roman"), N_("Sans serif"), N_("Typewriter"), N_("Symbol"), N_("Inherit"),
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[6] =
67 { "roman", "sans", "typewriter", "symbol", "default", "error" };
69 char const * LyXSeriesNames[4] =
70 { "medium", "bold", "default", "error" };
72 char const * LyXShapeNames[6] =
73 { "up", "italic", "slanted", "smallcaps", "default", "error" };
75 char const * LyXSizeNames[14] =
76 { "tiny", "scriptsize", "footnotesize", "small", "normal", "large",
77 "larger", "largest", "huge", "giant",
78 "increase-error", "decrease-error", "default", "error" };
80 char const * LyXMiscNames[5] =
81 { "off", "on", "toggle", "default", "error" };
84 // Strings used to write LaTeX files
86 char const * LaTeXFamilyNames[6] =
87 { "textrm", "textsf", "texttt", "error1", "error2", "error3" };
89 char const * LaTeXSeriesNames[4] =
90 { "textmd", "textbf", "error4", "error5" };
92 char const * LaTeXShapeNames[6] =
93 { "textup", "textit", "textsl", "textsc", "error6", "error7" };
95 char const * LaTeXSizeNames[14] =
96 { "tiny", "scriptsize", "footnotesize", "small", "normalsize", "large",
97 "Large", "LARGE", "huge", "Huge", "error8", "error9", "error10", "error11" };
102 // Initialize static member
103 LyXFont::FontBits LyXFont::sane = {
117 // Initialize static member
118 LyXFont::FontBits LyXFont::inherit = {
132 // Initialize static member
133 LyXFont::FontBits LyXFont::ignore = {
148 bool LyXFont::FontBits::operator==(LyXFont::FontBits const & fb1) const
150 return fb1.family == family &&
151 fb1.series == series &&
152 fb1.shape == shape &&
154 fb1.color == color &&
156 fb1.underbar == underbar &&
159 fb1.latex == latex &&
161 fb1.number == number;
165 bool LyXFont::FontBits::operator!=(LyXFont::FontBits const & fb1) const
167 return !(fb1 == *this);
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)
201 LyXFont::FONT_MISC_STATE LyXFont::underbar() const
203 return bits.underbar;
208 LyXFont::FONT_MISC_STATE LyXFont::latex() const
215 LColor::color LyXFont::color() const
221 Language const * LyXFont::language() const
227 LyXFont::FONT_MISC_STATE LyXFont::number() const
233 bool LyXFont::isRightToLeft() const
235 return lang->RightToLeft();
239 bool LyXFont::isVisibleRightToLeft() const
241 return (lang->RightToLeft() &&
249 LyXFont & LyXFont::setFamily(LyXFont::FONT_FAMILY f)
256 LyXFont & LyXFont::setSeries(LyXFont::FONT_SERIES s)
263 LyXFont & LyXFont::setShape(LyXFont::FONT_SHAPE s)
270 LyXFont & LyXFont::setSize(LyXFont::FONT_SIZE s)
277 LyXFont & LyXFont::setEmph(LyXFont::FONT_MISC_STATE e)
284 LyXFont & LyXFont::setUnderbar(LyXFont::FONT_MISC_STATE u)
291 LyXFont & LyXFont::setNoun(LyXFont::FONT_MISC_STATE n)
299 LyXFont & LyXFont::setLatex(LyXFont::FONT_MISC_STATE l)
307 LyXFont & LyXFont::setColor(LColor::color c)
314 LyXFont & LyXFont::setLanguage(Language const * l)
321 LyXFont & LyXFont::setNumber(LyXFont::FONT_MISC_STATE n)
328 /// Decreases font size by one
329 LyXFont & LyXFont::decSize()
332 case SIZE_HUGER: setSize(SIZE_HUGE); break;
333 case SIZE_HUGE: setSize(SIZE_LARGEST); break;
334 case SIZE_LARGEST: setSize(SIZE_LARGER); break;
335 case SIZE_LARGER: setSize(SIZE_LARGE); break;
336 case SIZE_LARGE: setSize(SIZE_NORMAL); break;
337 case SIZE_NORMAL: setSize(SIZE_SMALL); break;
338 case SIZE_SMALL: setSize(SIZE_FOOTNOTE); break;
339 case SIZE_FOOTNOTE: setSize(SIZE_SCRIPT); break;
340 case SIZE_SCRIPT: setSize(SIZE_TINY); break;
341 case SIZE_TINY: break;
343 lyxerr << "Can't LyXFont::decSize on INCREASE_SIZE" << endl;
346 lyxerr <<"Can't LyXFont::decSize on DECREASE_SIZE" << endl;
349 lyxerr <<"Can't LyXFont::decSize on INHERIT_SIZE" << endl;
352 lyxerr <<"Can't LyXFont::decSize on IGNORE_SIZE" << endl;
359 /// Increases font size by one
360 LyXFont & LyXFont::incSize()
363 case SIZE_HUGER: break;
364 case SIZE_HUGE: setSize(SIZE_HUGER); break;
365 case SIZE_LARGEST: setSize(SIZE_HUGE); break;
366 case SIZE_LARGER: setSize(SIZE_LARGEST); break;
367 case SIZE_LARGE: setSize(SIZE_LARGER); break;
368 case SIZE_NORMAL: setSize(SIZE_LARGE); break;
369 case SIZE_SMALL: setSize(SIZE_NORMAL); break;
370 case SIZE_FOOTNOTE: setSize(SIZE_SMALL); break;
371 case SIZE_SCRIPT: setSize(SIZE_FOOTNOTE); break;
372 case SIZE_TINY: setSize(SIZE_SCRIPT); break;
374 lyxerr <<"Can't LyXFont::incSize on INCREASE_SIZE" << endl;
377 lyxerr <<"Can't LyXFont::incSize on DECREASE_SIZE" << endl;
380 lyxerr <<"Can't LyXFont::incSize on INHERIT_SIZE" << endl;
383 lyxerr <<"Can't LyXFont::incSize on IGNORE_SIZE" << endl;
390 /// Updates a misc setting according to request
391 LyXFont::FONT_MISC_STATE LyXFont::setMisc(FONT_MISC_STATE newfont,
394 if (newfont == TOGGLE) {
400 lyxerr <<"LyXFont::setMisc: Need state"
401 " ON or OFF to toggle. Setting to ON" << endl;
404 } else if (newfont == IGNORE)
411 /// Updates font settings according to request
412 void LyXFont::update(LyXFont const & newfont,
413 Language const * document_language, bool toggleall)
415 if (newfont.family() == family() && toggleall)
416 setFamily(INHERIT_FAMILY); // toggle 'back'
417 else if (newfont.family() != IGNORE_FAMILY)
418 setFamily(newfont.family());
419 // else it's IGNORE_SHAPE
421 // "Old" behaviour: "Setting" bold will toggle bold on/off.
422 switch (newfont.series()) {
425 if (series() == BOLD_SERIES && toggleall)
426 setSeries(MEDIUM_SERIES);
428 setSeries(BOLD_SERIES);
432 setSeries(newfont.series());
438 if (newfont.shape() == shape() && toggleall)
439 setShape(INHERIT_SHAPE); // toggle 'back'
440 else if (newfont.shape() != IGNORE_SHAPE)
441 setShape(newfont.shape());
442 // else it's IGNORE_SHAPE
444 if (newfont.size() != IGNORE_SIZE) {
445 if (newfont.size() == INCREASE_SIZE)
447 else if (newfont.size() == DECREASE_SIZE)
450 setSize(newfont.size());
453 setEmph(setMisc(newfont.emph(), emph()));
454 setUnderbar(setMisc(newfont.underbar(), underbar()));
455 setNoun(setMisc(newfont.noun(), noun()));
457 setLatex(setMisc(newfont.latex(), latex()));
460 setNumber(setMisc(newfont.number(), number()));
461 if (newfont.language() == language() && toggleall)
462 if (language() == document_language)
463 setLanguage(default_language);
465 setLanguage(document_language);
466 else if (newfont.language() != ignore_language)
467 setLanguage(newfont.language());
469 if (newfont.color() == color() && toggleall)
470 setColor(LColor::inherit); // toggle 'back'
471 else if (newfont.color() != LColor::ignore)
472 setColor(newfont.color());
476 /// Reduce font to fall back to template where possible
477 void LyXFont::reduce(LyXFont const & tmplt)
479 if (family() == tmplt.family())
480 setFamily(INHERIT_FAMILY);
481 if (series() == tmplt.series())
482 setSeries(INHERIT_SERIES);
483 if (shape() == tmplt.shape())
484 setShape(INHERIT_SHAPE);
485 if (size() == tmplt.size())
486 setSize(INHERIT_SIZE);
487 if (emph() == tmplt.emph())
489 if (underbar() == tmplt.underbar())
490 setUnderbar(INHERIT);
491 if (noun() == tmplt.noun())
494 if (latex() == tmplt.latex())
497 if (color() == tmplt.color())
498 setColor(LColor::inherit);
502 /// Realize font from a template
503 LyXFont & LyXFont::realize(LyXFont const & tmplt)
505 if (bits == inherit) {
510 if (bits.family == INHERIT_FAMILY) {
511 bits.family = tmplt.bits.family;
513 if (bits.series == INHERIT_SERIES) {
514 bits.series = tmplt.bits.series;
516 if (bits.shape == INHERIT_SHAPE) {
517 bits.shape = tmplt.bits.shape;
519 if (bits.size == INHERIT_SIZE) {
520 bits.size = tmplt.bits.size;
522 if (bits.emph == INHERIT) {
523 bits.emph = tmplt.bits.emph;
525 if (bits.underbar == INHERIT) {
526 bits.underbar = tmplt.bits.underbar;
528 if (bits.noun == INHERIT) {
529 bits.noun = tmplt.bits.noun;
532 if (bits.latex == INHERIT) {
533 bits.latex = tmplt.bits.latex;
536 if (bits.color == LColor::inherit) {
537 bits.color = tmplt.bits.color;
543 /// Is font resolved?
544 bool LyXFont::resolved() const
546 return (family() != INHERIT_FAMILY && series() != INHERIT_SERIES &&
547 shape() != INHERIT_SHAPE && size() != INHERIT_SIZE &&
548 emph() != INHERIT && underbar() != INHERIT &&
551 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()]) << ", ";
580 if (latex() != INHERIT)
581 ost << _("Latex ") << _(GUIMiscNames[latex()]) << ", ";
584 ost << _("Default") << ", ";
585 if (!params || (language() != params->language))
586 ost << _("Language: ") << _(language()->display()) << ", ";
588 ost << _(" Number ") << _(GUIMiscNames[number()]);
590 string buf(ost.str().c_str());
591 buf = strip(buf, ' ');
592 buf = strip(buf, ',');
597 // Set family according to lyx format string
598 LyXFont & LyXFont::setLyXFamily(string const & fam)
600 string const s = lowercase(fam);
603 while (s != LyXFamilyNames[i] && LyXFamilyNames[i] != "error") ++i;
604 if (s == LyXFamilyNames[i]) {
605 setFamily(LyXFont::FONT_FAMILY(i));
607 lyxerr << "LyXFont::setLyXFamily: Unknown family `"
608 << s << '\'' << endl;
613 // Set series according to lyx format string
614 LyXFont & LyXFont::setLyXSeries(string const & ser)
616 string const s = lowercase(ser);
619 while (s != LyXSeriesNames[i] && LyXSeriesNames[i] != "error") ++i;
620 if (s == LyXSeriesNames[i]) {
621 setSeries(LyXFont::FONT_SERIES(i));
623 lyxerr << "LyXFont::setLyXSeries: Unknown series `"
624 << s << '\'' << endl;
629 // Set shape according to lyx format string
630 LyXFont & LyXFont::setLyXShape(string const & sha)
632 string const s = lowercase(sha);
635 while (s != LyXShapeNames[i] && LyXShapeNames[i] != "error") ++i;
636 if (s == LyXShapeNames[i]) {
637 setShape(LyXFont::FONT_SHAPE(i));
639 lyxerr << "LyXFont::setLyXShape: Unknown shape `"
640 << s << '\'' << endl;
645 // Set size according to lyx format string
646 LyXFont & LyXFont::setLyXSize(string const & siz)
648 string const s = lowercase(siz);
650 while (s != LyXSizeNames[i] && LyXSizeNames[i] != "error") ++i;
651 if (s == LyXSizeNames[i]) {
652 setSize(LyXFont::FONT_SIZE(i));
654 lyxerr << "LyXFont::setLyXSize: Unknown size `"
655 << s << '\'' << endl;
660 // Set size according to lyx format string
661 LyXFont::FONT_MISC_STATE LyXFont::setLyXMisc(string const & siz)
663 string const s = lowercase(siz);
665 while (s != LyXMiscNames[i] && LyXMiscNames[i] != "error") ++i;
666 if (s == LyXMiscNames[i])
667 return FONT_MISC_STATE(i);
668 lyxerr << "LyXFont::setLyXMisc: Unknown misc flag `"
669 << s << '\'' << endl;
674 /// Sets color after LyX text format
675 LyXFont & LyXFont::setLyXColor(string const & col)
677 setColor(lcolor.getFromLyXName(col));
682 // Returns size in latex format
683 string const LyXFont::latexSize() const
685 return LaTeXSizeNames[size()];
689 // Read a font definition from given file in lyx format
691 LyXFont & LyXFont::lyxRead(LyXLex & lex)
694 bool finished = false;
695 while (!finished && lex.IsOK() && !error) {
697 string const tok = lowercase(lex.GetString());
701 } else if (tok == "endfont") {
703 } else if (tok == "family") {
705 string const ttok = lex.GetString();
707 } else if (tok == "series") {
709 string const ttok = lex.GetString();
711 } else if (tok == "shape") {
713 string const ttok = lex.GetString();
715 } else if (tok == "size") {
717 string const ttok = lex.GetString();
720 } else if (tok == "latex") {
722 string const ttok = lowercase(lex.GetString());
724 if (ttok == "no_latex") {
726 } else if (ttok == "latex") {
729 lex.printError("Illegal LaTeX type`$$Token'");
732 } else if (tok == "misc") {
734 string const ttok = lowercase(lex.GetString());
736 if (ttok == "no_bar") {
738 } else if (ttok == "no_emph") {
740 } else if (ttok == "no_noun") {
742 } else if (ttok == "emph") {
744 } else if (ttok == "underbar") {
746 } else if (ttok == "noun") {
749 lex.printError("Illegal misc type `$$Token´");
751 } else if (tok == "color") {
753 string const ttok = lex.GetString();
756 lex.printError("Unknown tag `$$Token'");
764 /// Writes the changes from this font to orgfont in .lyx format in file
765 void LyXFont::lyxWriteChanges(LyXFont const & orgfont, ostream & os) const
768 if (orgfont.family() != family()) {
769 os << "\\family " << LyXFamilyNames[family()] << " \n";
771 if (orgfont.series() != series()) {
772 os << "\\series " << LyXSeriesNames[series()] << " \n";
774 if (orgfont.shape() != shape()) {
775 os << "\\shape " << LyXShapeNames[shape()] << " \n";
777 if (orgfont.size() != size()) {
778 os << "\\size " << LyXSizeNames[size()] << " \n";
780 if (orgfont.emph() != emph()) {
781 os << "\\emph " << LyXMiscNames[emph()] << " \n";
783 if (orgfont.number() != number()) {
784 os << "\\numeric " << LyXMiscNames[number()] << " \n";
786 if (orgfont.underbar() != underbar()) {
787 // This is only for backwards compatibility
788 switch (underbar()) {
789 case OFF: os << "\\bar no \n"; break;
790 case ON: os << "\\bar under \n"; break;
791 case TOGGLE: lyxerr << "LyXFont::lyxWriteFontChanges: "
792 "TOGGLE should not appear here!"
795 case INHERIT: os << "\\bar default \n"; break;
796 case IGNORE: lyxerr << "LyXFont::lyxWriteFontChanges: "
797 "IGNORE should not appear here!"
802 if (orgfont.noun() != noun()) {
803 os << "\\noun " << LyXMiscNames[noun()] << " \n";
806 if (orgfont.latex() != latex()) {
807 // This is only for backwards compatibility
809 case OFF: os << "\\latex no_latex \n"; break;
810 case ON: os << "\\latex latex \n"; break;
811 case TOGGLE: lyxerr << "LyXFont::lyxWriteFontChanges: "
812 "TOGGLE should not appear here!"
815 case INHERIT: os << "\\latex default \n"; break;
816 case IGNORE: lyxerr << "LyXFont::lyxWriteFontChanges: "
817 "IGNORE should not appear here!"
823 if (orgfont.color() != color()) {
824 // To make us file compatible with older
825 // lyx versions we emit "default" instead
827 string col_str(lcolor.getLyXName(color()));
828 if (col_str == "inherit") col_str = "default";
829 os << "\\color " << col_str << "\n";
831 if (orgfont.language() != language()) {
833 os << "\\lang " << language()->lang() << "\n";
835 os << "\\lang unknown\n";
840 /// Writes the head of the LaTeX needed to impose this font
841 // Returns number of chars written.
842 int LyXFont::latexWriteStartChanges(ostream & os, LyXFont const & base,
843 LyXFont const & prev) const
848 if (language()->babel() != base.language()->babel() &&
849 language()->babel() != prev.language()->babel()) {
850 if (isRightToLeft() != prev.isRightToLeft()) {
851 if (isRightToLeft()) {
860 subst(lyxrc.language_command_local,
861 "$$lang", language()->babel());
863 count += tmp.length();
867 if (number() == ON && prev.number() != ON &&
868 language()->lang() == "hebrew") {
876 if (f.family() != INHERIT_FAMILY) {
878 << LaTeXFamilyNames[f.family()]
880 count += strlen(LaTeXFamilyNames[f.family()]) + 2;
881 env = true; //We have opened a new environment
883 if (f.series() != INHERIT_SERIES) {
885 << LaTeXSeriesNames[f.series()]
887 count += strlen(LaTeXSeriesNames[f.series()]) + 2;
888 env = true; //We have opened a new environment
890 if (f.shape() != INHERIT_SHAPE) {
892 << LaTeXShapeNames[f.shape()]
894 count += strlen(LaTeXShapeNames[f.shape()]) + 2;
895 env = true; //We have opened a new environment
897 if (f.color() != LColor::inherit && f.color() != LColor::ignore) {
899 << lcolor.getLaTeXName(f.color())
901 count += lcolor.getLaTeXName(f.color()).length() + 13;
902 env = true; //We have opened a new environment
904 if (f.emph() == ON) {
907 env = true; //We have opened a new environment
909 if (f.underbar() == ON) {
912 env = true; //We have opened a new environment
914 // \noun{} is a LyX special macro
915 if (f.noun() == ON) {
918 env = true; //We have opened a new environment
920 if (f.size() != INHERIT_SIZE) {
921 // If we didn't open an environment above, we open one here
927 << LaTeXSizeNames[f.size()]
929 count += strlen(LaTeXSizeNames[f.size()]) + 2;
935 /// Writes ending block of LaTeX needed to close use of this font
936 // Returns number of chars written
937 // This one corresponds to latexWriteStartChanges(). (Asger)
938 int LyXFont::latexWriteEndChanges(ostream & os, LyXFont const & base,
939 LyXFont const & next) const
944 LyXFont f = *this; // why do you need this?
945 f.reduce(base); // why isn't this just "reduce(base);" (Lgb)
946 // Because this function is const. Everything breaks if this
947 // method changes the font it represents. There is no speed penalty
948 // by using the temporary. (Asger)
951 if (f.family() != INHERIT_FAMILY) {
954 env = true; // Size change need not bother about closing env.
956 if (f.series() != INHERIT_SERIES) {
959 env = true; // Size change need not bother about closing env.
961 if (f.shape() != INHERIT_SHAPE) {
964 env = true; // Size change need not bother about closing env.
966 if (f.color() != LColor::inherit && f.color() != LColor::ignore) {
969 env = true; // Size change need not bother about closing env.
971 if (f.emph() == ON) {
974 env = true; // Size change need not bother about closing env.
976 if (f.underbar() == ON) {
979 env = true; // Size change need not bother about closing env.
981 if (f.noun() == ON) {
984 env = true; // Size change need not bother about closing env.
986 if (f.size() != INHERIT_SIZE) {
987 // We only have to close if only size changed
994 if (number() == ON && next.number() != ON &&
995 language()->lang() == "hebrew") {
1000 if (language() != base.language() && language() != next.language()) {
1009 LColor::color LyXFont::realColor() const
1013 return LColor::latex;
1015 if (color() == LColor::none)
1016 return LColor::foreground;
1021 // Convert logical attributes to concrete shape attribute
1022 LyXFont::FONT_SHAPE LyXFont::realShape() const
1024 register FONT_SHAPE s = shape();
1033 s = SMALLCAPS_SHAPE;
1038 bool LyXFont::equalExceptLatex(LyXFont const & f) const
1042 f1.setLatex(f.latex());
1048 ostream & operator<<(ostream & o, LyXFont::FONT_MISC_STATE fms)
1050 return o << int(fms);