qgsfontmanager.h

Go to the documentation of this file.

/***************************************************************************
    qgsfontmanager.h
    ------------------
    Date                 : June 2022
    Copyright            : (C) 2022 Nyall Dawson
    Email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSFONTMANAGER_H
#define QGSFONTMANAGER_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgssettingsentryimpl.h"
#include "qgstaskmanager.h"
 
#include <QMap>
#include <QObject>
#include <QReadWriteLock>
#include <QSet>

class CORE_EXPORT QgsFontDownloadDetails
{
  public:

    QgsFontDownloadDetails();

    QgsFontDownloadDetails( const QString &family, const QStringList &fontUrls, const QString &licenseUrl = QString() );

    static QString standardizeFamily( const QString &family );

    bool isValid() const { return !mFontUrls.empty(); }

    QString family() const { return mFamily; }

    QString standardizedFamily() const { return mStandardizedFamily; }

    QStringList fontUrls() const { return mFontUrls; }

    QString licenseUrl() const { return mLicenseUrl; }
 
  private:
 
    QString mFamily;
    QString mStandardizedFamily;
    QStringList mFontUrls;
    QString mLicenseUrl;
};
 
#ifndef SIP_RUN
class CORE_EXPORT QgsFontDownloadTask : public QgsTask
{
    Q_OBJECT
 
  public:
 
    QgsFontDownloadTask( const QString &description, const QgsFontDownloadDetails &details );
 
    bool run() override;
    void cancel() override;
    QString errorMessage() const { return mErrorMessage; }
    QString failedUrl() const { return mFailedUrl; }
    QList< QByteArray > fontData() const { return mFontData; }
    QByteArray licenseData() const { return mLicenseData; }
    QStringList contentDispositionFilenames() const { return mContentDispositionFilenames; }
  private:
 
    QgsFontDownloadDetails mDetails;
    std::unique_ptr< QgsFeedback > mFeedback;
    bool mResult = false;
    QString mErrorMessage;
    QString mFailedUrl;
    QList< QByteArray > mFontData;
    QStringList mContentDispositionFilenames;
    QByteArray mLicenseData;
 
};
#endif

class CORE_EXPORT QgsFontManager : public QObject
{
    Q_OBJECT
 
  public:
 
#ifndef SIP_RUN
    static const QgsSettingsEntryStringList *settingsFontFamilyReplacements;

    static const QgsSettingsEntryBool *settingsDownloadMissingFonts;
#endif

    explicit QgsFontManager( QObject *parent SIP_TRANSFERTHIS = nullptr );

    QMap< QString, QString > fontFamilyReplacements() const;

    void addFontFamilyReplacement( const QString &original, const QString &replacement );

    void setFontFamilyReplacements( const QMap< QString, QString> &replacements );

    QString processFontFamilyName( const QString &name ) const;

    void installUserFonts() SIP_SKIP;

    bool tryToDownloadFontFamily( const QString &family, QString &matchedFamily SIP_OUT );

    void enableFontDownloadsForSession();

    Q_DECL_DEPRECATED QString urlForFontDownload( const QString &family, QString &matchedFamily SIP_OUT ) const SIP_DEPRECATED;

    QgsFontDownloadDetails detailsForFontDownload( const QString &family, QString &matchedFamily SIP_OUT ) const;

    Q_DECL_DEPRECATED void downloadAndInstallFont( const QUrl &url, const QString &identifier = QString() ) SIP_DEPRECATED;

    void downloadAndInstallFont( const QgsFontDownloadDetails &details, const QString &identifier = QString() );

    bool installFontsFromData( const QByteArray &data, QString &errorMessage SIP_OUT, QStringList &families SIP_OUT, QString &licenseDetails SIP_OUT, const QString &filename = QString(), const QString &extension = QString() );

    void addUserFontDirectory( const QString &directory );

    QMap< QString, QStringList > userFontToFamilyMap() const;

    bool removeUserFont( const QString &path );
 
  signals:

    void fontDownloaded( const QStringList &families, const QString &licenseDetails );

    void fontDownloadErrorOccurred( const QUrl &url, const QString &identifier, const QString &error );
 
  private:
 
    QMap< QString, QString > mFamilyReplacements;
    QMap< QString, QString > mLowerCaseFamilyReplacements;
    QMap< QString, QStringList > mUserFontToFamilyMap;
    QMap< QString, int > mUserFontToIdMap;
    mutable QReadWriteLock mReplacementLock;
    QStringList mUserFontDirectories;
 
    bool mEnableFontDownloads = false;
    QMap< QString, QString > mPendingFontDownloads;
    QMap< QString, QgsFontDownloadDetails > mDeferredFontDownloads;
 
    void storeFamilyReplacements();
    void installFontsFromDirectory( const QString &dir );
};
 
#endif // QGSFONTMANAGER_H