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 * ====================================================== */
15 #pragma implementation "lyxfont.h"
25 #include "FontLoader.h"
26 #include "support/lstrings.h"
27 #include "bufferparams.h" // stateText
37 char const * GUIFamilyNames[6] =
38 { N_("Roman"), N_("Sans serif"), N_("Typewriter"), N_("Symbol"), N_("Inherit"),
42 char const * GUISeriesNames[4] =
43 { N_("Medium"), N_("Bold"), N_("Inherit"), N_("Ignore") };
46 char const * GUIShapeNames[6] =
47 { N_("Upright"), N_("Italic"), N_("Slanted"), N_("Smallcaps"), N_("Inherit"),
51 char const * GUISizeNames[14] =
52 { N_("Tiny"), N_("Smallest"), N_("Smaller"), N_("Small"), N_("Normal"), N_("Large"),
53 N_("Larger"), N_("Largest"), N_("Huge"), N_("Huger"), N_("Increase"), N_("Decrease"),
54 N_("Inherit"), N_("Ignore") };
57 char const * GUIMiscNames[5] =
58 { N_("Off"), N_("On"), N_("Toggle"), N_("Inherit"), N_("Ignore") };
62 // Strings used to read and write .lyx format files
65 char const * LyXFamilyNames[6] =
66 { "roman", "sans", "typewriter", "symbol", "default", "error" };
69 char const * LyXSeriesNames[4] =
70 { "medium", "bold", "default", "error" };
73 char const * LyXShapeNames[6] =
74 { "up", "italic", "slanted", "smallcaps", "default", "error" };
77 char const * LyXSizeNames[14] =
78 { "tiny", "scriptsize", "footnotesize", "small", "normal", "large",
79 "larger", "largest", "huge", "giant",
80 "increase-error", "decrease-error", "default", "error" };
83 char const * LyXMiscNames[5] =
84 { "off", "on", "toggle", "default", "error" };
87 // Strings used to write LaTeX files
90 char const * LaTeXFamilyNames[6] =
91 { "textrm", "textsf", "texttt", "error1", "error2", "error3" };
94 char const * LaTeXSeriesNames[4] =
95 { "textmd", "textbf", "error4", "error5" };
98 char const * LaTeXShapeNames[6] =
99 { "textup", "textit", "textsl", "textsc", "error6", "error7" };
102 char const * LaTeXSizeNames[14] =
103 { "tiny", "scriptsize", "footnotesize", "small", "normalsize", "large",
104 "Large", "LARGE", "huge", "Huge", "error8", "error9", "error10", "error11" };
107 LyXFont::FontBits LyXFont::sane = {
118 LyXFont::FontBits LyXFont::inherit = {
129 LyXFont::FontBits LyXFont::ignore = {
141 bool LyXFont::FontBits::operator==(LyXFont::FontBits const & fb1) const
143 return fb1.family == family &&
144 fb1.series == series &&
145 fb1.shape == shape &&
147 fb1.color == color &&
149 fb1.underbar == underbar &&
155 bool LyXFont::FontBits::operator!=(LyXFont::FontBits const & fb1) const
157 return !(fb1 == *this);
161 /// Decreases font size by one
162 LyXFont & LyXFont::decSize()
165 case SIZE_HUGER: setSize(SIZE_HUGE); break;
166 case SIZE_HUGE: setSize(SIZE_LARGEST); break;
167 case SIZE_LARGEST: setSize(SIZE_LARGER); break;
168 case SIZE_LARGER: setSize(SIZE_LARGE); break;
169 case SIZE_LARGE: setSize(SIZE_NORMAL); break;
170 case SIZE_NORMAL: setSize(SIZE_SMALL); break;
171 case SIZE_SMALL: setSize(SIZE_FOOTNOTE); break;
172 case SIZE_FOOTNOTE: setSize(SIZE_SCRIPT); break;
173 case SIZE_SCRIPT: setSize(SIZE_TINY); break;
174 case SIZE_TINY: break;
176 lyxerr << "Can't LyXFont::decSize on INCREASE_SIZE" << endl;
179 lyxerr <<"Can't LyXFont::decSize on DECREASE_SIZE" << endl;
182 lyxerr <<"Can't LyXFont::decSize on INHERIT_SIZE" << endl;
185 lyxerr <<"Can't LyXFont::decSize on IGNORE_SIZE" << endl;
192 /// Increases font size by one
193 LyXFont & LyXFont::incSize()
196 case SIZE_HUGER: break;
197 case SIZE_HUGE: setSize(SIZE_HUGER); break;
198 case SIZE_LARGEST: setSize(SIZE_HUGE); break;
199 case SIZE_LARGER: setSize(SIZE_LARGEST); break;
200 case SIZE_LARGE: setSize(SIZE_LARGER); break;
201 case SIZE_NORMAL: setSize(SIZE_LARGE); break;
202 case SIZE_SMALL: setSize(SIZE_NORMAL); break;
203 case SIZE_FOOTNOTE: setSize(SIZE_SMALL); break;
204 case SIZE_SCRIPT: setSize(SIZE_FOOTNOTE); break;
205 case SIZE_TINY: setSize(SIZE_SCRIPT); break;
207 lyxerr <<"Can't LyXFont::incSize on INCREASE_SIZE" << endl;
210 lyxerr <<"Can't LyXFont::incSize on DECREASE_SIZE" << endl;
213 lyxerr <<"Can't LyXFont::incSize on INHERIT_SIZE" << endl;
216 lyxerr <<"Can't LyXFont::incSize on IGNORE_SIZE" << endl;
223 /// Updates a misc setting according to request
224 LyXFont::FONT_MISC_STATE LyXFont::setMisc(FONT_MISC_STATE newfont,
227 if (newfont == TOGGLE) {
233 lyxerr <<"LyXFont::setMisc: Need state"
234 " ON or OFF to toggle. Setting to ON" << endl;
237 } else if (newfont == IGNORE)
244 /// Updates font settings according to request
245 void LyXFont::update(LyXFont const & newfont,
246 Language const * document_language, bool toggleall)
248 if (newfont.family() == family() && toggleall)
249 setFamily(INHERIT_FAMILY); // toggle 'back'
250 else if (newfont.family() != IGNORE_FAMILY)
251 setFamily(newfont.family());
252 // else it's IGNORE_SHAPE
254 // "Old" behaviour: "Setting" bold will toggle bold on/off.
255 switch (newfont.series()) {
258 if (series() == BOLD_SERIES && toggleall)
259 setSeries(MEDIUM_SERIES);
261 setSeries(BOLD_SERIES);
265 setSeries(newfont.series());
271 if (newfont.shape() == shape() && toggleall)
272 setShape(INHERIT_SHAPE); // toggle 'back'
273 else if (newfont.shape() != IGNORE_SHAPE)
274 setShape(newfont.shape());
275 // else it's IGNORE_SHAPE
277 if (newfont.size() != IGNORE_SIZE) {
278 if (newfont.size() == INCREASE_SIZE)
280 else if (newfont.size() == DECREASE_SIZE)
282 else if (newfont.size() == size() && toggleall)
283 setSize(INHERIT_SIZE); // toggle 'back'
285 setSize(newfont.size());
288 setEmph(setMisc(newfont.emph(), emph()));
289 setUnderbar(setMisc(newfont.underbar(), underbar()));
290 setNoun(setMisc(newfont.noun(), noun()));
291 setLatex(setMisc(newfont.latex(), latex()));
293 setNumber(setMisc(newfont.number(), number()));
294 if (newfont.language() == language() && toggleall)
295 if (language() == document_language)
296 setLanguage(default_language);
298 setLanguage(document_language);
299 else if (newfont.language() != ignore_language)
300 setLanguage(newfont.language());
302 if (newfont.color() == color() && toggleall)
303 setColor(LColor::inherit); // toggle 'back'
304 else if (newfont.color() != LColor::ignore)
305 setColor(newfont.color());
309 /// Reduce font to fall back to template where possible
310 void LyXFont::reduce(LyXFont const & tmplt)
312 if (family() == tmplt.family())
313 setFamily(INHERIT_FAMILY);
314 if (series() == tmplt.series())
315 setSeries(INHERIT_SERIES);
316 if (shape() == tmplt.shape())
317 setShape(INHERIT_SHAPE);
318 if (size() == tmplt.size())
319 setSize(INHERIT_SIZE);
320 if (emph() == tmplt.emph())
322 if (underbar() == tmplt.underbar())
323 setUnderbar(INHERIT);
324 if (noun() == tmplt.noun())
326 if (latex() == tmplt.latex())
328 if (color() == tmplt.color())
329 setColor(LColor::inherit);
333 /// Realize font from a template
334 LyXFont & LyXFont::realize(LyXFont const & tmplt)
336 if (bits == inherit) {
341 if (bits.family == INHERIT_FAMILY) {
342 bits.family = tmplt.bits.family;
344 if (bits.series == INHERIT_SERIES) {
345 bits.series = tmplt.bits.series;
347 if (bits.shape == INHERIT_SHAPE) {
348 bits.shape = tmplt.bits.shape;
350 if (bits.size == INHERIT_SIZE) {
351 bits.size = tmplt.bits.size;
353 if (bits.emph == INHERIT) {
354 bits.emph = tmplt.bits.emph;
356 if (bits.underbar == INHERIT) {
357 bits.underbar = tmplt.bits.underbar;
359 if (bits.noun == INHERIT) {
360 bits.noun = tmplt.bits.noun;
362 if (bits.latex == INHERIT) {
363 bits.latex = tmplt.bits.latex;
365 if (bits.color == LColor::inherit) {
366 bits.color = tmplt.bits.color;
373 /// Is font resolved?
374 bool LyXFont::resolved() const
376 return (family() != INHERIT_FAMILY && series() != INHERIT_SERIES &&
377 shape() != INHERIT_SHAPE && size() != INHERIT_SIZE &&
378 emph() != INHERIT && underbar() != INHERIT &&
379 noun() != INHERIT && latex() != INHERIT &&
380 color() != LColor::inherit);
384 /// Build GUI description of font state
385 string const LyXFont::stateText(BufferParams * params) const
387 std::ostringstream ost;
388 if (family() != INHERIT_FAMILY)
389 ost << _(GUIFamilyNames[family()]) << ", ";
390 if (series() != INHERIT_SERIES)
391 ost << _(GUISeriesNames[series()]) << ", ";
392 if (shape() != INHERIT_SHAPE)
393 ost << _(GUIShapeNames[shape()]) << ", ";
394 if (size() != INHERIT_SIZE)
395 ost << _(GUISizeNames[size()]) << ", ";
396 if (color() != LColor::inherit)
397 ost << lcolor.getGUIName(color()) << ", ";
398 if (emph() != INHERIT)
399 ost << _("Emphasis ")
400 << _(GUIMiscNames[emph()]) << ", ";
401 if (underbar() != INHERIT)
402 ost << _("Underline ")
403 << _(GUIMiscNames[underbar()]) << ", ";
404 if (noun() != INHERIT)
405 ost << _("Noun ") << _(GUIMiscNames[noun()]) << ", ";
406 if (latex() != INHERIT)
407 ost << _("Latex ") << _(GUIMiscNames[latex()]) << ", ";
409 ost << _("Default") << ", ";
410 if (!params || (language() != params->language))
411 ost << _("Language: ") << _(language()->display()) << ", ";
413 ost << _(" Number ") << _(GUIMiscNames[number()]);
415 string buf(ost.str().c_str());
416 buf = strip(buf, ' ');
417 buf = strip(buf, ',');
422 // Set family according to lyx format string
423 LyXFont & LyXFont::setLyXFamily(string const & fam)
425 string s = lowercase(fam);
428 while (s != LyXFamilyNames[i] && LyXFamilyNames[i] != "error") ++i;
429 if (s == LyXFamilyNames[i]) {
430 setFamily(LyXFont::FONT_FAMILY(i));
432 lyxerr << "LyXFont::setLyXFamily: Unknown family `"
433 << s << '\'' << endl;
438 // Set series according to lyx format string
439 LyXFont & LyXFont::setLyXSeries(string const & ser)
441 string s = lowercase(ser);
444 while (s != LyXSeriesNames[i] && LyXSeriesNames[i] != "error") ++i;
445 if (s == LyXSeriesNames[i]) {
446 setSeries(LyXFont::FONT_SERIES(i));
448 lyxerr << "LyXFont::setLyXSeries: Unknown series `"
449 << s << '\'' << endl;
454 // Set shape according to lyx format string
455 LyXFont & LyXFont::setLyXShape(string const & sha)
457 string s = lowercase(sha);
460 while (s != LyXShapeNames[i] && LyXShapeNames[i] != "error") ++i;
461 if (s == LyXShapeNames[i]) {
462 setShape(LyXFont::FONT_SHAPE(i));
464 lyxerr << "LyXFont::setLyXShape: Unknown shape `"
465 << s << '\'' << endl;
470 // Set size according to lyx format string
471 LyXFont & LyXFont::setLyXSize(string const & siz)
473 string s = lowercase(siz);
475 while (s != LyXSizeNames[i] && LyXSizeNames[i] != "error") ++i;
476 if (s == LyXSizeNames[i]) {
477 setSize(LyXFont::FONT_SIZE(i));
479 lyxerr << "LyXFont::setLyXSize: Unknown size `"
480 << s << '\'' << endl;
485 // Set size according to lyx format string
486 LyXFont::FONT_MISC_STATE LyXFont::setLyXMisc(string const & siz)
488 string s = lowercase(siz);
490 while (s != LyXMiscNames[i] && LyXMiscNames[i] != "error") ++i;
491 if (s == LyXMiscNames[i])
492 return FONT_MISC_STATE(i);
493 lyxerr << "LyXFont::setLyXMisc: Unknown misc flag `"
494 << s << '\'' << endl;
499 /// Sets color after LyX text format
500 LyXFont & LyXFont::setLyXColor(string const & col)
502 setColor(lcolor.getFromLyXName(col));
508 /// Sets size after GUI name
509 LyXFont & LyXFont::setGUISize(string const & siz)
511 // CHECK this might be wrong.
513 // this is how it was how it was done in the lyx repository...
514 // but this does not make sense.
515 setColor(lcolor.getFromGUIName(siz));
521 // Returns size in latex format
522 string const LyXFont::latexSize() const
524 return LaTeXSizeNames[size()];
528 // Read a font definition from given file in lyx format
530 LyXFont & LyXFont::lyxRead(LyXLex & lex)
533 bool finished = false;
534 while (!finished && lex.IsOK() && !error) {
536 string tok = lowercase(lex.GetString());
540 } else if (tok == "endfont") {
542 } else if (tok == "family") {
544 string tok = lex.GetString();
546 } else if (tok == "series") {
548 string tok = lex.GetString();
550 } else if (tok == "shape") {
552 string tok = lex.GetString();
554 } else if (tok == "size") {
556 string tok = lex.GetString();
558 } else if (tok == "latex") {
560 string tok = lowercase(lex.GetString());
562 if (tok == "no_latex") {
564 } else if (tok == "latex") {
567 lex.printError("Illegal LaTeX type`$$Token'");
569 } else if (tok == "misc") {
571 string tok = lowercase(lex.GetString());
573 if (tok == "no_bar") {
575 } else if (tok == "no_emph") {
577 } else if (tok == "no_noun") {
579 } else if (tok == "emph") {
581 } else if (tok == "underbar") {
583 } else if (tok == "noun") {
586 lex.printError("Illegal misc type `$$Token´");
588 } else if (tok == "color") {
590 string tok = lex.GetString();
593 lex.printError("Unknown tag `$$Token'");
601 /// Writes the changes from this font to orgfont in .lyx format in file
602 void LyXFont::lyxWriteChanges(LyXFont const & orgfont, ostream & os) const
605 if (orgfont.family() != family()) {
606 os << "\\family " << LyXFamilyNames[family()] << " \n";
608 if (orgfont.series() != series()) {
609 os << "\\series " << LyXSeriesNames[series()] << " \n";
611 if (orgfont.shape() != shape()) {
612 os << "\\shape " << LyXShapeNames[shape()] << " \n";
614 if (orgfont.size() != size()) {
615 os << "\\size " << LyXSizeNames[size()] << " \n";
617 if (orgfont.emph() != emph()) {
618 os << "\\emph " << LyXMiscNames[emph()] << " \n";
620 if (orgfont.number() != number()) {
621 os << "\\numeric " << LyXMiscNames[number()] << " \n";
623 if (orgfont.underbar() != underbar()) {
624 // This is only for backwards compatibility
625 switch (underbar()) {
626 case OFF: os << "\\bar no \n"; break;
627 case ON: os << "\\bar under \n"; break;
628 case TOGGLE: lyxerr << "LyXFont::lyxWriteFontChanges: "
629 "TOGGLE should not appear here!"
632 case INHERIT: os << "\\bar default \n"; break;
633 case IGNORE: lyxerr << "LyXFont::lyxWriteFontChanges: "
634 "IGNORE should not appear here!"
639 if (orgfont.noun() != noun()) {
640 os << "\\noun " << LyXMiscNames[noun()] << " \n";
642 if (orgfont.latex() != latex()) {
643 // This is only for backwards compatibility
645 case OFF: os << "\\latex no_latex \n"; break;
646 case ON: os << "\\latex latex \n"; break;
647 case TOGGLE: lyxerr << "LyXFont::lyxWriteFontChanges: "
648 "TOGGLE should not appear here!"
651 case INHERIT: os << "\\latex default \n"; break;
652 case IGNORE: lyxerr << "LyXFont::lyxWriteFontChanges: "
653 "IGNORE should not appear here!"
658 if (orgfont.color() != color()) {
659 // To make us file compatible with older
660 // lyx versions we emit "default" instead
662 string col_str(lcolor.getLyXName(color()));
663 if (col_str == "inherit") col_str = "default";
664 os << "\\color " << col_str << "\n";
666 if (orgfont.language() != language()) {
668 os << "\\lang " << language()->lang() << "\n";
670 os << "\\lang unknown\n";
675 /// Writes the head of the LaTeX needed to impose this font
676 // Returns number of chars written.
677 int LyXFont::latexWriteStartChanges(ostream & os, LyXFont const & base,
678 LyXFont const & prev) const
683 if (language()->babel() != base.language()->babel() &&
684 language()->babel() != prev.language()->babel()) {
685 if (isRightToLeft() != prev.isRightToLeft()) {
686 if (isRightToLeft()) {
695 subst(lyxrc.language_command_begin,
696 "$$lang", language()->babel());
698 count += tmp.length();
702 if (number() == ON && prev.number() != ON &&
703 language()->lang() == "hebrew") {
711 if (f.family() != INHERIT_FAMILY) {
713 << LaTeXFamilyNames[f.family()]
715 count += strlen(LaTeXFamilyNames[f.family()]) + 2;
716 env = true; //We have opened a new environment
718 if (f.series() != INHERIT_SERIES) {
720 << LaTeXSeriesNames[f.series()]
722 count += strlen(LaTeXSeriesNames[f.series()]) + 2;
723 env = true; //We have opened a new environment
725 if (f.shape() != INHERIT_SHAPE) {
727 << LaTeXShapeNames[f.shape()]
729 count += strlen(LaTeXShapeNames[f.shape()]) + 2;
730 env = true; //We have opened a new environment
732 if (f.color() != LColor::inherit && f.color() != LColor::ignore) {
734 << lcolor.getLaTeXName(f.color())
736 count += lcolor.getLaTeXName(f.color()).length() + 13;
737 env = true; //We have opened a new environment
739 if (f.emph() == ON) {
742 env = true; //We have opened a new environment
744 if (f.underbar() == ON) {
747 env = true; //We have opened a new environment
749 // \noun{} is a LyX special macro
750 if (f.noun() == ON) {
753 env = true; //We have opened a new environment
755 if (f.size() != INHERIT_SIZE) {
756 // If we didn't open an environment above, we open one here
762 << LaTeXSizeNames[f.size()]
764 count += strlen(LaTeXSizeNames[f.size()]) + 2;
770 /// Writes ending block of LaTeX needed to close use of this font
771 // Returns number of chars written
772 // This one corresponds to latexWriteStartChanges(). (Asger)
773 int LyXFont::latexWriteEndChanges(ostream & os, LyXFont const & base,
774 LyXFont const & next) const
779 LyXFont f = *this; // why do you need this?
780 f.reduce(base); // why isn't this just "reduce(base);" (Lgb)
781 // Because this function is const. Everything breaks if this
782 // method changes the font it represents. There is no speed penalty
783 // by using the temporary. (Asger)
786 if (f.family() != INHERIT_FAMILY) {
789 env = true; // Size change need not bother about closing env.
791 if (f.series() != INHERIT_SERIES) {
794 env = true; // Size change need not bother about closing env.
796 if (f.shape() != INHERIT_SHAPE) {
799 env = true; // Size change need not bother about closing env.
801 if (f.color() != LColor::inherit && f.color() != LColor::ignore) {
804 env = true; // Size change need not bother about closing env.
806 if (f.emph() == ON) {
809 env = true; // Size change need not bother about closing env.
811 if (f.underbar() == ON) {
814 env = true; // Size change need not bother about closing env.
816 if (f.noun() == ON) {
819 env = true; // Size change need not bother about closing env.
821 if (f.size() != INHERIT_SIZE) {
822 // We only have to close if only size changed
829 if (number() == ON && next.number() != ON &&
830 language()->lang() == "hebrew") {
835 if (language() != base.language() && language() != next.language()) {
844 LColor::color LyXFont::realColor() const
847 return LColor::latex;
848 if (color() == LColor::none)
849 return LColor::foreground;
854 // Convert logical attributes to concrete shape attribute
855 LyXFont::FONT_SHAPE LyXFont::realShape() const
857 register FONT_SHAPE s = shape();
871 bool LyXFont::equalExceptLatex(LyXFont const & f) const
874 f1.setLatex(f.latex());
879 ostream & operator<<(ostream & o, LyXFont::FONT_MISC_STATE fms)
881 return o << int(fms);