src/gui/text/qfontengine_ft_p.h
changeset 0 1918ee327afb
child 4 3b1da2848fc7
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the QtGui module of the Qt Toolkit.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    33 **
       
    34 **
       
    35 **
       
    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 "qfontengine_p.h"
       
    55 
       
    56 #ifndef QT_NO_FREETYPE
       
    57 
       
    58 #include <ft2build.h>
       
    59 #include FT_FREETYPE_H
       
    60 
       
    61 #if defined(Q_WS_X11)
       
    62 #include <private/qt_x11_p.h>
       
    63 #endif
       
    64 
       
    65 #include <unistd.h>
       
    66 
       
    67 #ifndef QT_NO_FONTCONFIG
       
    68 #include <fontconfig/fontconfig.h>
       
    69 #endif
       
    70 
       
    71 #include <qmutex.h>
       
    72 
       
    73 #include <harfbuzz-shaper.h>
       
    74 
       
    75 QT_BEGIN_NAMESPACE
       
    76 
       
    77 /*
       
    78  * This struct represents one font file on disk (like Arial.ttf) and is shared between all the font engines
       
    79  * that show this font file (at different pixel sizes).
       
    80  */
       
    81 struct QFreetypeFace
       
    82 {
       
    83     void computeSize(const QFontDef &fontDef, int *xsize, int *ysize, bool *outline_drawing);
       
    84     QFontEngine::Properties properties() const;
       
    85     bool getSfntTable(uint tag, uchar *buffer, uint *length) const;
       
    86 
       
    87     static QFreetypeFace *getFace(const QFontEngine::FaceId &face_id);
       
    88     void release(const QFontEngine::FaceId &face_id);
       
    89 
       
    90     // locks the struct for usage. Any read/write operations require locking.
       
    91     void lock()
       
    92     {
       
    93         _lock.lock();
       
    94     }
       
    95     void unlock()
       
    96     {
       
    97         _lock.unlock();
       
    98     }
       
    99 
       
   100     FT_Face face;
       
   101     HB_Face hbFace;
       
   102 #ifndef QT_NO_FONTCONFIG
       
   103     FcCharSet *charset;
       
   104 #endif
       
   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 QScopedPointerDeleter<QFreetypeFace>;
       
   123     QFreetypeFace() : _lock(QMutex::Recursive) {}
       
   124     ~QFreetypeFace() {}
       
   125     QAtomicInt ref;
       
   126     QMutex _lock;
       
   127     QByteArray fontData;
       
   128 };
       
   129 
       
   130 class Q_GUI_EXPORT QFontEngineFT : public QFontEngine
       
   131 {
       
   132 public:
       
   133     enum GlyphFormat {
       
   134         Format_None,
       
   135         Format_Render = Format_None,
       
   136         Format_Mono,
       
   137         Format_A8,
       
   138         Format_A32
       
   139     };
       
   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         unsigned int uploadedToServer : 1;
       
   153     };
       
   154 
       
   155     enum SubpixelAntialiasingType {
       
   156         Subpixel_None,
       
   157         Subpixel_RGB,
       
   158         Subpixel_BGR,
       
   159         Subpixel_VRGB,
       
   160         Subpixel_VBGR
       
   161     };
       
   162 
       
   163 #if defined(Q_WS_X11) && !defined(QT_NO_XRENDER)
       
   164     typedef XGlyphInfo GlyphInfo;
       
   165 #else
       
   166     struct GlyphInfo {
       
   167         unsigned short  width;
       
   168         unsigned short  height;
       
   169         short           x;
       
   170         short           y;
       
   171         short           xOff;
       
   172         short           yOff;
       
   173     };
       
   174 #endif
       
   175 
       
   176     struct QGlyphSet
       
   177     {
       
   178         QGlyphSet();
       
   179         ~QGlyphSet();
       
   180         FT_Matrix transformationMatrix;
       
   181         unsigned long id; // server sided id, GlyphSet for X11
       
   182         bool outline_drawing;
       
   183         mutable QHash<int, Glyph *> glyph_data; // maps from glyph index to glyph data
       
   184     };
       
   185 
       
   186     virtual QFontEngine::FaceId faceId() const;
       
   187     virtual QFontEngine::Properties properties() const;
       
   188     virtual QFixed emSquareSize() const;
       
   189 
       
   190     virtual bool getSfntTableData(uint tag, uchar *buffer, uint *length) const;
       
   191     virtual int synthesized() const;
       
   192 
       
   193     virtual QFixed ascent() const;
       
   194     virtual QFixed descent() const;
       
   195     virtual QFixed leading() const;
       
   196     virtual QFixed xHeight() const;
       
   197     virtual QFixed averageCharWidth() const;
       
   198 
       
   199     virtual qreal maxCharWidth() const;
       
   200     virtual qreal minLeftBearing() const;
       
   201     virtual qreal minRightBearing() const;
       
   202     virtual QFixed lineThickness() const;
       
   203     virtual QFixed underlinePosition() const;
       
   204 
       
   205     void doKerning(QGlyphLayout *, QTextEngine::ShaperFlags) const;
       
   206 
       
   207     inline virtual Type type() const
       
   208     { return QFontEngine::Freetype; }
       
   209     inline virtual const char *name() const
       
   210     { return "freetype"; }
       
   211 
       
   212     virtual void getUnscaledGlyph(glyph_t glyph, QPainterPath *path, glyph_metrics_t *metrics);
       
   213 
       
   214     virtual bool canRender(const QChar *string, int len);
       
   215 
       
   216     virtual void addGlyphsToPath(glyph_t *glyphs, QFixedPoint *positions, int nglyphs,
       
   217                          QPainterPath *path, QTextItem::RenderFlags flags);
       
   218     virtual void addOutlineToPath(qreal x, qreal y, const QGlyphLayout &glyphs,
       
   219                           QPainterPath *path, QTextItem::RenderFlags flags);
       
   220 
       
   221     virtual bool stringToCMap(const QChar *str, int len, QGlyphLayout *glyphs, int *nglyphs,
       
   222                       QTextEngine::ShaperFlags flags) const;
       
   223 
       
   224     virtual glyph_metrics_t boundingBox(const QGlyphLayout &glyphs);
       
   225     virtual glyph_metrics_t boundingBox(glyph_t glyph);
       
   226     virtual glyph_metrics_t boundingBox(glyph_t glyph, const QTransform &matrix);
       
   227 
       
   228     virtual void recalcAdvances(QGlyphLayout *glyphs, QTextEngine::ShaperFlags flags) const;
       
   229     virtual QImage alphaMapForGlyph(glyph_t);
       
   230     virtual QImage alphaRGBMapForGlyph(glyph_t, int margin, const QTransform &t);
       
   231     virtual void removeGlyphFromCache(glyph_t glyph);
       
   232 
       
   233     virtual int glyphCount() const;
       
   234 
       
   235     enum Scaling {
       
   236         Scaled,
       
   237         Unscaled
       
   238     };
       
   239     FT_Face lockFace(Scaling scale = Scaled) const;
       
   240     void unlockFace() const;
       
   241 
       
   242     FT_Face non_locked_face() const;
       
   243 
       
   244     inline bool drawAntialiased() const { return antialias; }
       
   245     inline bool invalid() const { return xsize == 0 && ysize == 0; }
       
   246     inline bool isBitmapFont() const { return defaultFormat == Format_Mono; }
       
   247 
       
   248     inline Glyph *loadGlyph(uint glyph, GlyphFormat format = Format_None, bool fetchMetricsOnly = false) const
       
   249     { return loadGlyph(&defaultGlyphSet, glyph, format, fetchMetricsOnly); }
       
   250     Glyph *loadGlyph(QGlyphSet *set, uint glyph, GlyphFormat = Format_None, bool fetchMetricsOnly = false) const;
       
   251 
       
   252     QGlyphSet *defaultGlyphs() { return &defaultGlyphSet; }
       
   253     GlyphFormat defaultGlyphFormat() const { return defaultFormat; }
       
   254 
       
   255     inline Glyph *cachedGlyph(glyph_t g) const { return defaultGlyphSet.glyph_data.value(g); }
       
   256 
       
   257     QGlyphSet *loadTransformedGlyphSet(const QTransform &matrix);
       
   258     bool loadGlyphs(QGlyphSet *gs, glyph_t *glyphs, int num_glyphs, GlyphFormat format = Format_Render);
       
   259 
       
   260 #if defined(Q_WS_QWS) || defined(Q_OS_SYMBIAN)
       
   261     virtual void draw(QPaintEngine * /*p*/, qreal /*x*/, qreal /*y*/, const QTextItemInt & /*si*/) {}
       
   262 #endif
       
   263 
       
   264     QFontEngineFT(const QFontDef &fd);
       
   265     virtual ~QFontEngineFT();
       
   266 
       
   267     bool init(FaceId faceId, bool antiaalias, GlyphFormat defaultFormat = Format_None);
       
   268 
       
   269     virtual HB_Error getPointInOutline(HB_Glyph glyph, int flags, hb_uint32 point, HB_Fixed *xpos, HB_Fixed *ypos, hb_uint32 *nPoints);
       
   270 
       
   271 protected:
       
   272 
       
   273     void freeGlyphSets();
       
   274 
       
   275     virtual bool uploadGlyphToServer(QGlyphSet *set, uint glyphid, Glyph *g, GlyphInfo *info, int glyphDataSize) const;
       
   276     virtual unsigned long allocateServerGlyphSet();
       
   277     virtual void freeServerGlyphSet(unsigned long id);
       
   278 
       
   279     QFreetypeFace *freetype;
       
   280     int default_load_flags;
       
   281 
       
   282     enum HintStyle {
       
   283         HintNone,
       
   284         HintLight,
       
   285         HintMedium,
       
   286         HintFull
       
   287     };
       
   288 
       
   289     HintStyle default_hint_style;
       
   290 
       
   291     bool antialias;
       
   292     bool transform;
       
   293     SubpixelAntialiasingType subpixelType;
       
   294     int lcdFilterType;
       
   295     bool canUploadGlyphsToServer;
       
   296     bool embeddedbitmap;
       
   297 
       
   298 private:
       
   299     QFontEngineFT::Glyph *loadGlyphMetrics(QGlyphSet *set, uint glyph) const;
       
   300 
       
   301     GlyphFormat defaultFormat;
       
   302     FT_Matrix matrix;
       
   303 
       
   304     QList<QGlyphSet> transformedGlyphSets;
       
   305     mutable QGlyphSet defaultGlyphSet;
       
   306 
       
   307     QFontEngine::FaceId face_id;
       
   308 
       
   309     int xsize;
       
   310     int ysize;
       
   311 
       
   312     mutable QFixed lbearing;
       
   313     mutable QFixed rbearing;
       
   314     QFixed line_thickness;
       
   315     QFixed underline_position;
       
   316 
       
   317     FT_Size_Metrics metrics;
       
   318     mutable bool kerning_pairs_loaded;
       
   319 };
       
   320 
       
   321 QT_END_NAMESPACE
       
   322 
       
   323 #endif // QT_NO_FREETYPE
       
   324 
       
   325 #endif // QFONTENGINE_FT_P_H