src/gui/text/qfontengine_ft_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtGui module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41 #ifndef QFONTENGINE_FT_P_H
  42 #define QFONTENGINE_FT_P_H
  43 //
  44 //  W A R N I N G
  45 //  -------------
  46 //
  47 // This file is not part of the Qt API.  It exists purely as an
  48 // implementation detail.  This header file may change from version to
  49 // version without notice, or even be removed.
  50 //
  51 // We mean it.
  52 //
  53
  54 #include "private/qfontengine_p.h"
  55
  56 #ifndef QT_NO_FREETYPE
  57
  58 #include <ft2build.h>
  59 #include FT_FREETYPE_H
  60
  61
  62 #ifndef Q_OS_WIN
  63 #include <unistd.h>
  64 #endif
  65
  66 #ifndef QT_NO_FONTCONFIG
  67 #include <fontconfig/fontconfig.h>
  68 #endif
  69
  70 #include <qmutex.h>
  71
  72 #include "private/qharfbuzz_copy_p.h"
  73
  74 QT_BEGIN_NAMESPACE
  75
  76 class QFontEngineFTRawFont;
  77 class QFontconfigDatabase;
  78
  79 /*
  80  * This struct represents one font file on disk (like Arial.ttf) and is shared between all the font engines
  81  * that show this font file (at different pixel sizes).
  82  */
  83 struct QFreetypeFace
  84 {
  85     void computeSize(const QFontDef &fontDef, int *xsize, int *ysize, bool *outline_drawing);
  86     QFontEngine::Properties properties() const;
  87     bool getSfntTable(uint tag, uchar *buffer, uint *length) const;
  88
  89     static QFreetypeFace *getFace(const QFontEngine::FaceId &face_id,
  90                                   const QByteArray &fontData = QByteArray());
  91     void release(const QFontEngine::FaceId &face_id);
  92
  93     // locks the struct for usage. Any read/write operations require locking.
  94     void lock()
  95     {
  96         _lock.lock();
  97     }
  98     void unlock()
  99     {
 100         _lock.unlock();
 101     }
 102
 103     FT_Face face;
 104     HB_Face hbFace;
 105     int xsize; // 26.6
 106     int ysize; // 26.6
 107     FT_Matrix matrix;
 108     FT_CharMap unicode_map;
 109     FT_CharMap symbol_map;
 110
 111     enum { cmapCacheSize = 0x200 };
 112     glyph_t cmapCache[cmapCacheSize];
 113
 114     int fsType() const;
 115
 116     HB_Error getPointInOutline(HB_Glyph glyph, int flags, hb_uint32 point, HB_Fixed *xpos, HB_Fixed *ypos, hb_uint32 *nPoints);
 117
 118     static void addGlyphToPath(FT_Face face, FT_GlyphSlot g, const QFixedPoint &point, QPainterPath *path, FT_Fixed x_scale, FT_Fixed y_scale);
 119     static void addBitmapToPath(FT_GlyphSlot slot, const QFixedPoint &point, QPainterPath *path, bool = false);
 120
 121 private:
 122     friend class QFontEngineFT;
 123     friend struct QScopedPointerDeleter<QFreetypeFace>;
 124     QFreetypeFace() : _lock(QMutex::Recursive) {}
 125     ~QFreetypeFace() {}
 126     QAtomicInt ref;
 127     QMutex _lock;
 128     QByteArray fontData;
 129 };
 130
 131 // If this is exported this breaks compilation of the windows
 132 // plugin as qfontengine_ft_p.h/.cpp are also compiled there
 133 #ifndef Q_OS_WIN
 134 class Q_GUI_EXPORT QFontEngineFT : public QFontEngine
 135 #else
 136 class QFontEngineFT : public QFontEngine
 137 #endif
 138 {
 139 public:
 140
 141     /* we don't cache glyphs that are too large anyway, so we can make this struct rather small */
 142     struct Glyph {
 143         ~Glyph();
 144         short linearAdvance;
 145         unsigned char width;
 146         unsigned char height;
 147         signed char x;
 148         signed char y;
 149         signed char advance;
 150         signed char format;
 151         uchar *data;
 152     };
 153
 154     enum SubpixelAntialiasingType {
 155         Subpixel_None,
 156         Subpixel_RGB,
 157         Subpixel_BGR,
 158         Subpixel_VRGB,
 159         Subpixel_VBGR
 160     };
 161
 162     struct GlyphInfo {
 163         unsigned short  width;
 164         unsigned short  height;
 165         short           x;
 166         short           y;
 167         short           xOff;
 168         short           yOff;
 169     };
 170
 171     struct GlyphAndSubPixelPosition
 172     {
 173         GlyphAndSubPixelPosition(glyph_t g, QFixed spp) : glyph(g), subPixelPosition(spp) {}
 174
 175         bool operator==(const GlyphAndSubPixelPosition &other) const
 176         {
 177             return glyph == other.glyph && subPixelPosition == other.subPixelPosition;
 178         }
 179
 180         glyph_t glyph;
 181         QFixed subPixelPosition;
 182     };
 183
 184     struct QGlyphSet
 185     {
 186         QGlyphSet();
 187         ~QGlyphSet();
 188         FT_Matrix transformationMatrix;
 189         bool outline_drawing;
 190
 191         void removeGlyphFromCache(glyph_t index, QFixed subPixelPosition);
 192         void clear();
 193         inline bool useFastGlyphData(glyph_t index, QFixed subPixelPosition) const {
 194             return (index < 256 && subPixelPosition == 0);
 195         }
 196         inline Glyph *getGlyph(glyph_t index, QFixed subPixelPosition = 0) const;
 197         void setGlyph(glyph_t index, QFixed spp, Glyph *glyph);
 198
 199 private:
 200         mutable QHash<GlyphAndSubPixelPosition, Glyph *> glyph_data; // maps from glyph index to glyph data
 201         mutable Glyph *fast_glyph_data[256]; // for fast lookup of glyphs < 256
 202         mutable int fast_glyph_count;
 203     };
 204
 205     virtual QFontEngine::FaceId faceId() const;
 206     virtual QFontEngine::Properties properties() const;
 207     virtual QFixed emSquareSize() const;
 208     virtual bool supportsSubPixelPositions() const
 209     {
 210         return default_hint_style == HintLight ||
 211                default_hint_style == HintNone;
 212     }
 213
 214     virtual bool getSfntTableData(uint tag, uchar *buffer, uint *length) const;
 215     virtual int synthesized() const;
 216
 217     virtual QFixed ascent() const;
 218     virtual QFixed descent() const;
 219     virtual QFixed leading() const;
 220     virtual QFixed xHeight() const;
 221     virtual QFixed averageCharWidth() const;
 222
 223     virtual qreal maxCharWidth() const;
 224     virtual qreal minLeftBearing() const;
 225     virtual qreal minRightBearing() const;
 226     virtual QFixed lineThickness() const;
 227     virtual QFixed underlinePosition() const;
 228
 229     void doKerning(QGlyphLayout *, ShaperFlags) const;
 230
 231     inline virtual Type type() const
 232     { return QFontEngine::Freetype; }
 233     inline virtual const char *name() const
 234     { return "freetype"; }
 235
 236     virtual void getUnscaledGlyph(glyph_t glyph, QPainterPath *path, glyph_metrics_t *metrics);
 237
 238     virtual bool canRender(const QChar *string, int len);
 239
 240     virtual void addGlyphsToPath(glyph_t *glyphs, QFixedPoint *positions, int nglyphs,
 241                          QPainterPath *path, QTextItem::RenderFlags flags);
 242     virtual void addOutlineToPath(qreal x, qreal y, const QGlyphLayout &glyphs,
 243                           QPainterPath *path, QTextItem::RenderFlags flags);
 244
 245     virtual bool stringToCMap(const QChar *str, int len, QGlyphLayout *glyphs, int *nglyphs, ShaperFlags flags) const;
 246
 247     virtual glyph_metrics_t boundingBox(const QGlyphLayout &glyphs);
 248     virtual glyph_metrics_t boundingBox(glyph_t glyph);
 249     virtual glyph_metrics_t boundingBox(glyph_t glyph, const QTransform &matrix);
 250
 251     virtual void recalcAdvances(QGlyphLayout *glyphs, ShaperFlags flags) const;
 252     virtual QImage alphaMapForGlyph(glyph_t g) { return alphaMapForGlyph(g, 0); }
 253     virtual QImage alphaMapForGlyph(glyph_t, QFixed);
 254     virtual QImage alphaRGBMapForGlyph(glyph_t, QFixed subPixelPosition, const QTransform &t);
 255     virtual glyph_metrics_t alphaMapBoundingBox(glyph_t glyph,
 256                                                 QFixed subPixelPosition,
 257                                                 const QTransform &matrix,
 258                                                 QFontEngine::GlyphFormat format);
 259     virtual QImage *lockedAlphaMapForGlyph(glyph_t glyph, QFixed subPixelPosition,
 260                                            GlyphFormat neededFormat, const QTransform &t,
 261                                            QPoint *offset);
 262     virtual bool hasInternalCaching() const { return cacheEnabled; }
 263     virtual void unlockAlphaMapForGlyph();
 264
 265     virtual void removeGlyphFromCache(glyph_t glyph);
 266     virtual int glyphMargin(QFontEngineGlyphCache::Type /* type */) { return 0; }
 267
 268     virtual int glyphCount() const;
 269
 270     enum Scaling {
 271         Scaled,
 272         Unscaled
 273     };
 274     FT_Face lockFace(Scaling scale = Scaled) const;
 275     void unlockFace() const;
 276
 277     FT_Face non_locked_face() const;
 278
 279     inline bool drawAntialiased() const { return antialias; }
 280     inline bool invalid() const { return xsize == 0 && ysize == 0; }
 281     inline bool isBitmapFont() const { return defaultFormat == Format_Mono; }
 282
 283     inline Glyph *loadGlyph(uint glyph, QFixed subPixelPosition, GlyphFormat format = Format_None, bool fetchMetricsOnly = false) const
 284     { return loadGlyph(cacheEnabled ? &defaultGlyphSet : 0, glyph, subPixelPosition, format, fetchMetricsOnly); }
 285     Glyph *loadGlyph(QGlyphSet *set, uint glyph, QFixed subPixelPosition, GlyphFormat = Format_None, bool fetchMetricsOnly = false) const;
 286     Glyph *loadGlyphFor(glyph_t g, QFixed subPixelPosition, GlyphFormat format);
 287
 288     QGlyphSet *loadTransformedGlyphSet(const QTransform &matrix);
 289     bool loadGlyphs(QGlyphSet *gs, const glyph_t *glyphs, int num_glyphs,
 290                     const QFixedPoint *positions,
 291                     GlyphFormat format = Format_Render);
 292
 293     QFontEngineFT(const QFontDef &fd);
 294     virtual ~QFontEngineFT();
 295
 296     bool init(FaceId faceId, bool antiaalias, GlyphFormat defaultFormat = Format_None,
 297               const QByteArray &fontData = QByteArray());
 298     bool init(FaceId faceId, bool antialias, GlyphFormat format,
 299               QFreetypeFace *freetypeFace);
 300
 301     virtual HB_Error getPointInOutline(HB_Glyph glyph, int flags, hb_uint32 point, HB_Fixed *xpos, HB_Fixed *ypos, hb_uint32 *nPoints);
 302
 303
 304     virtual void setDefaultHintStyle(HintStyle style);
 305
 306     virtual QFontEngine *cloneWithSize(qreal pixelSize) const;
 307     bool initFromFontEngine(const QFontEngineFT *fontEngine);
 308
 309     HintStyle defaultHintStyle() const { return default_hint_style; }
 310 protected:
 311
 312     QFreetypeFace *freetype;
 313     int default_load_flags;
 314     HintStyle default_hint_style;
 315     bool antialias;
 316     bool transform;
 317     bool embolden;
 318     bool obliquen;
 319     SubpixelAntialiasingType subpixelType;
 320     int lcdFilterType;
 321     bool embeddedbitmap;
 322     bool cacheEnabled;
 323
 324 private:
 325     friend class QFontEngineFTRawFont;
 326     friend class QFontconfigDatabase;
 327     friend class QFontEngineMultiFontConfig;
 328
 329     int loadFlags(QGlyphSet *set, GlyphFormat format, int flags, bool &hsubpixel, int &vfactor) const;
 330
 331     GlyphFormat defaultFormat;
 332     FT_Matrix matrix;
 333
 334     QList<QGlyphSet> transformedGlyphSets;
 335     mutable QGlyphSet defaultGlyphSet;
 336
 337     QFontEngine::FaceId face_id;
 338
 339     int xsize;
 340     int ysize;
 341
 342     mutable QFixed lbearing;
 343     mutable QFixed rbearing;
 344     QFixed line_thickness;
 345     QFixed underline_position;
 346
 347     FT_Size_Metrics metrics;
 348     mutable bool kerning_pairs_loaded;
 349 };
 350
 351 inline uint qHash(const QFontEngineFT::GlyphAndSubPixelPosition &g)
 352 {
 353     return (g.glyph << 8)  | (g.subPixelPosition * 10).round().toInt();
 354 }
 355
 356 inline QFontEngineFT::Glyph *QFontEngineFT::QGlyphSet::getGlyph(glyph_t index, QFixed subPixelPosition) const
 357 {
 358     if (useFastGlyphData(index, subPixelPosition))
 359         return fast_glyph_data[index];
 360     return glyph_data.value(GlyphAndSubPixelPosition(index, subPixelPosition));
 361 }
 362
 363 extern FT_Library qt_getFreetype();
 364
 365 QT_END_NAMESPACE
 366
 367 #endif // QT_NO_FREETYPE
 368
 369 #endif // QFONTENGINE_FT_P_H