qgssvgcache.h

Go to the documentation of this file.

/***************************************************************************
                              qgssvgcache.h
                            ------------------------------
  begin                :  2011
  copyright            : (C) 2011 by Marco Hugentobler
  email                : marco dot hugentobler at sourcepole dot ch
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSSVGCACHE_H
#define QGSSVGCACHE_H
 
#include "qgis.h"
#include "qgsabstractcontentcache.h"
 
#include <QPicture>
 
class QDomElement;
 
#ifndef SIP_RUN


class CORE_EXPORT QgsSvgCacheEntry : public QgsAbstractContentCacheEntry
{
  public:
    QgsSvgCacheEntry(
      const QString &path,
      double size,
      double strokeWidth,
      double widthScaleFactor,
      const QColor &fill,
      const QColor &stroke,
      double fixedAspectRatio = 0,
      const QMap<QString, QString> &parameters = QMap<QString, QString>()
    );
 
    QgsSvgCacheEntry( const QgsSvgCacheEntry &rh ) = delete;
    QgsSvgCacheEntry &operator=( const QgsSvgCacheEntry &rh ) = delete;
 
    double size = 0.0; //size in pixels (cast to int for QImage)
    double strokeWidth = 0;
    double widthScaleFactor = 1.0;

    double fixedAspectRatio = 0;

    QSizeF viewboxSize;
 
    QColor fill = Qt::black;
    QColor stroke = Qt::black;
    QMap<QString, QString> parameters;
 
    std::unique_ptr< QImage > image;
    std::unique_ptr< QPicture > picture;
    //content (with params replaced)
    QByteArray svgContent;

    bool isMissingImage = false;
 
    bool isEqual( const QgsAbstractContentCacheEntry *other ) const override;
    int dataSize() const override;
    void dump() const override;
};

#endif

#ifdef SIP_RUN
class CORE_EXPORT QgsSvgCache : public QgsAbstractContentCacheBase // for sip we skip to the base class and avoid the template difficulty
{
#else
class CORE_EXPORT QgsSvgCache : public QgsAbstractContentCache< QgsSvgCacheEntry >
{
#endif
    Q_OBJECT
 
  public:
    QgsSvgCache( QObject *parent SIP_TRANSFERTHIS = nullptr );

    QImage svgAsImage(
      const QString &path,
      double size,
      const QColor &fill,
      const QColor &stroke,
      double strokeWidth,
      double widthScaleFactor,
      bool &fitsInCache,
      double fixedAspectRatio = 0,
      bool blocking = false,
      const QMap<QString, QString> &parameters = QMap<QString, QString>()
    );

    QPicture svgAsPicture(
      const QString &path,
      double size,
      const QColor &fill,
      const QColor &stroke,
      double strokeWidth,
      double widthScaleFactor,
      bool forceVectorOutput = false,
      double fixedAspectRatio = 0,
      bool blocking = false,
      const QMap<QString, QString> &parameters = QMap<QString, QString>()
    );

    QSizeF svgViewboxSize(
      const QString &path,
      double size,
      const QColor &fill,
      const QColor &stroke,
      double strokeWidth,
      double widthScaleFactor,
      double fixedAspectRatio = 0,
      bool blocking = false,
      const QMap<QString, QString> &parameters = QMap<QString, QString>()
    );

    void containsParams(
      const QString &path, bool &hasFillParam, QColor &defaultFillColor, bool &hasStrokeParam, QColor &defaultStrokeColor, bool &hasStrokeWidthParam, double &defaultStrokeWidth, bool blocking = false
    ) const;

    void containsParams(
      const QString &path,
      bool &hasFillParam,
      bool &hasDefaultFillParam,
      QColor &defaultFillColor,
      bool &hasFillOpacityParam,
      bool &hasDefaultFillOpacity,
      double &defaultFillOpacity,
      bool &hasStrokeParam,
      bool &hasDefaultStrokeColor,
      QColor &defaultStrokeColor,
      bool &hasStrokeWidthParam,
      bool &hasDefaultStrokeWidth,
      double &defaultStrokeWidth,
      bool &hasStrokeOpacityParam,
      bool &hasDefaultStrokeOpacity,
      double &defaultStrokeOpacity,
      bool blocking = false
    ) const SIP_PYNAME( containsParamsV3 );

    QByteArray getImageData( const QString &path, bool blocking = false ) const;

#ifndef SIP_RUN
    QByteArray svgContent(
      const QString &path,
      double size,
      const QColor &fill,
      const QColor &stroke,
      double strokeWidth,
      double widthScaleFactor,
      double fixedAspectRatio = 0,
      bool blocking = false,
      const QMap<QString, QString> &parameters = QMap<QString, QString>(),
      bool *isMissingImage = nullptr
    );
#else
    QByteArray svgContent(
      const QString &path,
      double size,
      const QColor &fill,
      const QColor &stroke,
      double strokeWidth,
      double widthScaleFactor,
      double fixedAspectRatio = 0,
      bool blocking = false,
      const QMap<QString, QString> &parameters = QMap<QString, QString>()
    );
#endif
 
  signals:

    Q_DECL_DEPRECATED void statusChanged( const QString &statusQString ) SIP_DEPRECATED;

    void remoteSvgFetched( const QString &url );
 
  protected:
    bool checkReply( QNetworkReply *reply, const QString &path ) const override;
 
  private:
    void replaceParamsAndCacheSvg( QgsSvgCacheEntry *entry, bool blocking = false );
    void cacheImage( QgsSvgCacheEntry *entry );
    void cachePicture( QgsSvgCacheEntry *entry, bool forceVectorOutput = false );
    QgsSvgCacheEntry *cacheEntry(
      const QString &path,
      double size,
      const QColor &fill,
      const QColor &stroke,
      double strokeWidth,
      double widthScaleFactor,
      double fixedAspectRatio = 0,
      const QMap<QString, QString> &parameters = QMap<QString, QString>(),
      bool blocking = false,
      bool *isMissingImage = nullptr
    );

    void replaceElemParams( QDomElement &elem, const QColor &fill, const QColor &stroke, double strokeWidth, const QMap<QString, QString> &parameters );
 
    void containsElemParams(
      const QDomElement &elem,
      bool &hasFillParam,
      bool &hasDefaultFill,
      QColor &defaultFill,
      bool &hasFillOpacityParam,
      bool &hasDefaultFillOpacity,
      double &defaultFillOpacity,
      bool &hasStrokeParam,
      bool &hasDefaultStroke,
      QColor &defaultStroke,
      bool &hasStrokeWidthParam,
      bool &hasDefaultStrokeWidth,
      double &defaultStrokeWidth,
      bool &hasStrokeOpacityParam,
      bool &hasDefaultStrokeOpacity,
      double &defaultStrokeOpacity
    ) const SIP_PYNAME( containsParamsV3 );

    double calcSizeScaleFactor( QgsSvgCacheEntry *entry, const QDomElement &docElem, QSizeF &viewboxSize ) const;

    QSize sizeForImage( const QgsSvgCacheEntry &entry, QSizeF &viewBoxSize, QSizeF &scaledSize ) const;

    QImage imageFromCachedPicture( const QgsSvgCacheEntry &entry ) const;

    QByteArray mMissingSvg;
 
    QByteArray mFetchingSvg;
 
    friend class TestQgsSvgCache;
};
 
#endif // QGSSVGCACHE_H