Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgssourcecache.h
       3                 :            :                          ---------------
       4                 :            :     begin                : July 2020
       5                 :            :     copyright            : (C) 2020 by Mathieu Pellerin
       6                 :            :     email                : nirvn dot asia at gmail dot com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #ifndef QGSSOURCECACHE_H
      19                 :            : #define QGSSOURCECACHE_H
      20                 :            : 
      21                 :            : #include "qgsabstractcontentcache.h"
      22                 :            : #include "qgis_sip.h"
      23                 :            : #include "qgis_core.h"
      24                 :            : 
      25                 :            : class QTemporaryDir;
      26                 :            : 
      27                 :            : #ifndef SIP_RUN
      28                 :            : 
      29                 :            : ///@cond PRIVATE
      30                 :            : 
      31                 :            : /**
      32                 :            :  * \ingroup core
      33                 :            :  * \class QgsSourceCacheEntry
      34                 :            :  * \brief An entry for a QgsSourceCache, representing a given source's file path
      35                 :            :  * \since QGIS 3.16
      36                 :            :  */
      37                 :          0 : class CORE_EXPORT QgsSourceCacheEntry : public QgsAbstractContentCacheEntry
      38                 :            : {
      39                 :            :   public:
      40                 :            : 
      41                 :            :     /**
      42                 :            :      * Constructor for QgsSourceCacheEntry, corresponding to the specified \a path.
      43                 :            :      */
      44                 :            :     QgsSourceCacheEntry( const QString &path ) ;
      45                 :            : 
      46                 :            :     //! The local file path of the source string
      47                 :            :     QString filePath;
      48                 :            : 
      49                 :            :     int dataSize() const override;
      50                 :            :     void dump() const override;
      51                 :            :     bool isEqual( const QgsAbstractContentCacheEntry *other ) const override;
      52                 :            : 
      53                 :            : };
      54                 :            : 
      55                 :            : ///@endcond
      56                 :            : #endif
      57                 :            : 
      58                 :            : /**
      59                 :            :  * \class QgsSourceCache
      60                 :            :  * \ingroup core
      61                 :            :  * \brief A cache for source strings that returns a local file path containing the source content.
      62                 :            :  *
      63                 :            :  * QgsSourceCache is not usually directly created, but rather accessed through
      64                 :            :  * QgsApplication::sourceCache().
      65                 :            :  *
      66                 :            :  * \since QGIS 3.16
      67                 :            : */
      68                 :            : #ifdef SIP_RUN
      69                 :            : class CORE_EXPORT QgsSourceCache : public QgsAbstractContentCacheBase // for sip we skip to the base class and avoid the template difficulty
      70                 :            : {
      71                 :            : #else
      72                 :            : class CORE_EXPORT QgsSourceCache : public QgsAbstractContentCache< QgsSourceCacheEntry >
      73                 :            : {
      74                 :            : #endif
      75                 :            :     Q_OBJECT
      76                 :            : 
      77                 :            :   public:
      78                 :            : 
      79                 :            :     /**
      80                 :            :      * Constructor for QgsSourceCache, with the specified \a parent object.
      81                 :            :      */
      82                 :            :     QgsSourceCache( QObject *parent SIP_TRANSFERTHIS = nullptr );
      83                 :            : 
      84                 :            :     /**
      85                 :            :      * Returns a local file path reflecting the content of a specified source \a path
      86                 :            :      *
      87                 :            :      * \a path may be a local file, remote (HTTP) url, or a base 64 encoded string (with a "base64:" prefix).
      88                 :            :      */
      89                 :            :     QString localFilePath( const QString &path, bool blocking = false );
      90                 :            : 
      91                 :            :   signals:
      92                 :            : 
      93                 :            :     /**
      94                 :            :      * Emitted when the cache has finished retrieving a 3D model from a remote \a url.
      95                 :            :      */
      96                 :            :     void remoteSourceFetched( const QString &url );
      97                 :            : 
      98                 :            :   private:
      99                 :            : 
     100                 :            :     QString fetchSource( const QString &path, bool &isBroken, bool blocking = false ) const;
     101                 :            : 
     102                 :            :     std::unique_ptr< QTemporaryDir > temporaryDir;
     103                 :            : };
     104                 :            : 
     105                 :            : #endif // QGSSOURCECACHE_H