3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup
9 * Full author contact details are available in file CREDITS.
14 #include "FontLoader.h"
17 #include "GuiFontMetrics.h"
18 #include "qt_helpers.h"
22 #include "support/debug.h"
23 #include "support/filetools.h"
24 #include "support/gettext.h"
25 #include "support/lstrings.h"
26 #include "support/Systemcall.h"
27 #include "support/Package.h"
28 #include "support/os.h"
31 #include <QFontDatabase>
33 #include "support/lassert.h"
36 using namespace lyx::support;
38 QString const math_fonts[] = {"cmex10", "cmmi10", "cmr10", "cmsy10",
39 "dsrom10", "esint10", "eufm10", "msam10", "msbm10", "rsfs10",
40 "stmary10", "wasy10"};
41 int const num_math_fonts = sizeof(math_fonts) / sizeof(*math_fonts);
48 * Matches Fonts against
49 * actual QFont instances, and also caches metrics.
54 GuiFontInfo(FontInfo const & f);
58 /// Metrics on the font
59 GuiFontMetrics metrics;
65 FontFamily lyx_family;
67 #if (QT_VERSION < QT_VERSION_CHECK(5, 0, 0))
72 SymbolFont symbol_fonts[] = {
73 #if (QT_VERSION < QT_VERSION_CHECK(5, 0, 0))
74 { SYMBOL_FAMILY,"symbol", "-*-symbol-*-*-*-*-*-*-*-*-*-*-adobe-fontspecific"},
75 { CMR_FAMILY, "cmr10", "-*-cmr10-medium-*-*-*-*-*-*-*-*-*-*-*" },
76 { CMSY_FAMILY, "cmsy10", "-*-cmsy10-*-*-*-*-*-*-*-*-*-*-*-*" },
77 { CMM_FAMILY, "cmmi10", "-*-cmmi10-medium-*-*-*-*-*-*-*-*-*-*-*" },
78 { CMEX_FAMILY, "cmex10", "-*-cmex10-*-*-*-*-*-*-*-*-*-*-*-*" },
79 { MSA_FAMILY, "msam10", "-*-msam10-*-*-*-*-*-*-*-*-*-*-*-*" },
80 { MSB_FAMILY, "msbm10", "-*-msbm10-*-*-*-*-*-*-*-*-*-*-*-*" },
81 { DS_FAMILY, "dsrom10", "-*-dsrom10-*-*-*-*-*-*-*-*-*-*-*-*" },
82 { EUFRAK_FAMILY,"eufm10", "-*-eufm10-medium-*-*-*-*-*-*-*-*-*-*-*" },
83 { RSFS_FAMILY, "rsfs10", "-*-rsfs10-medium-*-*-*-*-*-*-*-*-*-*-*" },
84 { STMARY_FAMILY,"stmary10","-*-stmary10-medium-*-*-*-*-*-*-*-*-*-*-*" },
85 { WASY_FAMILY, "wasy10", "-*-wasy10-medium-*-*-*-*-*-*-*-*-*-*-*" },
86 { ESINT_FAMILY, "esint10","-*-esint10-medium-*-*-*-*-*-*-*-*-*-*-*" }
88 { SYMBOL_FAMILY,"symbol"},
89 { CMR_FAMILY, "cmr10"},
90 { CMSY_FAMILY, "cmsy10"},
91 { CMM_FAMILY, "cmmi10"},
92 { CMEX_FAMILY, "cmex10"},
93 { MSA_FAMILY, "msam10"},
94 { MSB_FAMILY, "msbm10"},
95 { DS_FAMILY, "dsrom10"},
96 { EUFRAK_FAMILY,"eufm10"},
97 { RSFS_FAMILY, "rsfs10"},
98 { STMARY_FAMILY,"stmary10"},
99 { WASY_FAMILY, "wasy10"},
100 { ESINT_FAMILY, "esint10"}
104 size_t const nr_symbol_fonts = sizeof(symbol_fonts) / sizeof(symbol_fonts[0]);
108 fontinfo_[NUM_FAMILIES][NUM_SERIES][NUM_SHAPE][NUM_SIZE][NUM_STYLE];
111 // returns a reference to the pointer type (GuiFontInfo *) in the
113 GuiFontInfo * & fontinfo_ptr(FontInfo const & f)
115 // The display font and the text font are the same
116 size_t const style = (f.style() == DISPLAY_STYLE) ? TEXT_STYLE : f.style();
117 return fontinfo_[f.family()][f.series()][f.realShape()][f.size()][style];
121 // Get font info (font + metrics) for the given LyX font.
122 // if not cached, create it.
123 GuiFontInfo & fontinfo(FontInfo const & f)
125 bool const fontIsRealized =
126 (f.family() < NUM_FAMILIES) &&
127 (f.series() < NUM_SERIES) &&
128 (f.realShape() < NUM_SHAPE) &&
129 (f.size() < NUM_SIZE);
130 if (!fontIsRealized) {
131 // We can reset the font to something sensible in release mode.
133 LYXERR0("Unrealized font!");
135 f2.realize(sane_font);
136 GuiFontInfo * & fi = fontinfo_ptr(f2);
138 fi = new GuiFontInfo(f2);
141 GuiFontInfo * & fi = fontinfo_ptr(f);
143 fi = new GuiFontInfo(f);
148 #if (QT_VERSION < QT_VERSION_CHECK(5, 0, 0))
149 QString rawName(QString const & family)
151 for (size_t i = 0; i < nr_symbol_fonts; ++i)
152 if (family == symbol_fonts[i].family)
153 return symbol_fonts[i].xlfd;
155 LYXERR(Debug::FONT, "BUG: family not found !");
161 QString symbolFamily(FontFamily family)
163 for (size_t i = 0; i < nr_symbol_fonts; ++i) {
164 if (family == symbol_fonts[i].lyx_family)
165 return symbol_fonts[i].family;
172 bool isSymbolFamily(FontFamily family)
174 return family >= SYMBOL_FAMILY && family <= ESINT_FAMILY;
179 static bool isChosenFont(QFont & font, QString const & family,
180 QString const & style)
182 // QFontInfo won't find a font that has only a few glyphs at unusual
183 // positions, e.g. the original esint10 font.
184 // The workaround is to add dummy glyphs at least at all ASCII
188 LYXERR_NOPOS(Debug::FONT, "got: " << fi.family());
190 if (fi.family().contains(family)
191 #if QT_VERSION >= 0x040800
192 && (style.isEmpty() || fi.styleName().contains(style))
195 LYXERR_NOENDL(Debug::FONT, " got it ");
203 QFont symbolFont(QString const & family, bool * ok)
205 LYXERR_NOENDL(Debug::FONT, "Looking for font family " << family << " ... ");
206 QString upper = family;
207 upper[0] = family[0].toUpper();
210 font.setFamily(family);
211 #if QT_VERSION >= 0x040800
212 font.setStyleName("LyX");
214 if (isChosenFont(font, family, "LyX")) {
215 LYXERR_NOPOS(Debug::FONT, "lyx!");
220 LYXERR_NOENDL(Debug::FONT, "Trying normal " << family << " ... ");
221 font.setStyleName(QString());
224 if (isChosenFont(font, family, QString())) {
225 LYXERR_NOPOS(Debug::FONT, "normal!");
230 LYXERR_NOENDL(Debug::FONT, "Trying " << upper << " ... ");
231 font.setFamily(upper);
233 if (isChosenFont(font, upper, QString())) {
234 LYXERR_NOPOS(Debug::FONT, "upper!");
239 #if (QT_VERSION < QT_VERSION_CHECK(5, 0, 0))
240 // A simple setFamily() fails on Qt 2
242 QString const raw = rawName(family);
243 LYXERR_NOENDL(Debug::FONT, "Trying " << raw << " ... ");
244 font.setRawName(raw);
246 if (isChosenFont(font, family, QString())) {
247 LYXERR_NOPOS(Debug::FONT, "raw version!");
253 LYXERR_NOPOS(Debug::FONT, " FAILED :-(");
261 FontLoader::FontLoader()
263 QString const fonts_dir =
264 toqstr(addPath(package().system_support().absFileName(), "fonts"));
266 for (int i = 0 ; i < num_math_fonts; ++i) {
267 QString const font_file = fonts_dir + math_fonts[i] + ".ttf";
268 int fontID = QFontDatabase::addApplicationFont(font_file);
270 LYXERR(Debug::FONT, "Adding font " << font_file
271 << (fontID < 0 ? " FAIL" : " OK"));
274 for (int i1 = 0; i1 < NUM_FAMILIES; ++i1)
275 for (int i2 = 0; i2 < NUM_SERIES; ++i2)
276 for (int i3 = 0; i3 < NUM_SHAPE; ++i3)
277 for (int i4 = 0; i4 < NUM_SIZE; ++i4)
278 for (int i5 = 0; i5 < NUM_STYLE; ++i5)
279 fontinfo_[i1][i2][i3][i4][i5] = 0;
283 void FontLoader::update()
285 for (int i1 = 0; i1 < NUM_FAMILIES; ++i1)
286 for (int i2 = 0; i2 < NUM_SERIES; ++i2)
287 for (int i3 = 0; i3 < NUM_SHAPE; ++i3)
288 for (int i4 = 0; i4 < NUM_SIZE; ++i4)
289 for (int i5 = 0; i5 < NUM_STYLE; ++i5) {
290 delete fontinfo_[i1][i2][i3][i4][i5];
291 fontinfo_[i1][i2][i3][i4][i5] = 0;
296 FontLoader::~FontLoader()
301 /////////////////////////////////////////////////
305 QString makeFontName(QString const & family, QString const & foundry)
307 QString res = family;
308 if (!foundry.isEmpty())
309 res += " [" + foundry + ']';
314 QFont makeQFont(FontInfo const & f)
317 QString const pat = symbolFamily(f.family());
318 if (!pat.isEmpty()) {
320 font = symbolFont(pat, &ok);
322 switch (f.family()) {
324 QString family = makeFontName(toqstr(lyxrc.roman_font_name),
325 toqstr(lyxrc.roman_font_foundry));
326 font.setFamily(family);
328 #if QT_VERSION >= 0x040300 //&& QT_VERSION < 0x040800
329 // Workaround for a Qt bug, see http://www.lyx.org/trac/ticket/3684
330 // and http://bugreports.qt.nokia.com/browse/QTBUG-11145.
331 // FIXME: Check whether this is really fixed in Qt 4.8
332 if (family == "Times" && !font.exactMatch())
333 font.setFamily("Times New Roman");
339 font.setFamily(makeFontName(toqstr(lyxrc.sans_font_name),
340 toqstr(lyxrc.sans_font_foundry)));
342 case TYPEWRITER_FAMILY:
343 font.setFamily(makeFontName(toqstr(lyxrc.typewriter_font_name),
344 toqstr(lyxrc.typewriter_font_foundry)));
351 switch (f.series()) {
353 font.setWeight(QFont::Normal);
356 font.setWeight(QFont::Bold);
362 switch (f.realShape()) {
364 font.setStyle(QFont::StyleItalic);
367 font.setStyle(QFont::StyleOblique);
369 case SMALLCAPS_SHAPE:
370 font.setCapitalization(QFont::SmallCaps);
376 LYXERR(Debug::FONT, "Font '" << f.stateText()
377 << "' matched by\n" << font.family());
379 // Is this an exact match?
380 if (font.exactMatch())
381 LYXERR(Debug::FONT, "This font is an exact match");
383 LYXERR(Debug::FONT, "This font is NOT an exact match");
385 #if (QT_VERSION < QT_VERSION_CHECK(5, 0, 0))
386 LYXERR(Debug::FONT, "XFLD: " << font.rawName());
389 font.setPointSizeF(f.realSize() * lyxrc.currentZoom / 100.0);
391 LYXERR(Debug::FONT, "The font has size: " << font.pointSizeF());
399 GuiFontInfo::GuiFontInfo(FontInfo const & f)
400 : font(makeQFont(f)), metrics(font)
404 bool FontLoader::available(FontInfo const & f)
407 static vector<int> cache_set(NUM_FAMILIES, false);
408 static vector<int> cache(NUM_FAMILIES, false);
410 FontFamily family = f.family();
412 // Apple ships a font name "Symbol", which has more or less the same
413 // glyphs as the original PostScript Symbol font, but it uses a different
414 // encoding (see https://en.wikipedia.org/wiki/Symbol_(typeface)#cite_note-2).
415 // Since we expect the font specific encoding of the original
416 // PostScript Symbol font, we can't use the one provided on OS X.
417 // See also the discussion in bug 7954.
418 if (f.family() == SYMBOL_FAMILY)
421 if (cache_set[family])
422 return cache[family];
423 cache_set[family] = true;
425 QString const pat = symbolFamily(family);
427 // We don't care about non-symbol fonts
431 symbolFont(pat, &ok);
435 cache[family] = true;
440 bool FontLoader::canBeDisplayed(char_type c)
444 // FIXME check whether this is still needed for Qt5
446 #if QT_VERSION < 0x050000 && defined(QT_MAC_USE_COCOA) && (QT_MAC_USE_COCOA > 0)
447 // bug 7954, see also comment in GuiPainter::text()
455 FontMetrics const & FontLoader::metrics(FontInfo const & f)
457 return fontinfo(f).metrics;
461 GuiFontMetrics const & getFontMetrics(FontInfo const & f)
463 return fontinfo(f).metrics;
467 QFont const & getFont(FontInfo const & f)
469 return fontinfo(f).font;
472 } // namespace frontend