/* This file is part of * ====================================================== * * LyX, The Document Processor * * Copyright 1995 Matthias Ettrich * Copyright 1995-2001 The LyX Team. * * ====================================================== */ #include #include #include #ifdef __GNUG__ #pragma implementation #endif #include "gettext.h" #include "lyxfont.h" #include "debug.h" #include "lyxrc.h" #include "lyxlex.h" #include "language.h" #include "support/lstrings.h" #include "bufferparams.h" // stateText #include "BoostFormat.h" using std::ostream; using std::endl; #ifndef CXX_GLOBAL_CSTD using std::strlen; #endif // // Names for the GUI // namespace { char const * GUIFamilyNames[LyXFont::NUM_FAMILIES + 2 /* default & error */] = { N_("Roman"), N_("Sans serif"), N_("Typewriter"), N_("Symbol"), "cmr", "cmsy", "cmm", "cmex", "msa", "msb", "eufrak", "wasy", N_("Inherit"), N_("Ignore") }; char const * GUISeriesNames[4] = { N_("Medium"), N_("Bold"), N_("Inherit"), N_("Ignore") }; char const * GUIShapeNames[6] = { N_("Upright"), N_("Italic"), N_("Slanted"), N_("Smallcaps"), N_("Inherit"), N_("Ignore") }; char const * GUISizeNames[14] = { N_("Tiny"), N_("Smallest"), N_("Smaller"), N_("Small"), N_("Normal"), N_("Large"), N_("Larger"), N_("Largest"), N_("Huge"), N_("Huger"), N_("Increase"), N_("Decrease"), N_("Inherit"), N_("Ignore") }; char const * GUIMiscNames[5] = { N_("Off"), N_("On"), N_("Toggle"), N_("Inherit"), N_("Ignore") }; // // Strings used to read and write .lyx format files // char const * LyXFamilyNames[LyXFont::NUM_FAMILIES + 2 /* default & error */] = { "roman", "sans", "typewriter", "symbol", "cmr", "cmsy", "cmm", "cmex", "msa", "msb", "eufrak", "wasy", "default", "error" }; char const * LyXSeriesNames[4] = { "medium", "bold", "default", "error" }; char const * LyXShapeNames[6] = { "up", "italic", "slanted", "smallcaps", "default", "error" }; char const * LyXSizeNames[14] = { "tiny", "scriptsize", "footnotesize", "small", "normal", "large", "larger", "largest", "huge", "giant", "increase", "decrease", "default", "error" }; char const * LyXMiscNames[5] = { "off", "on", "toggle", "default", "error" }; // // Strings used to write LaTeX files // char const * LaTeXFamilyNames[6] = { "textrm", "textsf", "texttt", "error1", "error2", "error3" }; char const * LaTeXSeriesNames[4] = { "textmd", "textbf", "error4", "error5" }; char const * LaTeXShapeNames[6] = { "textup", "textit", "textsl", "textsc", "error6", "error7" }; char const * LaTeXSizeNames[14] = { "tiny", "scriptsize", "footnotesize", "small", "normalsize", "large", "Large", "LARGE", "huge", "Huge", "error8", "error9", "error10", "error11" }; } // namespace anon // Initialize static member LyXFont::FontBits LyXFont::sane = { ROMAN_FAMILY, MEDIUM_SERIES, UP_SHAPE, SIZE_NORMAL, LColor::none, OFF, OFF, OFF, OFF }; // Initialize static member LyXFont::FontBits LyXFont::inherit = { INHERIT_FAMILY, INHERIT_SERIES, INHERIT_SHAPE, INHERIT_SIZE, LColor::inherit, INHERIT, INHERIT, INHERIT, OFF }; // Initialize static member LyXFont::FontBits LyXFont::ignore = { IGNORE_FAMILY, IGNORE_SERIES, IGNORE_SHAPE, IGNORE_SIZE, LColor::ignore, IGNORE, IGNORE, IGNORE, IGNORE }; bool operator==(LyXFont::FontBits const & lhs, LyXFont::FontBits const & rhs) { return lhs.family == rhs.family && lhs.series == rhs.series && lhs.shape == rhs.shape && lhs.size == rhs.size && lhs.color == rhs.color && lhs.emph == rhs.emph && lhs.underbar == rhs.underbar && lhs.noun == rhs.noun && lhs.number == rhs.number; } LyXFont::LyXFont() : bits(sane), lang(default_language) {} LyXFont::LyXFont(LyXFont::FONT_INIT1) : bits(inherit), lang(default_language) {} LyXFont::LyXFont(LyXFont::FONT_INIT2) : bits(ignore), lang(ignore_language) {} LyXFont::LyXFont(LyXFont::FONT_INIT3) : bits(sane), lang(default_language) {} LyXFont::LyXFont(LyXFont::FONT_INIT1, Language const * l) : bits(inherit), lang(l) {} LyXFont::LyXFont(LyXFont::FONT_INIT2, Language const * l) : bits(ignore), lang(l) {} LyXFont::LyXFont(LyXFont::FONT_INIT3, Language const * l) : bits(sane), lang(l) {} LyXFont::FONT_MISC_STATE LyXFont::underbar() const { return bits.underbar; } LColor::color LyXFont::color() const { return bits.color; } Language const * LyXFont::language() const { return lang; } LyXFont::FONT_MISC_STATE LyXFont::number() const { return bits.number; } bool LyXFont::isRightToLeft() const { return lang->RightToLeft(); } bool LyXFont::isVisibleRightToLeft() const { return (lang->RightToLeft() && number() != ON); } LyXFont & LyXFont::setFamily(LyXFont::FONT_FAMILY f) { bits.family = f; return *this; } LyXFont & LyXFont::setSeries(LyXFont::FONT_SERIES s) { bits.series = s; return *this; } LyXFont & LyXFont::setShape(LyXFont::FONT_SHAPE s) { bits.shape = s; return *this; } LyXFont & LyXFont::setSize(LyXFont::FONT_SIZE s) { bits.size = s; return *this; } LyXFont & LyXFont::setEmph(LyXFont::FONT_MISC_STATE e) { bits.emph = e; return *this; } LyXFont & LyXFont::setUnderbar(LyXFont::FONT_MISC_STATE u) { bits.underbar = u; return *this; } LyXFont & LyXFont::setNoun(LyXFont::FONT_MISC_STATE n) { bits.noun = n; return *this; } LyXFont & LyXFont::setColor(LColor::color c) { bits.color = c; return *this; } LyXFont & LyXFont::setLanguage(Language const * l) { lang = l; return *this; } LyXFont & LyXFont::setNumber(LyXFont::FONT_MISC_STATE n) { bits.number = n; return *this; } /// Decreases font size by one LyXFont & LyXFont::decSize() { switch (size()) { case SIZE_HUGER: setSize(SIZE_HUGE); break; case SIZE_HUGE: setSize(SIZE_LARGEST); break; case SIZE_LARGEST: setSize(SIZE_LARGER); break; case SIZE_LARGER: setSize(SIZE_LARGE); break; case SIZE_LARGE: setSize(SIZE_NORMAL); break; case SIZE_NORMAL: setSize(SIZE_SMALL); break; case SIZE_SMALL: setSize(SIZE_FOOTNOTE); break; case SIZE_FOOTNOTE: setSize(SIZE_SCRIPT); break; case SIZE_SCRIPT: setSize(SIZE_TINY); break; case SIZE_TINY: break; case INCREASE_SIZE: lyxerr << "Can't LyXFont::decSize on INCREASE_SIZE" << endl; break; case DECREASE_SIZE: lyxerr <<"Can't LyXFont::decSize on DECREASE_SIZE" << endl; break; case INHERIT_SIZE: lyxerr <<"Can't LyXFont::decSize on INHERIT_SIZE" << endl; break; case IGNORE_SIZE: lyxerr <<"Can't LyXFont::decSize on IGNORE_SIZE" << endl; break; } return *this; } /// Increases font size by one LyXFont & LyXFont::incSize() { switch (size()) { case SIZE_HUGER: break; case SIZE_HUGE: setSize(SIZE_HUGER); break; case SIZE_LARGEST: setSize(SIZE_HUGE); break; case SIZE_LARGER: setSize(SIZE_LARGEST); break; case SIZE_LARGE: setSize(SIZE_LARGER); break; case SIZE_NORMAL: setSize(SIZE_LARGE); break; case SIZE_SMALL: setSize(SIZE_NORMAL); break; case SIZE_FOOTNOTE: setSize(SIZE_SMALL); break; case SIZE_SCRIPT: setSize(SIZE_FOOTNOTE); break; case SIZE_TINY: setSize(SIZE_SCRIPT); break; case INCREASE_SIZE: lyxerr <<"Can't LyXFont::incSize on INCREASE_SIZE" << endl; break; case DECREASE_SIZE: lyxerr <<"Can't LyXFont::incSize on DECREASE_SIZE" << endl; break; case INHERIT_SIZE: lyxerr <<"Can't LyXFont::incSize on INHERIT_SIZE" << endl; break; case IGNORE_SIZE: lyxerr <<"Can't LyXFont::incSize on IGNORE_SIZE" << endl; break; } return *this; } /// Updates a misc setting according to request LyXFont::FONT_MISC_STATE LyXFont::setMisc(FONT_MISC_STATE newfont, FONT_MISC_STATE org) { if (newfont == TOGGLE) { if (org == ON) return OFF; else if (org == OFF) return ON; else { lyxerr <<"LyXFont::setMisc: Need state" " ON or OFF to toggle. Setting to ON" << endl; return ON; } } else if (newfont == IGNORE) return org; else return newfont; } /// Updates font settings according to request void LyXFont::update(LyXFont const & newfont, Language const * document_language, bool toggleall) { if (newfont.family() == family() && toggleall) setFamily(INHERIT_FAMILY); // toggle 'back' else if (newfont.family() != IGNORE_FAMILY) setFamily(newfont.family()); // else it's IGNORE_SHAPE // "Old" behaviour: "Setting" bold will toggle bold on/off. switch (newfont.series()) { case BOLD_SERIES: // We toggle... if (series() == BOLD_SERIES && toggleall) setSeries(MEDIUM_SERIES); else setSeries(BOLD_SERIES); break; case MEDIUM_SERIES: case INHERIT_SERIES: setSeries(newfont.series()); break; case IGNORE_SERIES: break; } if (newfont.shape() == shape() && toggleall) setShape(INHERIT_SHAPE); // toggle 'back' else if (newfont.shape() != IGNORE_SHAPE) setShape(newfont.shape()); // else it's IGNORE_SHAPE if (newfont.size() != IGNORE_SIZE) { if (newfont.size() == INCREASE_SIZE) incSize(); else if (newfont.size() == DECREASE_SIZE) decSize(); else setSize(newfont.size()); } setEmph(setMisc(newfont.emph(), emph())); setUnderbar(setMisc(newfont.underbar(), underbar())); setNoun(setMisc(newfont.noun(), noun())); setNumber(setMisc(newfont.number(), number())); if (newfont.language() == language() && toggleall) if (language() == document_language) setLanguage(default_language); else setLanguage(document_language); else if (newfont.language() != ignore_language) setLanguage(newfont.language()); if (newfont.color() == color() && toggleall) setColor(LColor::inherit); // toggle 'back' else if (newfont.color() != LColor::ignore) setColor(newfont.color()); } /// Reduce font to fall back to template where possible void LyXFont::reduce(LyXFont const & tmplt) { if (family() == tmplt.family()) setFamily(INHERIT_FAMILY); if (series() == tmplt.series()) setSeries(INHERIT_SERIES); if (shape() == tmplt.shape()) setShape(INHERIT_SHAPE); if (size() == tmplt.size()) setSize(INHERIT_SIZE); if (emph() == tmplt.emph()) setEmph(INHERIT); if (underbar() == tmplt.underbar()) setUnderbar(INHERIT); if (noun() == tmplt.noun()) setNoun(INHERIT); if (color() == tmplt.color()) setColor(LColor::inherit); } /// Realize font from a template LyXFont & LyXFont::realize(LyXFont const & tmplt) { if (bits == inherit) { bits = tmplt.bits; return *this; } if (bits.family == INHERIT_FAMILY) { bits.family = tmplt.bits.family; } if (bits.series == INHERIT_SERIES) { bits.series = tmplt.bits.series; } if (bits.shape == INHERIT_SHAPE) { bits.shape = tmplt.bits.shape; } if (bits.size == INHERIT_SIZE) { bits.size = tmplt.bits.size; } if (bits.emph == INHERIT) { bits.emph = tmplt.bits.emph; } if (bits.underbar == INHERIT) { bits.underbar = tmplt.bits.underbar; } if (bits.noun == INHERIT) { bits.noun = tmplt.bits.noun; } if (bits.color == LColor::inherit) { bits.color = tmplt.bits.color; } return *this; } /// Is font resolved? bool LyXFont::resolved() const { return (family() != INHERIT_FAMILY && series() != INHERIT_SERIES && shape() != INHERIT_SHAPE && size() != INHERIT_SIZE && emph() != INHERIT && underbar() != INHERIT && noun() != INHERIT && color() != LColor::inherit); } /// Build GUI description of font state string const LyXFont::stateText(BufferParams * params) const { ostringstream ost; if (family() != INHERIT_FAMILY) ost << _(GUIFamilyNames[family()]) << ", "; if (series() != INHERIT_SERIES) ost << _(GUISeriesNames[series()]) << ", "; if (shape() != INHERIT_SHAPE) ost << _(GUIShapeNames[shape()]) << ", "; if (size() != INHERIT_SIZE) ost << _(GUISizeNames[size()]) << ", "; if (color() != LColor::inherit) ost << lcolor.getGUIName(color()) << ", "; if (emph() != INHERIT) ost << boost::format(_("Emphasis %1$s, ")) % _(GUIMiscNames[emph()]); if (underbar() != INHERIT) ost << boost::format(_("Underline %1$s, ")) % _(GUIMiscNames[underbar()]); if (noun() != INHERIT) ost << boost::format(_("Noun %1$s, ")) % _(GUIMiscNames[noun()]); if (bits == inherit) ost << _("Default") << ", "; if (!params || (language() != params->language)) ost << boost::format(_("Language: %1$s, ")) % _(language()->display()); if (number() != OFF) ost << boost::format(_(" Number %1$s")) % _(GUIMiscNames[number()]); string const buf = rtrim(STRCONV(ost.str()), ", "); return buf; } // Set family according to lyx format string LyXFont & LyXFont::setLyXFamily(string const & fam) { string const s = ascii_lowercase(fam); int i = 0; while (s != LyXFamilyNames[i] && LyXFamilyNames[i] != "error") ++i; if (s == LyXFamilyNames[i]) { setFamily(LyXFont::FONT_FAMILY(i)); } else lyxerr << "LyXFont::setLyXFamily: Unknown family `" << s << '\'' << endl; return *this; } // Set series according to lyx format string LyXFont & LyXFont::setLyXSeries(string const & ser) { string const s = ascii_lowercase(ser); int i = 0; while (s != LyXSeriesNames[i] && LyXSeriesNames[i] != "error") ++i; if (s == LyXSeriesNames[i]) { setSeries(LyXFont::FONT_SERIES(i)); } else lyxerr << "LyXFont::setLyXSeries: Unknown series `" << s << '\'' << endl; return *this; } // Set shape according to lyx format string LyXFont & LyXFont::setLyXShape(string const & sha) { string const s = ascii_lowercase(sha); int i = 0; while (s != LyXShapeNames[i] && LyXShapeNames[i] != "error") ++i; if (s == LyXShapeNames[i]) { setShape(LyXFont::FONT_SHAPE(i)); } else lyxerr << "LyXFont::setLyXShape: Unknown shape `" << s << '\'' << endl; return *this; } // Set size according to lyx format string LyXFont & LyXFont::setLyXSize(string const & siz) { string const s = ascii_lowercase(siz); int i = 0; while (s != LyXSizeNames[i] && LyXSizeNames[i] != "error") ++i; if (s == LyXSizeNames[i]) { setSize(LyXFont::FONT_SIZE(i)); } else lyxerr << "LyXFont::setLyXSize: Unknown size `" << s << '\'' << endl; return *this; } // Set size according to lyx format string LyXFont::FONT_MISC_STATE LyXFont::setLyXMisc(string const & siz) { string const s = ascii_lowercase(siz); int i = 0; while (s != LyXMiscNames[i] && LyXMiscNames[i] != "error") ++i; if (s == LyXMiscNames[i]) return FONT_MISC_STATE(i); lyxerr << "LyXFont::setLyXMisc: Unknown misc flag `" << s << '\'' << endl; return OFF; } /// Sets color after LyX text format LyXFont & LyXFont::setLyXColor(string const & col) { setColor(lcolor.getFromLyXName(col)); return *this; } // Returns size in latex format string const LyXFont::latexSize() const { return LaTeXSizeNames[size()]; } // Read a font definition from given file in lyx format // Used for layouts LyXFont & LyXFont::lyxRead(LyXLex & lex) { bool error = false; bool finished = false; while (!finished && lex.isOK() && !error) { lex.next(); string const tok = ascii_lowercase(lex.getString()); if (tok.empty()) { continue; } else if (tok == "endfont") { finished = true; } else if (tok == "family") { lex.next(); string const ttok = lex.getString(); setLyXFamily(ttok); } else if (tok == "series") { lex.next(); string const ttok = lex.getString(); setLyXSeries(ttok); } else if (tok == "shape") { lex.next(); string const ttok = lex.getString(); setLyXShape(ttok); } else if (tok == "size") { lex.next(); string const ttok = lex.getString(); setLyXSize(ttok); } else if (tok == "misc") { lex.next(); string const ttok = ascii_lowercase(lex.getString()); if (ttok == "no_bar") { setUnderbar(OFF); } else if (ttok == "no_emph") { setEmph(OFF); } else if (ttok == "no_noun") { setNoun(OFF); } else if (ttok == "emph") { setEmph(ON); } else if (ttok == "underbar") { setUnderbar(ON); } else if (ttok == "noun") { setNoun(ON); } else { lex.printError("Illegal misc type `$$Tokenī"); } } else if (tok == "color") { lex.next(); string const ttok = lex.getString(); setLyXColor(ttok); } else { lex.printError("Unknown tag `$$Token'"); error = true; } } return *this; } /// Writes the changes from this font to orgfont in .lyx format in file void LyXFont::lyxWriteChanges(LyXFont const & orgfont, ostream & os) const { os << "\n"; if (orgfont.family() != family()) { os << "\\family " << LyXFamilyNames[family()] << " \n"; } if (orgfont.series() != series()) { os << "\\series " << LyXSeriesNames[series()] << " \n"; } if (orgfont.shape() != shape()) { os << "\\shape " << LyXShapeNames[shape()] << " \n"; } if (orgfont.size() != size()) { os << "\\size " << LyXSizeNames[size()] << " \n"; } if (orgfont.emph() != emph()) { os << "\\emph " << LyXMiscNames[emph()] << " \n"; } if (orgfont.number() != number()) { os << "\\numeric " << LyXMiscNames[number()] << " \n"; } if (orgfont.underbar() != underbar()) { // This is only for backwards compatibility switch (underbar()) { case OFF: os << "\\bar no \n"; break; case ON: os << "\\bar under \n"; break; case TOGGLE: lyxerr << "LyXFont::lyxWriteFontChanges: " "TOGGLE should not appear here!" << endl; break; case INHERIT: os << "\\bar default \n"; break; case IGNORE: lyxerr << "LyXFont::lyxWriteFontChanges: " "IGNORE should not appear here!" << endl; break; } } if (orgfont.noun() != noun()) { os << "\\noun " << LyXMiscNames[noun()] << " \n"; } if (orgfont.color() != color()) { // To make us file compatible with older // lyx versions we emit "default" instead // of "inherit" string col_str(lcolor.getLyXName(color())); if (col_str == "inherit") col_str = "default"; os << "\\color " << col_str << "\n"; } if (orgfont.language() != language()) { if (language()) os << "\\lang " << language()->lang() << "\n"; else os << "\\lang unknown\n"; } } /// Writes the head of the LaTeX needed to impose this font // Returns number of chars written. int LyXFont::latexWriteStartChanges(ostream & os, LyXFont const & base, LyXFont const & prev) const { int count = 0; bool env = false; if (language()->babel() != base.language()->babel() && language() != prev.language()) { if (isRightToLeft() != prev.isRightToLeft()) { if (isRightToLeft()) { os << "\\R{"; count += 3; } else { os << "\\L{"; count += 3; } } else { string const tmp = subst(lyxrc.language_command_local, "$$lang", language()->babel()); os << tmp; count += tmp.length(); } } if (number() == ON && prev.number() != ON && language()->lang() == "hebrew") { os << "{\\beginL "; count += 9; } LyXFont f = *this; f.reduce(base); if (f.family() != INHERIT_FAMILY) { os << '\\' << LaTeXFamilyNames[f.family()] << '{'; count += strlen(LaTeXFamilyNames[f.family()]) + 2; env = true; //We have opened a new environment } if (f.series() != INHERIT_SERIES) { os << '\\' << LaTeXSeriesNames[f.series()] << '{'; count += strlen(LaTeXSeriesNames[f.series()]) + 2; env = true; //We have opened a new environment } if (f.shape() != INHERIT_SHAPE) { os << '\\' << LaTeXShapeNames[f.shape()] << '{'; count += strlen(LaTeXShapeNames[f.shape()]) + 2; env = true; //We have opened a new environment } if (f.color() != LColor::inherit && f.color() != LColor::ignore) { os << "\\textcolor{" << lcolor.getLaTeXName(f.color()) << "}{"; count += lcolor.getLaTeXName(f.color()).length() + 13; env = true; //We have opened a new environment } if (f.emph() == ON) { os << "\\emph{"; count += 6; env = true; //We have opened a new environment } if (f.underbar() == ON) { os << "\\underbar{"; count += 10; env = true; //We have opened a new environment } // \noun{} is a LyX special macro if (f.noun() == ON) { os << "\\noun{"; count += 8; env = true; //We have opened a new environment } if (f.size() != INHERIT_SIZE) { // If we didn't open an environment above, we open one here if (!env) { os << '{'; ++count; } os << '\\' << LaTeXSizeNames[f.size()] << ' '; count += strlen(LaTeXSizeNames[f.size()]) + 2; } return count; } /// Writes ending block of LaTeX needed to close use of this font // Returns number of chars written // This one corresponds to latexWriteStartChanges(). (Asger) int LyXFont::latexWriteEndChanges(ostream & os, LyXFont const & base, LyXFont const & next) const { int count = 0; bool env = false; // reduce the current font to changes against the base // font (of the layout). We use a temporary for this to // avoid changing this font instance, as that would break LyXFont f = *this; f.reduce(base); if (f.family() != INHERIT_FAMILY) { os << '}'; ++count; env = true; // Size change need not bother about closing env. } if (f.series() != INHERIT_SERIES) { os << '}'; ++count; env = true; // Size change need not bother about closing env. } if (f.shape() != INHERIT_SHAPE) { os << '}'; ++count; env = true; // Size change need not bother about closing env. } if (f.color() != LColor::inherit && f.color() != LColor::ignore) { os << '}'; ++count; env = true; // Size change need not bother about closing env. } if (f.emph() == ON) { os << '}'; ++count; env = true; // Size change need not bother about closing env. } if (f.underbar() == ON) { os << '}'; ++count; env = true; // Size change need not bother about closing env. } if (f.noun() == ON) { os << '}'; ++count; env = true; // Size change need not bother about closing env. } if (f.size() != INHERIT_SIZE) { // We only have to close if only size changed if (!env) { os << '}'; ++count; } } if (number() == ON && next.number() != ON && language()->lang() == "hebrew") { os << "\\endL}"; count += 6; } if (language() != base.language() && language() != next.language()) { os << "}"; ++count; } return count; } LColor::color LyXFont::realColor() const { if (color() == LColor::none) return LColor::foreground; return color(); } // Convert logical attributes to concrete shape attribute LyXFont::FONT_SHAPE LyXFont::realShape() const { register FONT_SHAPE s = shape(); if (emph() == ON) { if (s == UP_SHAPE) s = ITALIC_SHAPE; else s = UP_SHAPE; } if (noun() == ON) s = SMALLCAPS_SHAPE; return s; } ostream & operator<<(ostream & o, LyXFont::FONT_MISC_STATE fms) { return o << int(fms); }