/****************************************************************************

**

** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtGui module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef QFONTENGINE_FT_P_H

#define QFONTENGINE_FT_P_H

//

//  W A R N I N G

//  -------------

//

// This file is not part of the Qt API.  It exists purely as an

// implementation detail.  This header file may change from version to

// version without notice, or even be removed.

//

// We mean it.

//

#include "qfontengine_p.h"

#ifndef QT_NO_FREETYPE

#include <ft2build.h>

#include FT_FREETYPE_H

#if defined(Q_WS_X11)

#include <private/qt_x11_p.h>

#endif

#include <unistd.h>

#ifndef QT_NO_FONTCONFIG

#include <fontconfig/fontconfig.h>

#endif

#include <qmutex.h>

#include <harfbuzz-shaper.h>

QT_BEGIN_NAMESPACE

/*

 * This struct represents one font file on disk (like Arial.ttf) and is shared between all the font engines

 * that show this font file (at different pixel sizes).

 */

struct QFreetypeFace

{

    void computeSize(const QFontDef &fontDef, int *xsize, int *ysize, bool *outline_drawing);

    QFontEngine::Properties properties() const;

    bool getSfntTable(uint tag, uchar *buffer, uint *length) const;

    static QFreetypeFace *getFace(const QFontEngine::FaceId &face_id);

    void release(const QFontEngine::FaceId &face_id);

    // locks the struct for usage. Any read/write operations require locking.

    void lock()

    {

        _lock.lock();

    }

    void unlock()

    {

        _lock.unlock();

    }

    FT_Face face;

    HB_Face hbFace;

#ifndef QT_NO_FONTCONFIG

    FcCharSet *charset;

#endif

    int xsize; // 26.6

    int ysize; // 26.6

    FT_Matrix matrix;

    FT_CharMap unicode_map;

    FT_CharMap symbol_map;

    enum { cmapCacheSize = 0x200 };

    glyph_t cmapCache[cmapCacheSize];

    int fsType() const;

    HB_Error getPointInOutline(HB_Glyph glyph, int flags, hb_uint32 point, HB_Fixed *xpos, HB_Fixed *ypos, hb_uint32 *nPoints);

    static void addGlyphToPath(FT_Face face, FT_GlyphSlot g, const QFixedPoint &point, QPainterPath *path, FT_Fixed x_scale, FT_Fixed y_scale);

    static void addBitmapToPath(FT_GlyphSlot slot, const QFixedPoint &point, QPainterPath *path, bool = false);

private:

    friend class QScopedPointerDeleter<QFreetypeFace>;

    QFreetypeFace() : _lock(QMutex::Recursive) {}

    ~QFreetypeFace() {}

    QAtomicInt ref;

    QMutex _lock;

    QByteArray fontData;

};

class Q_GUI_EXPORT QFontEngineFT : public QFontEngine

{

public:

    enum GlyphFormat {

        Format_None,

        Format_Render = Format_None,

        Format_Mono,

        Format_A8,

        Format_A32

    };

    /* we don't cache glyphs that are too large anyway, so we can make this struct rather small */

    struct Glyph {

        ~Glyph();

        short linearAdvance;

        unsigned char width;

        unsigned char height;

        signed char x;

        signed char y;

        signed char advance;

        signed char format;

        uchar *data;

        unsigned int uploadedToServer : 1;

    };

    enum SubpixelAntialiasingType {

        Subpixel_None,

        Subpixel_RGB,

        Subpixel_BGR,

        Subpixel_VRGB,

        Subpixel_VBGR

    };

#if defined(Q_WS_X11) && !defined(QT_NO_XRENDER)

    typedef XGlyphInfo GlyphInfo;

#else

    struct GlyphInfo {

        unsigned short  width;

        unsigned short  height;

        short           x;

        short           y;

        short           xOff;

        short           yOff;

    };

#endif

    struct QGlyphSet

    {

        QGlyphSet();

        ~QGlyphSet();

        FT_Matrix transformationMatrix;

        unsigned long id; // server sided id, GlyphSet for X11

        bool outline_drawing;

        mutable QHash<int, Glyph *> glyph_data; // maps from glyph index to glyph data

    };

    virtual QFontEngine::FaceId faceId() const;

    virtual QFontEngine::Properties properties() const;

    virtual QFixed emSquareSize() const;

    virtual bool getSfntTableData(uint tag, uchar *buffer, uint *length) const;

    virtual int synthesized() const;

    virtual QFixed ascent() const;

    virtual QFixed descent() const;

    virtual QFixed leading() const;

    virtual QFixed xHeight() const;

    virtual QFixed averageCharWidth() const;

    virtual qreal maxCharWidth() const;

    virtual qreal minLeftBearing() const;

    virtual qreal minRightBearing() const;

    virtual QFixed lineThickness() const;

    virtual QFixed underlinePosition() const;

    void doKerning(QGlyphLayout *, QTextEngine::ShaperFlags) const;

    inline virtual Type type() const

    { return QFontEngine::Freetype; }

    inline virtual const char *name() const

    { return "freetype"; }

    virtual void getUnscaledGlyph(glyph_t glyph, QPainterPath *path, glyph_metrics_t *metrics);

    virtual bool canRender(const QChar *string, int len);

    virtual void addGlyphsToPath(glyph_t *glyphs, QFixedPoint *positions, int nglyphs,

                         QPainterPath *path, QTextItem::RenderFlags flags);

    virtual void addOutlineToPath(qreal x, qreal y, const QGlyphLayout &glyphs,

                          QPainterPath *path, QTextItem::RenderFlags flags);

    virtual bool stringToCMap(const QChar *str, int len, QGlyphLayout *glyphs, int *nglyphs,

                      QTextEngine::ShaperFlags flags) const;

    virtual glyph_metrics_t boundingBox(const QGlyphLayout &glyphs);

    virtual glyph_metrics_t boundingBox(glyph_t glyph);

    virtual glyph_metrics_t boundingBox(glyph_t glyph, const QTransform &matrix);

    virtual void recalcAdvances(QGlyphLayout *glyphs, QTextEngine::ShaperFlags flags) const;

    virtual QImage alphaMapForGlyph(glyph_t);

    virtual QImage alphaRGBMapForGlyph(glyph_t, int margin, const QTransform &t);

    virtual void removeGlyphFromCache(glyph_t glyph);

    virtual int glyphCount() const;

    enum Scaling {

        Scaled,

        Unscaled

    };

    FT_Face lockFace(Scaling scale = Scaled) const;

    void unlockFace() const;

    FT_Face non_locked_face() const;

    inline bool drawAntialiased() const { return antialias; }

    inline bool invalid() const { return xsize == 0 && ysize == 0; }

    inline bool isBitmapFont() const { return defaultFormat == Format_Mono; }

    inline Glyph *loadGlyph(uint glyph, GlyphFormat format = Format_None, bool fetchMetricsOnly = false) const

    { return loadGlyph(&defaultGlyphSet, glyph, format, fetchMetricsOnly); }

    Glyph *loadGlyph(QGlyphSet *set, uint glyph, GlyphFormat = Format_None, bool fetchMetricsOnly = false) const;

    QGlyphSet *defaultGlyphs() { return &defaultGlyphSet; }

    GlyphFormat defaultGlyphFormat() const { return defaultFormat; }

    inline Glyph *cachedGlyph(glyph_t g) const { return defaultGlyphSet.glyph_data.value(g); }

    QGlyphSet *loadTransformedGlyphSet(const QTransform &matrix);

    bool loadGlyphs(QGlyphSet *gs, glyph_t *glyphs, int num_glyphs, GlyphFormat format = Format_Render);

#if defined(Q_WS_QWS) || defined(Q_OS_SYMBIAN)

    virtual void draw(QPaintEngine * /*p*/, qreal /*x*/, qreal /*y*/, const QTextItemInt & /*si*/) {}

#endif

    QFontEngineFT(const QFontDef &fd);

    virtual ~QFontEngineFT();

    bool init(FaceId faceId, bool antiaalias, GlyphFormat defaultFormat = Format_None);

    virtual HB_Error getPointInOutline(HB_Glyph glyph, int flags, hb_uint32 point, HB_Fixed *xpos, HB_Fixed *ypos, hb_uint32 *nPoints);

protected:

    void freeGlyphSets();

    virtual bool uploadGlyphToServer(QGlyphSet *set, uint glyphid, Glyph *g, GlyphInfo *info, int glyphDataSize) const;

    virtual unsigned long allocateServerGlyphSet();

    virtual void freeServerGlyphSet(unsigned long id);

    QFreetypeFace *freetype;

    int default_load_flags;

    enum HintStyle {

        HintNone,

        HintLight,

        HintMedium,

        HintFull

    };

    HintStyle default_hint_style;

    bool antialias;

    bool transform;

    SubpixelAntialiasingType subpixelType;

    int lcdFilterType;

    bool canUploadGlyphsToServer;

    bool embeddedbitmap;

private:

    QFontEngineFT::Glyph *loadGlyphMetrics(QGlyphSet *set, uint glyph) const;

    GlyphFormat defaultFormat;

    FT_Matrix matrix;

    QList<QGlyphSet> transformedGlyphSets;

    mutable QGlyphSet defaultGlyphSet;

    QFontEngine::FaceId face_id;

    int xsize;

    int ysize;

    mutable QFixed lbearing;

    mutable QFixed rbearing;

    QFixed line_thickness;

    QFixed underline_position;

    FT_Size_Metrics metrics;

    mutable bool kerning_pairs_loaded;

};

QT_END_NAMESPACE

#endif // QT_NO_FREETYPE

#endif // QFONTENGINE_FT_P_H