KoFFWWSConverter.cpp File Reference

#include "KoFFWWSConverter.h"
#include <KisForest.h>
#include <KisStaticInitializer.h>
#include <kis_assert.h>
#include <hb.h>
#include <hb-ft.h>
#include <QFileInfo>
#include <KoWritingSystemUtils.h>
#include <KoCssTextUtils.h>

Go to the source code of this file.

Classes
struct	FontFamilyNode
struct	FontFamilySizeInfo
	The FontFamilySizeInfo class Some font-families have different designs for different sizes. These are largely differences in weight, spacing and small glyph changes. There's four places opentype stores the design size information: More...
struct	KoFFWWSConverter::Private

Functions
KoFontFamilyWWSRepresentation	createRepresentation (KisForest< FontFamilyNode >::child_iterator wws, KisForest< FontFamilyNode >::child_iterator typographic, bool singleFamily)
QVector< FontFamilyNode >	findNodesByAxis (const QVector< FontFamilyNode > &nodes, const QString axisTag, const qreal &value, const qreal &defaultValue, const qreal &defaultValueUpper)
QDebug	operator<< (QDebug dbg, const FontFamilyNode &node)
QDebug	operator<< (QDebug dbg, const FontFamilySizeInfo &info)
KisForest< FontFamilyNode >::composition_iterator	searchNodes (KisForest< FontFamilyNode >::composition_iterator it, KisForest< FontFamilyNode >::composition_iterator endIt, const QString family)

Variables
const QString	ITALIC_TAG = "ital"
const QString	OPTICAL_TAG = "opsz"
constexpr unsigned	OS2_BOLD = 1u << 5
	Is italic.
constexpr unsigned	OS2_ITALIC = 1u << 0
constexpr unsigned	OS2_OBLIQUE = 1u << 9
	Indicates that the given font is primarily a WWS family and requires no further processing.
constexpr unsigned	OS2_REGULAR = 1u << 6
	Is bold.
constexpr unsigned	OS2_USE_TYPO_METRICS = 1u << 7
constexpr unsigned	OS2_WWS = 1u << 8
	Is truly regular (instead of italic or oblique)
const QString	SLANT_TAG = "slnt"
const QString	WEIGHT_TAG = "wght"
const QString	WIDTH_TAG = "wdth"

Function Documentation

createRepresentation()

KoFontFamilyWWSRepresentation createRepresentation	(	KisForest< FontFamilyNode >::child_iterator	wws,
		KisForest< FontFamilyNode >::child_iterator	typographic,
		bool	singleFamily )

Definition at line 942 of file KoFFWWSConverter.cpp.

                                                                                                                                                                        {
    KoFontFamilyWWSRepresentation representation;
    representation.fontFamilyName = wws->fontFamily;
    representation.localizedFontFamilyNames = wws->localizedFontFamilies;
    if (!singleFamily)  {
        // This funnels the typographic family to the resource, so that resources may potentially be sorted by their typographic family.
        representation.typographicFamilyName = typographic->fontFamily;
        representation.localizedTypographicFamily = typographic->localizedFontFamilies;
        representation.localizedTypographicStyles = wws->localizedTypographicStyle;
    }
    representation.isVariable = wws->isVariable;
    representation.colorBitMap = wws->colorBitMap;
    representation.colorClrV0 = wws->colorClrV0;
    representation.colorClrV1 = wws->colorClrV1;
    representation.colorSVG = wws->colorSVG;
    representation.type = wws->type;
 
    for (auto subFamily = childBegin(wws); subFamily != childEnd(wws); subFamily++) {
        KoSvgText::FontFamilyStyleInfo style;
        if (subFamily == childBegin(wws)
                || representation.lastModified < subFamily->lastModified) {
            representation.lastModified = subFamily->lastModified;
        }
        representation.sampleStrings.insert(subFamily->sampleStrings);
        Q_FOREACH(const QLocale &locale, subFamily->supportedLanguages) {
            if (!representation.supportedLanguages.contains(locale)) {
                representation.supportedLanguages.append(locale);
            }
        }
 
        for (int a = 0; a < subFamily->axes.size(); a++) {
            QString key = subFamily->axes.keys().at(a);
            KoSvgText::FontFamilyAxis axis = subFamily->axes.value(key);
            KoSvgText::FontFamilyAxis mainAxis = representation.axes.value(key);
            mainAxis.min = qMin(mainAxis.min, axis.min);
            mainAxis.defaultValue = axis.defaultValue;
            mainAxis.max = qMax(mainAxis.max, axis.max);
            mainAxis.localizedLabels.insert(axis.localizedLabels);
            mainAxis.tag = axis.tag;
            mainAxis.axisHidden = axis.axisHidden;
            representation.axes.insert(mainAxis.tag, mainAxis);
 
            if (!subFamily->isVariable) {
                style.instanceCoords.insert(key, axis.value);
            }
        }
        if (!subFamily->isVariable) {
            if (!subFamily->localizedWWSStyle.isEmpty()) {
                style.localizedLabels = subFamily->localizedWWSStyle;
            } else if (!subFamily->localizedTypographicStyle.isEmpty()) {
                style.localizedLabels = subFamily->localizedTypographicStyle;
            } else if (!subFamily->localizedFontStyle.isEmpty()) {
                style.localizedLabels = subFamily->localizedFontStyle;
            } else {
                style.localizedLabels.insert(QLocale(QLocale::English), subFamily->fontStyle);
            }
            style.isItalic = subFamily->isItalic;
            style.isOblique = subFamily->isOblique;
            representation.styles.append(style);
        } else {
            for (int i = 0; i < subFamily->styleInfo.size(); i++) {
                KoSvgText::FontFamilyStyleInfo styleInfo = subFamily->styleInfo.at(i);
                if (!styleInfo.localizedLabels.isEmpty()) {
                    styleInfo.isItalic = subFamily->isItalic;
                    styleInfo.isOblique = subFamily->isOblique;
                    representation.styles.append(styleInfo);
                }
            }
        }
    }
    return representation;
}

References KoFontFamilyWWSRepresentation::axes, KoSvgText::FontFamilyAxis::axisHidden, KoFontFamilyWWSRepresentation::colorBitMap, KoFontFamilyWWSRepresentation::colorClrV0, KoFontFamilyWWSRepresentation::colorClrV1, KoFontFamilyWWSRepresentation::colorSVG, KoSvgText::FontFamilyAxis::defaultValue, KoFontFamilyWWSRepresentation::fontFamilyName, KoSvgText::FontFamilyStyleInfo::instanceCoords, KoSvgText::FontFamilyStyleInfo::isItalic, KoSvgText::FontFamilyStyleInfo::isOblique, KoFontFamilyWWSRepresentation::isVariable, KoFontFamilyWWSRepresentation::lastModified, KoFontFamilyWWSRepresentation::localizedFontFamilyNames, KoSvgText::FontFamilyAxis::localizedLabels, KoSvgText::FontFamilyStyleInfo::localizedLabels, KoFontFamilyWWSRepresentation::localizedTypographicFamily, KoFontFamilyWWSRepresentation::localizedTypographicStyles, KoSvgText::FontFamilyAxis::max, KoSvgText::FontFamilyAxis::min, KoFontFamilyWWSRepresentation::sampleStrings, KoFontFamilyWWSRepresentation::styles, KoFontFamilyWWSRepresentation::supportedLanguages, KoSvgText::FontFamilyAxis::tag, KoFontFamilyWWSRepresentation::type, KoFontFamilyWWSRepresentation::typographicFamilyName, and KoSvgText::FontFamilyAxis::value.

findNodesByAxis()

QVector< FontFamilyNode > findNodesByAxis	(	const QVector< FontFamilyNode > &	nodes,
		const QString	axisTag,
		const qreal &	value,
		const qreal &	defaultValue,
		const qreal &	defaultValueUpper )

Definition at line 1121 of file KoFFWWSConverter.cpp.

                                                                                                                                                                                    {
    QVector<FontFamilyNode> candidates;
    QVector<qreal> values;
    Q_FOREACH (const FontFamilyNode &node, nodes) {
        qreal selectingVal = defaultValue;
 
        if (node.axes.keys().contains(axisTag)) {
            KoSvgText::FontFamilyAxis axis = node.axes.value(axisTag);
            selectingVal = axis.value;
            if (axis.variableAxis) {
                if (value >= axis.min && value <= axis.max) {
                    candidates.append(node);
                    selectingVal = value;
                } else {
                    values.append(axis.min);
                    values.append(axis.max);
                }
                continue;
            }
            values.append(selectingVal);
        }
    }
    // We found some variable fonts already, so lets return early.
    if (!candidates.isEmpty()) {
        return candidates;
    }
 
    // follow the CSS Fonts selection mechanism.
    bool shouldNotReturnDefault = ((axisTag == ITALIC_TAG || axisTag == SLANT_TAG) && value != defaultValue);
    qreal selectedValue = KoCssTextUtils::cssSelectFontStyleValue(values, value, defaultValue, defaultValueUpper, shouldNotReturnDefault);
 
    Q_FOREACH (const FontFamilyNode &node, nodes) {
        if (node.axes.keys().contains(axisTag)) {
            KoSvgText::FontFamilyAxis axis = node.axes.value(axisTag);
            if (axis.value == selectedValue) {
                candidates.append(node);
            }
        } else if (value == defaultValue && !shouldNotReturnDefault) {
            candidates.append(node);
        }
    }
    return candidates;
}

References FontFamilyNode::axes, KoCssTextUtils::cssSelectFontStyleValue(), ITALIC_TAG, KoSvgText::FontFamilyAxis::max, KoSvgText::FontFamilyAxis::min, SLANT_TAG, KoSvgText::FontFamilyAxis::value, value(), and KoSvgText::FontFamilyAxis::variableAxis.

operator<<() [1/2]

QDebug operator<<	(	QDebug	dbg,
		const FontFamilyNode &	node )

Definition at line 218 of file KoFFWWSConverter.cpp.

                                                          {
    dbg.nospace() << node.debugInfo();
    return dbg.space();
}

References FontFamilyNode::debugInfo().

operator<<() [2/2]

QDebug operator<<	(	QDebug	dbg,
		const FontFamilySizeInfo &	info )

Definition at line 60 of file KoFFWWSConverter.cpp.

                                                              {
    dbg.nospace() << info.debugInfo();
    return dbg.space();
}

References FontFamilySizeInfo::debugInfo().

searchNodes()

KisForest< FontFamilyNode >::composition_iterator searchNodes	(	KisForest< FontFamilyNode >::composition_iterator	it,
		KisForest< FontFamilyNode >::composition_iterator	endIt,
		const QString	family )

Definition at line 1032 of file KoFFWWSConverter.cpp.

                                                                                                                                                                                        {
    QString familySimplified;
    // Qt's fontdatabase would add the vendor in [] behind the font name, when there were duplicates,
    // though sometimes there was no such explanation, so we should check against that...
    if (family.endsWith("]") && family.contains("[")) {
        familySimplified = family.split("[", Qt::SkipEmptyParts).first().trimmed();
    }
 
    auto presentInLocalizedNames = [&familySimplified, &family](const QHash<QLocale, QString> &localizedFontFamilies) {
        auto matchingLocalizedFamilyIt = std::find_if(
            localizedFontFamilies.begin(),
            localizedFontFamilies.end(),
            [&](const QString &localizedFamily) {
                return localizedFamily.contains(family, Qt::CaseInsensitive)
                    || (!familySimplified.isEmpty() && localizedFamily.contains(familySimplified, Qt::CaseInsensitive));
            });
 
        return matchingLocalizedFamilyIt != localizedFontFamilies.end();
    };
 
    for (; it != endIt; it++) {
        if (it.state() == KisForestDetail::Enter) {
            continue;
        }
 
        if (childBegin(it) == childEnd(it)) {
            if (
                // For the lowest nodes, we only want to test the full name.
                presentInLocalizedNames(it->localizedFullName)
 
                // For some fonts, the full name is the exact same as the typographic family name,
                // in which case, we want to ignore the full name.
                || presentInLocalizedNames(it->localizedFontFamilies)) {
 
                break;
            } else {
                continue;
            }
        }
 
        if (it->fontFamily.compare(family, Qt::CaseInsensitive) == 0
            || (!familySimplified.isEmpty() && it->fontFamily.compare(familySimplified, Qt::CaseInsensitive) == 0)
            || presentInLocalizedNames(it->localizedFontFamilies)) {
            break;
        }
    }
    return it;
}

References KisForestDetail::Enter, and KisForestDetail::CompositionIterator< T, is_const >::state().

Variable Documentation

ITALIC_TAG

const QString ITALIC_TAG = "ital"

Definition at line 281 of file KoFFWWSConverter.cpp.

OPTICAL_TAG

const QString OPTICAL_TAG = "opsz"

Definition at line 282 of file KoFFWWSConverter.cpp.

OS2_BOLD

constexpr unsigned OS2_BOLD = 1u << 5

constexpr

Is italic.

Definition at line 272 of file KoFFWWSConverter.cpp.

OS2_ITALIC

constexpr unsigned OS2_ITALIC = 1u << 0

constexpr

Definition at line 271 of file KoFFWWSConverter.cpp.

OS2_OBLIQUE

constexpr unsigned OS2_OBLIQUE = 1u << 9

constexpr

Indicates that the given font is primarily a WWS family and requires no further processing.

Definition at line 275 of file KoFFWWSConverter.cpp.

OS2_REGULAR

constexpr unsigned OS2_REGULAR = 1u << 6

constexpr

Is bold.

Definition at line 273 of file KoFFWWSConverter.cpp.

OS2_USE_TYPO_METRICS

constexpr unsigned OS2_USE_TYPO_METRICS = 1u << 7

constexpr

Definition at line 276 of file KoFFWWSConverter.cpp.

OS2_WWS

constexpr unsigned OS2_WWS = 1u << 8

constexpr

Is truly regular (instead of italic or oblique)

Definition at line 274 of file KoFFWWSConverter.cpp.

SLANT_TAG

const QString SLANT_TAG = "slnt"

Definition at line 280 of file KoFFWWSConverter.cpp.

WEIGHT_TAG

const QString WEIGHT_TAG = "wght"

Definition at line 278 of file KoFFWWSConverter.cpp.

WIDTH_TAG

const QString WIDTH_TAG = "wdth"

Definition at line 279 of file KoFFWWSConverter.cpp.