lyx_mirror/src/lyxfont.C

874 lines
21 KiB
C++
Raw Normal View History

/* This file is part of
* ======================================================
*
* LyX, The Document Processor
*
* Copyright 1995 Matthias Ettrich
* Copyright 1995-2000 The LyX Team.
*
* ====================================================== */
#include <config.h>
#include <clocale>
#ifdef __GNUG__
#pragma implementation "lyxfont.h"
#endif
#include <cctype>
#include "gettext.h"
#include "lyxfont.h"
#include "debug.h"
#include "lyxrc.h"
#include "lyxlex.h"
#include "FontLoader.h"
#include "support/lstrings.h"
#include "bufferparams.h" // stateText
using std::ostream;
using std::endl;
//
// Names for the GUI
//
static
char const * GUIFamilyNames[6] =
{ N_("Roman"), N_("Sans serif"), N_("Typewriter"), N_("Symbol"), N_("Inherit"),
N_("Ignore") };
static
char const * GUISeriesNames[4] =
{ N_("Medium"), N_("Bold"), N_("Inherit"), N_("Ignore") };
static
char const * GUIShapeNames[6] =
{ N_("Upright"), N_("Italic"), N_("Slanted"), N_("Smallcaps"), N_("Inherit"),
N_("Ignore") };
static
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") };
static
char const * GUIMiscNames[5] =
{ N_("Off"), N_("On"), N_("Toggle"), N_("Inherit"), N_("Ignore") };
//
// Strings used to read and write .lyx format files
//
static
char const * LyXFamilyNames[6] =
{ "roman", "sans", "typewriter", "symbol", "default", "error" };
static
char const * LyXSeriesNames[4] =
{ "medium", "bold", "default", "error" };
static
char const * LyXShapeNames[6] =
{ "up", "italic", "slanted", "smallcaps", "default", "error" };
static
char const * LyXSizeNames[14] =
{ "tiny", "scriptsize", "footnotesize", "small", "normal", "large",
"larger", "largest", "huge", "giant",
"increase-error", "decrease-error", "default", "error" };
static
char const * LyXMiscNames[5] =
{ "off", "on", "toggle", "default", "error" };
//
// Strings used to write LaTeX files
//
static
char const * LaTeXFamilyNames[6] =
{ "textrm", "textsf", "texttt", "error1", "error2", "error3" };
static
char const * LaTeXSeriesNames[4] =
{ "textmd", "textbf", "error4", "error5" };
static
char const * LaTeXShapeNames[6] =
{ "textup", "textit", "textsl", "textsc", "error6", "error7" };
static
char const * LaTeXSizeNames[14] =
{ "tiny", "scriptsize", "footnotesize", "small", "normalsize", "large",
"Large", "LARGE", "huge", "Huge", "error8", "error9", "error10", "error11" };
LyXFont::FontBits LyXFont::sane = {
ROMAN_FAMILY,
MEDIUM_SERIES,
UP_SHAPE,
SIZE_NORMAL,
LColor::none,
OFF,
OFF,
OFF,
OFF };
LyXFont::FontBits LyXFont::inherit = {
INHERIT_FAMILY,
INHERIT_SERIES,
INHERIT_SHAPE,
INHERIT_SIZE,
LColor::inherit,
INHERIT,
INHERIT,
INHERIT,
INHERIT };
LyXFont::FontBits LyXFont::ignore = {
IGNORE_FAMILY,
IGNORE_SERIES,
IGNORE_SHAPE,
IGNORE_SIZE,
LColor::ignore,
IGNORE,
IGNORE,
IGNORE,
IGNORE };
bool LyXFont::FontBits::operator==(LyXFont::FontBits const & fb1) const
{
return fb1.family == family &&
fb1.series == series &&
fb1.shape == shape &&
fb1.size == size &&
fb1.color == color &&
fb1.emph == emph &&
fb1.underbar == underbar &&
fb1.noun == noun &&
fb1.latex == latex;
}
bool LyXFont::FontBits::operator!=(LyXFont::FontBits const & fb1) const
{
return !(fb1 == *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 if (newfont.size() == size() && toggleall)
setSize(INHERIT_SIZE); // toggle 'back'
else
setSize(newfont.size());
}
setEmph(setMisc(newfont.emph(), emph()));
setUnderbar(setMisc(newfont.underbar(), underbar()));
setNoun(setMisc(newfont.noun(), noun()));
setLatex(setMisc(newfont.latex(), latex()));
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 (latex() == tmplt.latex())
setLatex(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.latex == INHERIT) {
bits.latex = tmplt.bits.latex;
}
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 && latex() != INHERIT &&
color() != LColor::inherit);
}
/// Build GUI description of font state
string LyXFont::stateText(BufferParams * params) const
{
#ifdef HAVE_SSTREAM
std::ostringstream ost;
#else
char str[1024];
ostrstream ost(str, 1024);
#endif
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 << _("Emphasis ")
<< _(GUIMiscNames[emph()]) << ", ";
if (underbar() != INHERIT)
ost << _("Underline ")
<< _(GUIMiscNames[underbar()]) << ", ";
if (noun() != INHERIT)
ost << _("Noun ") << _(GUIMiscNames[noun()]) << ", ";
if (latex() != INHERIT)
ost << _("Latex ") << _(GUIMiscNames[latex()]) << ", ";
if (bits == inherit)
ost << _("Default") << ", ";
if (!params || language() != params->language_info)
ost << _("Language: ") << _(language()->display().c_str());
#ifdef HAVE_SSTREAM
string buf(ost.str().c_str());
#else
ost << '\0';
string buf(ost.str());
#endif
buf = strip(buf, ' ');
buf = strip(buf, ',');
return buf;
}
// Set family according to lyx format string
LyXFont & LyXFont::setLyXFamily(string const & fam)
{
string s = 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 s = 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 s = 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 s = 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 s = 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;
}
/// Sets size after GUI name
LyXFont & LyXFont::setGUISize(string const & siz)
{
// CHECK this might be wrong.
/// ??????
// this is how it was how it was done in the lyx repository...
// but this does not make sense.
setColor(lcolor.getFromGUIName(siz));
return *this;
}
// Returns size in latex format
string 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 tok = lowercase(lex.GetString());
if (tok.empty()) {
continue;
} else if (tok == "endfont") {
finished = true;
} else if (tok == "family") {
lex.next();
string tok = lex.GetString();
setLyXFamily(tok);
} else if (tok == "series") {
lex.next();
string tok = lex.GetString();
setLyXSeries(tok);
} else if (tok == "shape") {
lex.next();
string tok = lex.GetString();
setLyXShape(tok);
} else if (tok == "size") {
lex.next();
string tok = lex.GetString();
setLyXSize(tok);
} else if (tok == "latex") {
lex.next();
string tok = lowercase(lex.GetString());
if (tok == "no_latex") {
setLatex(OFF);
} else if (tok == "latex") {
setLatex(ON);
} else {
lex.printError("Illegal LaTeX type`$$Token'");
}
} else if (tok == "misc") {
lex.next();
string tok = lowercase(lex.GetString());
if (tok == "no_bar") {
setUnderbar(OFF);
} else if (tok == "no_emph") {
setEmph(OFF);
} else if (tok == "no_noun") {
setNoun(OFF);
} else if (tok == "emph") {
setEmph(ON);
} else if (tok == "underbar") {
setUnderbar(ON);
} else if (tok == "noun") {
setNoun(ON);
} else {
lex.printError("Illegal misc type `$$Token<65>");
}
} else if (tok == "color") {
lex.next();
string tok = lex.GetString();
setLyXColor(tok);
} 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.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.latex() != latex()) {
// This is only for backwards compatibility
switch (latex()) {
case OFF: os << "\\latex no_latex \n"; break;
case ON: os << "\\latex latex \n"; break;
case TOGGLE: lyxerr << "LyXFont::lyxWriteFontChanges: "
"TOGGLE should not appear here!"
<< endl;
break;
case INHERIT: os << "\\latex default \n"; break;
case IGNORE: lyxerr << "LyXFont::lyxWriteFontChanges: "
"IGNORE should not appear here!"
<< endl;
break;
}
}
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() != base.language() && language() != prev.language()) {
if (isRightToLeft() != prev.isRightToLeft()) {
if (isRightToLeft()) {
os << "\\R{";
count += 3;
env = true; //We have opened a new environment
} else {
os << "\\L{";
count += 3;
env = true; //We have opened a new environment
}
} else {
string tmp = '{' +
subst(lyxrc.language_command_begin,
"$$lang", language()->lang());
os << tmp;
count += tmp.length();
env = true; //We have opened a new environment
}
}
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) {
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;
if (language() != base.language() && language() != next.language()) {
os << "}";
++count;
env = true; // Size change need not bother about closing env.
}
LyXFont f = *this; // why do you need this?
f.reduce(base); // why isn't this just "reduce(base);" (Lgb)
// Because this function is const. Everything breaks if this
// method changes the font it represents. There is no speed penalty
// by using the temporary. (Asger)
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) {
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;
}
}
return count;
}
LColor::color LyXFont::realColor() const
{
if (latex() == ON)
return LColor::latex;
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;
}
bool LyXFont::equalExceptLatex(LyXFont const & f) const
{
LyXFont f1 = *this;
f1.setLatex(f.latex());
return f1 == f;
}
ostream & operator<<(ostream & o, LyXFont::FONT_MISC_STATE fms)
{
return o << int(fms);
}