src/frontends/qt4/GuiFontLoader.cpp

   1 /**
   2  * \file FontLoader.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Asger Alstrup
   7  * \author John Levon
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "FontLoader.h"
  15
  16 #include "FontInfo.h"
  17 #include "GuiFontMetrics.h"
  18 #include "qt_helpers.h"
  19
  20 #include "LyXRC.h"
  21
  22 #include "support/convert.h"
  23 #include "support/debug.h"
  24 #include "support/filetools.h"
  25 #include "support/gettext.h"
  26 #include "support/lstrings.h"
  27 #include "support/Systemcall.h"
  28 #include "support/Package.h"
  29 #include "support/os.h"
  30
  31 #include <QFontInfo>
  32 #include <QFontDatabase>
  33
  34 #include "support/lassert.h"
  35
  36 using namespace std;
  37 using namespace lyx::support;
  38
  39 QString const math_fonts[] = {"cmex10", "cmmi10", "cmr10", "cmsy10",
  40         "esint10", "eufm10", "msam10", "msbm10", "rsfs10", "stmary10",
  41         "wasy10"};
  42 int const num_math_fonts = sizeof(math_fonts) / sizeof(*math_fonts);
  43
  44 namespace lyx {
  45
  46 extern docstring const stateText(FontInfo const & f);
  47
  48 namespace frontend {
  49
  50 /**
  51  * Matches Fonts against
  52  * actual QFont instances, and also caches metrics.
  53  */
  54 class GuiFontInfo
  55 {
  56 public:
  57         GuiFontInfo(FontInfo const & f);
  58
  59         /// The font instance
  60         QFont font;
  61         /// Metrics on the font
  62         GuiFontMetrics metrics;
  63 };
  64
  65 namespace {
  66
  67 struct SymbolFont {
  68         FontFamily lyx_family;
  69         QString family;
  70         QString xlfd;
  71 };
  72
  73 SymbolFont symbol_fonts[] = {
  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         { EUFRAK_FAMILY,"eufm10", "-*-eufm10-medium-*-*-*-*-*-*-*-*-*-*-*" },
  82         { RSFS_FAMILY,  "rsfs10", "-*-rsfs10-medium-*-*-*-*-*-*-*-*-*-*-*" },
  83         { STMARY_FAMILY,"stmary10","-*-stmary10-medium-*-*-*-*-*-*-*-*-*-*-*" },
  84         { WASY_FAMILY,  "wasy10", "-*-wasy10-medium-*-*-*-*-*-*-*-*-*-*-*" },
  85         { ESINT_FAMILY, "esint10","-*-esint10-medium-*-*-*-*-*-*-*-*-*-*-*" }
  86 };
  87
  88 size_t const nr_symbol_fonts = sizeof(symbol_fonts) / sizeof(symbol_fonts[0]);
  89
  90 /// BUTT ugly !
  91 static GuiFontInfo * fontinfo_[NUM_FAMILIES][NUM_SERIES][NUM_SHAPE][NUM_SIZE];
  92
  93
  94 // Get font info (font + metrics) for the given LyX font.
  95 // if not cached, create it.
  96 GuiFontInfo & fontinfo(FontInfo const & f)
  97 {
  98         // LASSERT: Is there anything we might do here besides crash?
  99         LBUFERR(f.family() < NUM_FAMILIES);
 100         LBUFERR(f.series() < NUM_SERIES);
 101         LBUFERR(f.realShape() < NUM_SHAPE);
 102         LBUFERR(f.size() < NUM_SIZE);
 103         // fi is a reference to the pointer type (GuiFontInfo *) in the
 104         // fontinfo_ table.
 105         GuiFontInfo * & fi =
 106                 fontinfo_[f.family()][f.series()][f.realShape()][f.size()];
 107         if (!fi)
 108                 fi = new GuiFontInfo(f);
 109         return *fi;
 110 }
 111
 112
 113 QString rawName(QString const & family)
 114 {
 115         for (size_t i = 0; i < nr_symbol_fonts; ++i)
 116                 if (family == symbol_fonts[i].family)
 117                         return symbol_fonts[i].xlfd;
 118
 119         LYXERR(Debug::FONT, "BUG: family not found !");
 120         return QString();
 121 }
 122
 123
 124 QString symbolFamily(FontFamily family)
 125 {
 126         for (size_t i = 0; i < nr_symbol_fonts; ++i) {
 127                 if (family == symbol_fonts[i].lyx_family)
 128                         return symbol_fonts[i].family;
 129         }
 130         return QString();
 131 }
 132
 133
 134 #if 0
 135 bool isSymbolFamily(FontFamily family)
 136 {
 137         return family >= SYMBOL_FAMILY && family <= ESINT_FAMILY;
 138 }
 139 #endif
 140
 141
 142 static bool isChosenFont(QFont & font, QString const & family)
 143 {
 144         // QFontInfo won't find a font that has only a few glyphs at unusual
 145         // positions, e.g. the original esint10 font.
 146         // The workaround is to add dummy glyphs at least at all ASCII
 147         // positions.
 148         QFontInfo fi(font);
 149
 150         LYXERR(Debug::FONT, "got: " << fi.family());
 151
 152         if (fi.family().contains(family)) {
 153                 LYXERR(Debug::FONT, " got it ");
 154                 return true;
 155         }
 156
 157         return false;
 158 }
 159
 160
 161 QFont symbolFont(QString const & family, bool * ok)
 162 {
 163         LYXERR(Debug::FONT, "Looking for font family " << family << " ... ");
 164         QString upper = family;
 165         upper[0] = family[0].toUpper();
 166
 167         QFont font;
 168         font.setFamily(family);
 169
 170         if (isChosenFont(font, family)) {
 171                 LYXERR(Debug::FONT, "normal!");
 172                 *ok = true;
 173                 return font;
 174         }
 175
 176         LYXERR(Debug::FONT, "Trying " << upper << " ... ");
 177         font.setFamily(upper);
 178
 179         if (isChosenFont(font, upper)) {
 180                 LYXERR(Debug::FONT, "upper!");
 181                 *ok = true;
 182                 return font;
 183         }
 184
 185         // A simple setFamily() fails on Qt 2
 186
 187         QString const raw = rawName(family);
 188         LYXERR(Debug::FONT, "Trying " << raw << " ... ");
 189         font.setRawName(raw);
 190
 191         if (isChosenFont(font, family)) {
 192                 LYXERR(Debug::FONT, "raw version!");
 193                 *ok = true;
 194                 return font;
 195         }
 196
 197         LYXERR(Debug::FONT, " FAILED :-(");
 198         *ok = false;
 199         return font;
 200 }
 201
 202 } // namespace anon
 203
 204
 205 FontLoader::FontLoader()
 206 {
 207         QString const fonts_dir =
 208                 toqstr(addPath(package().system_support().absFileName(), "fonts"));
 209
 210         for (int i = 0 ; i < num_math_fonts; ++i) {
 211                 QString const font_file = fonts_dir + math_fonts[i] + ".ttf";
 212                 int fontID = QFontDatabase::addApplicationFont(font_file);
 213
 214                 LYXERR(Debug::FONT, "Adding font " << font_file
 215                                     << (fontID < 0 ? " FAIL" : " OK"));
 216         }
 217
 218         for (int i1 = 0; i1 < NUM_FAMILIES; ++i1)
 219                 for (int i2 = 0; i2 < NUM_SERIES; ++i2)
 220                         for (int i3 = 0; i3 < NUM_SHAPE; ++i3)
 221                                 for (int i4 = 0; i4 < NUM_SIZE; ++i4)
 222                                         fontinfo_[i1][i2][i3][i4] = 0;
 223 }
 224
 225
 226 void FontLoader::update()
 227 {
 228         for (int i1 = 0; i1 < NUM_FAMILIES; ++i1)
 229                 for (int i2 = 0; i2 < NUM_SERIES; ++i2)
 230                         for (int i3 = 0; i3 < NUM_SHAPE; ++i3)
 231                                 for (int i4 = 0; i4 < NUM_SIZE; ++i4) {
 232                                         delete fontinfo_[i1][i2][i3][i4];
 233                                         fontinfo_[i1][i2][i3][i4] = 0;
 234                                 }
 235 }
 236
 237
 238 FontLoader::~FontLoader()
 239 {
 240         update();
 241 }
 242
 243 /////////////////////////////////////////////////
 244
 245
 246 static QString makeFontName(QString const & family, QString const & foundry)
 247 {
 248         QString res = family;
 249         if (!foundry.isEmpty())
 250                 res += " [" + foundry + ']';
 251         return res;
 252 }
 253
 254
 255 GuiFontInfo::GuiFontInfo(FontInfo const & f)
 256         : metrics(QFont())
 257 {
 258         QString const pat = symbolFamily(f.family());
 259         if (!pat.isEmpty()) {
 260                 bool ok;
 261                 font = symbolFont(pat, &ok);
 262         } else {
 263                 switch (f.family()) {
 264                 case ROMAN_FAMILY: {
 265                         QString family = makeFontName(toqstr(lyxrc.roman_font_name),
 266                                 toqstr(lyxrc.roman_font_foundry));
 267                         font.setFamily(family);
 268 #ifdef Q_OS_MAC
 269 #if QT_VERSION >= 0x040300 //&& QT_VERSION < 0x040800
 270                         // Workaround for a Qt bug, see http://www.lyx.org/trac/ticket/3684
 271                         // and http://bugreports.qt.nokia.com/browse/QTBUG-11145.
 272                         // FIXME: Check whether this is really fixed in Qt 4.8
 273                         if (family == "Times" && !font.exactMatch())
 274                                 font.setFamily("Times New Roman");
 275 #endif
 276 #endif
 277                         break;
 278                 }
 279                 case SANS_FAMILY:
 280                         font.setFamily(makeFontName(toqstr(lyxrc.sans_font_name),
 281                                                     toqstr(lyxrc.sans_font_foundry)));
 282                         break;
 283                 case TYPEWRITER_FAMILY:
 284                         font.setFamily(makeFontName(toqstr(lyxrc.typewriter_font_name),
 285                                                     toqstr(lyxrc.typewriter_font_foundry)));
 286                         break;
 287                 default:
 288                         break;
 289                 }
 290         }
 291
 292         switch (f.series()) {
 293                 case MEDIUM_SERIES:
 294                         font.setWeight(QFont::Normal);
 295                         break;
 296                 case BOLD_SERIES:
 297                         font.setWeight(QFont::Bold);
 298                         break;
 299                 default:
 300                         break;
 301         }
 302
 303         switch (f.realShape()) {
 304                 case ITALIC_SHAPE:
 305                         font.setStyle(QFont::StyleItalic);
 306                         break;
 307                 case SLANTED_SHAPE:
 308                         font.setStyle(QFont::StyleOblique);
 309                         break;
 310                 case SMALLCAPS_SHAPE:
 311                         font.setCapitalization(QFont::SmallCaps);
 312                         break;
 313                 default:
 314                         break;
 315         }
 316
 317         LYXERR(Debug::FONT, "Font '" << stateText(f)
 318                 << "' matched by\n" << font.family());
 319
 320         // Is this an exact match?
 321         if (font.exactMatch())
 322                 LYXERR(Debug::FONT, "This font is an exact match");
 323         else
 324                 LYXERR(Debug::FONT, "This font is NOT an exact match");
 325
 326         LYXERR(Debug::FONT, "XFLD: " << font.rawName());
 327
 328         font.setPointSizeF(convert<double>(lyxrc.font_sizes[f.size()])
 329                                * lyxrc.zoom / 100.0);
 330
 331         LYXERR(Debug::FONT, "The font has size: " << font.pointSizeF());
 332
 333         metrics = GuiFontMetrics(font);
 334 }
 335
 336
 337 bool FontLoader::available(FontInfo const & f)
 338 {
 339         // FIXME THREAD
 340         static vector<int> cache_set(NUM_FAMILIES, false);
 341         static vector<int> cache(NUM_FAMILIES, false);
 342
 343         FontFamily family = f.family();
 344 #ifdef Q_OS_MAC
 345         // Apple ships a font name "Symbol", which has more or less the same
 346         // glyphs as the original PostScript Symbol font, but it uses a different
 347         // encoding (see https://en.wikipedia.org/wiki/Symbol_(typeface)#cite_note-2).
 348         // Since we expect the font specific encoding of the original
 349         // PostScript Symbol font, we can't use the one provided on OS X.
 350         // See also the discussion in bug 7954.
 351         if (f.family() == SYMBOL_FAMILY)
 352                 return false;
 353 #endif
 354         if (cache_set[family])
 355                 return cache[family];
 356         cache_set[family] = true;
 357
 358         QString const pat = symbolFamily(family);
 359         if (pat.isEmpty())
 360                 // We don't care about non-symbol fonts
 361                 return false;
 362
 363         bool ok;
 364         symbolFont(pat, &ok);
 365         if (!ok)
 366                 return false;
 367
 368         cache[family] = true;
 369         return true;
 370 }
 371
 372
 373 bool FontLoader::canBeDisplayed(char_type c)
 374 {
 375         // bug 8493
 376         if (c == 0x0009)
 377                 // FIXME check whether this is still needed for Qt5
 378                 return false;
 379 #if QT_VERSION < 0x050000 && defined(QT_MAC_USE_COCOA) && (QT_MAC_USE_COCOA > 0)
 380         // bug 7954, see also comment in GuiPainter::text()
 381         if (c == 0x00ad)
 382                 return false;
 383 #endif
 384         return true;
 385 }
 386
 387
 388 FontMetrics const & FontLoader::metrics(FontInfo const & f)
 389 {
 390         return fontinfo(f).metrics;
 391 }
 392
 393
 394 GuiFontMetrics const & getFontMetrics(FontInfo const & f)
 395 {
 396         return fontinfo(f).metrics;
 397 }
 398
 399
 400 QFont const & getFont(FontInfo const & f)
 401 {
 402         return fontinfo(f).font;
 403 }
 404
 405 } // namespace frontend
 406 } // namespace lyx