scface.h

/*
For general Scribus (>=1.3.2) copyright and licensing information please refer
to the COPYING file provided with the program. Following this notice may exist
a copyright and/or license notice that predates the release of Scribus 1.3.2
for which a new license (GPL+exception) is in place.
*/

#ifndef SC_FACE_H
#define SC_FACE_H

/* ScFace responsibilities:

font storage: type, format, filepath, index, document-local, substitute, etc.
usage:        use, embed, subset, ...
face info:    family, effect, alternative, flags, charset
encoding:     CMap2String, glyphnames, 
metrics:      cwidth, bearing, bbox, "real" widths, paths
opentype:     apply features, script support (-)
embedding:    fontdictionary, rawdata, embedPS, embedPDF, subsetPS, subsetPDF
virtual:      dispatch to constituents, handle embedding (-)
*/

#include <QHash>
#include <QMap>
#include <QString>
#include <utility>

#include "fpointarray.h"



struct GlyphMetrics {
    qreal width;
    qreal ascent;
    qreal descent;
};



class SCRIBUS_API ScFace
{
public:
    enum Status  { UNKNOWN, LOADED, CHECKED, BROKENGLYPHS, BROKEN, NULLFACE };
    enum FontType { TYPE0, TYPE1, TYPE3, TTF, CFF, OTF, UNKNOWN_TYPE };
    enum FontFormat { PFA, PFB, TYPE2, TYPE42,
        // handled by freetype: PFB_MAC, DFONT, HQX, MACBIN,
        SFNT, TTCF, UNKNOWN_FORMAT };

    typedef uint gid_type;
    typedef uint ucs4_type;
    typedef QMap<gid_type, std::pair<ucs4_type, QString> > FaceEncoding;

    static const gid_type CONTROL_GLYPHS = 2000000000; // 2 billion

    struct GlyphData { 
        FPointArray Outlines;
        qreal x;
        qreal y;
        qreal bbox_width;
        qreal bbox_ascent;
        qreal bbox_descent;
        bool broken;
        GlyphData() : Outlines(), x(0), y(0), bbox_width(1), bbox_ascent(1), bbox_descent(0), broken(true) {}
    };

    
    class ScFaceData {
    public:
        mutable int refs;
        mutable int usage;

        QString scName;
        QString fontFile;
        int     faceIndex;
        QString psName;
        QString family;
        QString style;
        QString variant;

        QString forDocument;

        mutable ScFace::Status status;
        ScFace::FontType typeCode;
        ScFace::FontFormat formatCode;

        bool usable;
        bool embedPs;
        bool subset;
        bool outline;

        bool isStroked;
        bool isFixedPitch;
        bool hasGlyphNames;
        gid_type maxGlyph;

        ScFaceData();
        virtual ~ScFaceData() { };
    protected:

        friend class ScFace;
        Status cachedStatus;

        // caches
        mutable QHash<gid_type, qreal>     m_glyphWidth;
        mutable QHash<gid_type, GlyphData> m_glyphOutline;
        //mutable QHash<gid_type, uint>      m_cMap;

        // fill caches & members

        virtual void load()             const 
        { 
            m_glyphWidth.clear();
            m_glyphOutline.clear();
            //m_cMap.clear();

            status = qMax(cachedStatus, ScFace::LOADED);
        }

        virtual void unload()           const 
        {
            m_glyphWidth.clear();
            m_glyphOutline.clear();
            //m_cMap.clear();

            status = ScFace::UNKNOWN;
        }

        virtual void loadGlyph(gid_type /*gl*/) const {}

        // dummy implementations
        virtual qreal ascent(qreal sz)           const { return sz; }
        virtual QString pdfAscentAsString()      const { return "0" ; }
        virtual QString pdfDescentAsString()     const { return "0"; }
        virtual QString pdfCapHeightAsString()   const { return "0"; }
        virtual QString pdfFontBBoxAsString()    const { return "0 0 0 0"; }
        virtual QString italicAngleAsString()    const { return "0"; }
        virtual qreal descent(qreal /*sz*/)      const { return 0.0; }
        virtual qreal xHeight(qreal sz)          const { return sz; }
        virtual qreal capHeight(qreal sz)        const { return sz; }
        virtual qreal height(qreal sz)           const { return sz; }
        virtual qreal strikeoutPos(qreal sz)     const { return sz / 2; }
        virtual qreal underlinePos(qreal /*sz*/)     const { return -1.0; }
        virtual qreal strokeWidth(qreal /*sz*/)      const { return 0.1; }
        virtual qreal maxAdvanceWidth(qreal sz)  const { return sz; }
        virtual gid_type char2CMap(QChar /*ch*/)         const { return 0; }
        virtual qreal glyphKerning(gid_type gl1, gid_type gl2, qreal sz) const;
        virtual QMap<QString,QString> fontDictionary(qreal sz=1.0) const;
        virtual GlyphMetrics glyphBBox(gid_type gl, qreal sz) const;
        virtual bool EmbedFont(QByteArray &/*str*/)       const { return false; }
        virtual void RawData(QByteArray & /*bb*/)      const {}

        virtual bool hasNames() const { return hasGlyphNames; }
        virtual bool glyphNames(QMap<gid_type, std::pair<ucs4_type, QString> >& gList) const;

        // these use the cache:
        virtual qreal       glyphWidth(gid_type gl, qreal sz)   const;
        virtual FPointArray glyphOutline(gid_type gl, qreal sz) const;
        virtual FPoint      glyphOrigin (gid_type gl, qreal sz) const;

        virtual bool isSymbolic() const { return false; }
    };



    ScFace();
    ScFace(const ScFace& other);
    ~ScFace();

    static const ScFace& none();

    bool isNone() const   { return m->status == NULLFACE; }

    bool isSymbolic() const;

    ScFace& operator=(const ScFace& other);
    bool operator==(const ScFace& other) const ;
    bool operator!=(const ScFace& other) const { return ! (*this == other); }


    bool EmbedFont(QByteArray &str);
    void RawData(QByteArray & bb);
    bool glyphNames(QMap<gid_type, std::pair<ucs4_type, QString> >& gList);

    void increaseUsage() const;

    void decreaseUsage() const;

    void unload()      const;

    QString scName()   const { return replacedName.isEmpty() ? m->scName : replacedName; }

    QString replacementName()   const { return m->scName; }

    QString replacementForDoc()   const { return replacedInDoc; }

    bool isReplacement()   const { return !replacedName.isEmpty(); }

    ScFace mkReplacementFor(QString name, QString doc) { 
        ScFace result(m); 
        result.replacedName = name; 
        result.replacedInDoc = doc; 
        return result; 
    }

    void chReplacementTo(ScFace& other, QString doc) { 
        QString oldName = replacedName;
        (*this) = other;
        replacedName = oldName;
        replacedInDoc = doc; 
    }

    QString psName()   const { return m->psName; }

    QString fontPath() const { return m->faceIndex >= 0 ? QString("%1(%2)").arg(m->fontFile).arg(m->faceIndex+1) : m->fontFile; }

    QString fontFilePath()      const { return m->fontFile; }

    int faceIndex()    const { return m->faceIndex; }

    QString localForDocument()  const { return m->forDocument; }

    FontType type()    const { return m->typeCode; }

    FontFormat format()const { return m->formatCode; }

    bool usable()      const { return m->usable && !isNone(); }

    bool outline()      const { return usable() && m->outline; }
    
    bool embedPs()     const { return m->embedPs && m->status < BROKENGLYPHS; }

    bool subset()      const { return m->subset && m->status < BROKEN; }

    void usable(bool flag)   { m->usable = flag; }
    void embedPs(bool flag)  { m->embedPs = flag; }
    void subset(bool flag)   { m->subset = flag; }
    void outline(bool flag)   { m->outline = flag; }

    bool hasNames()    const { return m->hasNames(); }

    bool isStroked()   const { return m->isStroked; }

    bool isFixedPitch()const { return m->isFixedPitch; }

    bool isOTF()       const { return m->typeCode == OTF; }

    gid_type maxGlyph() const { return m->maxGlyph; }

    QString family()   const { return m->family; }

    QString style()    const { return m->style; }

    QString variant()  const { return m->variant; }

    // font metrics
    QString pdfAscentAsString()      const;
    QString pdfDescentAsString()     const;
    QString pdfCapHeightAsString()   const;
    QString pdfFontBBoxAsString()    const;
    QString italicAngleAsString()    const;
    qreal ascent(qreal sz=1.0)          const;
    qreal descent(qreal sz=1.0)         const;
    qreal xHeight(qreal sz=1.0)         const;
    qreal capHeight(qreal sz=1.0)       const;
    qreal height(qreal sz=1.0)          const;
    qreal strikeoutPos(qreal sz=1.0)    const;
    qreal underlinePos(qreal sz=1.0)    const;
    qreal strokeWidth(qreal sz=1.0)     const;
    qreal maxAdvanceWidth(qreal sz=1.0) const;

    QString stemV(qreal sz=1.0)    const { return fontDictionary(sz)["/StemV"]; }

    QString italicAngle(qreal sz=1.0)      const { return fontDictionary(sz)["/ItalicAngle"]; }

    QString fontBBox(qreal sz=1.0)         const { return fontDictionary(sz)["/FontBBox"]; }

    QMap<QString,QString> fontDictionary(qreal sz=1.0) const { return m->fontDictionary(sz); }
    // glyph interface

    qreal glyphWidth(gid_type gl, qreal sz=1.0) const { return m->glyphWidth(gl, sz); }

    qreal glyphKerning(gid_type gl1, gid_type gl2, qreal sz=1.0) const { return qMax(gl1,gl2) < CONTROL_GLYPHS ? m->glyphKerning(gl1, gl2, sz) : 0; }

    GlyphMetrics glyphBBox(gid_type gl, qreal sz=1.0) const { return m->glyphBBox(gl, sz); }

    FPointArray glyphOutline(gid_type gl, qreal sz=1.0) const { return m->glyphOutline(gl, sz); }

    FPoint glyphOrigin(gid_type gl, qreal sz=1.0)    const { return m->glyphOrigin(gl, sz); }

    // char interface

    bool canRender(QChar ch)   const;

    gid_type char2CMap(QChar ch)   const;

    qreal charWidth(QChar ch, qreal sz=1.0, QChar ch2 = QChar(0)) const;

    qreal realCharWidth(QChar ch, qreal sz=1.0) const { return glyphBBox(char2CMap(ch),sz).width; }

    qreal realCharHeight(QChar ch, qreal sz=1.0) const { GlyphMetrics gm=glyphBBox(char2CMap(ch),sz); return gm.ascent + gm.descent; }

    qreal realCharAscent(QChar ch, qreal sz=1.0) const { return glyphBBox(char2CMap(ch),sz).ascent; }

    qreal realCharDescent(QChar ch, qreal sz=1.0) const { return glyphBBox(char2CMap(ch),sz).descent; }

private:

    friend class SCFonts;

    ScFace(ScFaceData* md);
    ScFaceData* m;
    QString replacedName;
    QString replacedInDoc;

    void initFaceData();
    void checkAllGlyphs();
    gid_type emulateGlyph(QChar c) const;
};

#endif