qgsapplication.h

Go to the documentation of this file.

/***************************************************************************
    qgsapplication.h - Accessors for application-wide data
     --------------------------------------
    Date                 : 02-Jan-2006
    Copyright            : (C) 2006 by Tom Elwertowski
    Email                : telwertowski at users dot sourceforge dot net
 ***************************************************************************
 *                                                                         *
 *   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 QGSAPPLICATION_H
#define QGSAPPLICATION_H
 
#include "qgsconfig.h"
 
#include <memory>
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgssettingsentryimpl.h"
#include "qgstranslationcontext.h"
 
#include <QApplication>
#include <QColor>
#include <QEvent>
#include <QStringList>
 
class QgsSettingsRegistryCore;
class Qgs3DRendererRegistry;
class QgsActionScopeRegistry;
class QgsAnnotationItemRegistry;
class QgsAuthConfigurationStorageRegistry;
class QgsRuntimeProfiler;
class QgsTaskManager;
class QgsFieldFormatterRegistry;
class QgsColorSchemeRegistry;
class QgsPaintEffectRegistry;
class QgsProjectStorageRegistry;
class QgsExternalStorageRegistry;
class QgsLocalizedDataPathRegistry;
class QgsLayerMetadataProviderRegistry;
class QgsRendererRegistry;
class QgsSvgCache;
class QgsImageCache;
class QgsSourceCache;
class QgsSymbolLayerRegistry;
class QgsRasterRendererRegistry;
class QgsGpsConnectionRegistry;
class QgsBabelFormatRegistry;
class QgsDataItemProviderRegistry;
class QgsPluginLayerRegistry;
class QgsClassificationMethodRegistry;
class QgsMessageLog;
class QgsProcessingRegistry;
class QgsAnnotationRegistry;
class QgsApplicationThemeRegistry;
class QgsUserProfile;
class QgsPageSizeRegistry;
class QgsLayoutItemRegistry;
class QgsAuthManager;
class QgsNetworkContentFetcherRegistry;
class QgsValidityCheckRegistry;
class QTranslator;
class QgsCalloutRegistry;
class QgsPlotRegistry;
class QgsBookmarkManager;
class QgsStyleModel;
class QgsNumericFormatRegistry;
class QgsConnectionRegistry;
class QgsScaleBarRendererRegistry;
class Qgs3DSymbolRegistry;
class QgsPointCloudRendererRegistry;
class QgsTiledSceneRendererRegistry;
class QgsTileDownloadManager;
class QgsCoordinateReferenceSystemRegistry;
class QgsRecentStyleHandler;
class QgsDatabaseQueryLog;
class QgsFontManager;
class QgsSensorRegistry;
class QgsProfileSourceRegistry;
class QgsLabelingEngineRuleRegistry;
 
// clang-format off
class CORE_EXPORT QgsApplication : public QApplication
{
// clang-format on
#ifdef SIP_RUN
  // clang-format off
    % TypeCode
    // Convert a Python argv list to a conventional C argc count and argv array.
    static char **qtgui_ArgvToC( PyObject *argvlist, int &argc )
    {
      char **argv;
 
      argc = PyList_GET_SIZE( argvlist );
 
      // Allocate space for two copies of the argument pointers, plus the
      // terminating NULL.
      if ( ( argv = ( char ** )sipMalloc( 2 * ( argc + 1 ) * sizeof( char * ) ) ) == NULL )
        return NULL;
 
      // Convert the list.
      for ( int a = 0; a < argc; ++a )
      {
        char *arg;
        // Get the argument and allocate memory for it.
        if ( ( arg = PyBytes_AsString( PyList_GET_ITEM( argvlist, a ) ) ) == NULL ||
             ( argv[a] = ( char * )sipMalloc( strlen( arg ) + 1 ) ) == NULL )
          return NULL;
        // Copy the argument and save a pointer to it.
        strcpy( argv[a], arg );
        argv[a + argc + 1] = argv[a];
      }
 
      argv[argc + argc + 1] = argv[argc] = NULL;
 
      return argv;
    }
 
    // Remove arguments from the Python argv list that have been removed from the
    // C argv array.
    static void qtgui_UpdatePyArgv( PyObject *argvlist, int argc, char **argv )
    {
      for ( int a = 0, na = 0; a < argc; ++a )
      {
        // See if it was removed.
        if ( argv[na] == argv[a + argc + 1] )
          ++na;
        else
          PyList_SetSlice( argvlist, na, na + 1, NULL );
      }
    }
    % End
// clang-format on
#endif
 
    // clang-format off
    Q_OBJECT
 
  public:

    enum StyleSheetType
    {
      Qt, 
      WebBrowser, 
    };
  // clang-format on
  static const char *QGIS_ORGANIZATION_NAME;
  static const char *QGIS_ORGANIZATION_DOMAIN;
  static const char *QGIS_APPLICATION_NAME;
#ifndef SIP_RUN

  QgsApplication(int &argc, char **argv, bool GUIenabled,
                 const QString &profileFolder = QString(),
                 const QString &platformName = "external");
#else
  // clang-format off

    QgsApplication( SIP_PYLIST argv, bool GUIenabled, QString profileFolder = QString(), QString platformName = "external" ) / PostHook = __pyQtQAppHook__ / [( int &argc, char **argv, bool GUIenabled, const QString &profileFolder = QString(), const QString &platformName = "desktop" )];
    % MethodCode
    // The Python interface is a list of argument strings that is modified.
 
    int argc;
    char **argv;
 
    // Convert the list.
    if ( ( argv = qtgui_ArgvToC( a0, argc ) ) == NULL )
      sipIsErr = 1;
    else
    {
      // Create it now the arguments are right.
      static int nargc = argc;
 
      sipCpp = new sipQgsApplication( nargc, argv, a1, *a2, *a3 );
 
      // Now modify the original list.
      qtgui_UpdatePyArgv( a0, argc, argv );
    }
    % End
// clang-format on
#endif
 
  ~QgsApplication() override;

  static QgsApplication *instance();

  static void init(QString profileFolder = QString()) SIP_SKIP;

  bool event(QEvent *event) override;

  bool notify(QObject *receiver, QEvent *event) override;

  static void setFileOpenEventReceiver(QObject *receiver);

  static void setThemeName(const QString &themeName);

  static QString resolvePkgPath();

  static QString themeName();

  static void setUITheme(const QString &themeName);

  static QHash<QString, QString> uiThemes();

  static QString authorsFilePath();

  static QString contributorsFilePath();

  static QString sponsorsFilePath();

  static QString donorsFilePath();

  static QString serverResourcesPath();

  static QString translatorsFilePath();

  static QString licenceFilePath();

  static QString i18nPath();

  static QString metadataPath();

  static QString qgisMasterDatabaseFilePath();

  static QString qgisSettingsDirPath();

  static QString qgisUserDatabaseFilePath();

  Q_DECL_DEPRECATED static QString qgisAuthDatabaseFilePath() SIP_DEPRECATED;

  static QString qgisAuthDatabaseUri();

  static QString splashPath();

  static QString iconsPath();

  static QString srsDatabaseFilePath();

  static void setSvgPaths(const QStringList &svgPaths);

  static QStringList svgPaths();

  static QStringList layoutTemplatePaths();

  static QMap<QString, QString> systemEnvVars();

  static QString prefixPath();

  static QString pluginPath();

  static QString pkgDataPath();

  static QString activeThemePath();

  static QString defaultThemePath();

  static QString iconPath(const QString &iconFile);

  static QIcon getThemeIcon(const QString &name,
                            const QColor &fillColor = QColor(),
                            const QColor &strokeColor = QColor());
 
  // clang-format off
  enum Cursor
  {
    ZoomIn, 
    ZoomOut, 
    Identify, 
    CrossHair, 
    CapturePoint, 
    Select, 
    Sampler, 
  };
  // clang-format on

  static QCursor getThemeCursor(Cursor cursor);

  static QPixmap getThemePixmap(const QString &name,
                                const QColor &foreColor = QColor(),
                                const QColor &backColor = QColor(),
                                int size = 16);

  static QString userStylePath();

  static QRegularExpression shortNameRegularExpression();

  static QString userLoginName();

  static QString userFullName();

  static QString osName();

  static int systemMemorySizeMb();

  static QString platform();

  static QString applicationFullName();

  static QString locale();

  static void setLocale(const QLocale &locale);

  static QString userThemesFolder();

  static QString defaultStylePath();

  static QString defaultThemesFolder();

  static QString libraryPath();

  static QString libexecPath();

  static QString qmlImportPath();

  static void setPrefixPath(const QString &prefixPath,
                            bool useDefaultPaths = false);

  static void setPluginPath(const QString &pluginPath);

  static void setPkgDataPath(const QString &pkgDataPath);

  static void setDefaultSvgPaths(const QStringList &pathList);

  static void setAuthDatabaseDirPath(const QString &authDbDirPath);

  static void initQgis();

  static bool createDatabase(QString *errorMessage = nullptr);

  static bool createThemeFolder();

  static void exitQgis();

  static QString appIconPath();
 
  // clang-format off
  enum endian_t
  {
    XDR = 0, // network, or big-endian, byte order
    NDR = 1 // little-endian byte order
  };
  // clang-format on

  static endian_t endian();

  static QString
  reportStyleSheet(QgsApplication::StyleSheetType styleSheetType =
                       QgsApplication::StyleSheetType::Qt);

  static QString showSettings();

  static void registerOgrDrivers();

  static QString absolutePathToRelativePath(const QString &apath,
                                            const QString &targetPath);
  static QString relativePathToAbsolutePath(const QString &rpath,
                                            const QString &targetPath);

  static bool isRunningFromBuildDir() { return ABISYM(mRunningFromBuildDir); }
#if defined(_MSC_VER) && !defined(USING_NMAKE) && !defined(USING_NINJA)
  static QString cfgIntDir() SIP_SKIP;
#endif

  static QString buildSourcePath();

  static QString buildOutputPath();

  static void skipGdalDriver(const QString &driver);

  static void restoreGdalDriver(const QString &driver);

  static QStringList skippedGdalDrivers();

  static void applyGdalSkippedDrivers();

  static void registerGdalDriversFromSettings();

  static QStringList deferredSkippedGdalDrivers();

  static void
  setSkippedGdalDrivers(const QStringList &skippedGdalDrivers,
                        const QStringList &deferredSkippedGdalDrivers);

  static int maxThreads();

  static void setMaxThreads(int maxThreads);

  static QgsTaskManager *taskManager();

  Q_DECL_DEPRECATED static QgsSettingsRegistryCore *
  settingsRegistryCore() SIP_KEEPREFERENCE SIP_DEPRECATED;

  static QgsColorSchemeRegistry *colorSchemeRegistry() SIP_KEEPREFERENCE;

  static QgsPaintEffectRegistry *paintEffectRegistry() SIP_KEEPREFERENCE;

  static QgsRendererRegistry *rendererRegistry() SIP_KEEPREFERENCE;

  static QgsRasterRendererRegistry *rasterRendererRegistry() SIP_SKIP;

  static QgsPointCloudRendererRegistry *
  pointCloudRendererRegistry() SIP_KEEPREFERENCE;

  static QgsTiledSceneRendererRegistry *
  tiledSceneRendererRegistry() SIP_KEEPREFERENCE;

  static QgsDataItemProviderRegistry *
  dataItemProviderRegistry() SIP_KEEPREFERENCE;

  static QgsCoordinateReferenceSystemRegistry *
  coordinateReferenceSystemRegistry() SIP_KEEPREFERENCE;

  static QgsSvgCache *svgCache();

  static QgsImageCache *imageCache();

  static QgsSourceCache *sourceCache();

  static QgsNetworkContentFetcherRegistry *
  networkContentFetcherRegistry() SIP_KEEPREFERENCE;

  static QgsValidityCheckRegistry *validityCheckRegistry() SIP_KEEPREFERENCE;

  static QgsSymbolLayerRegistry *symbolLayerRegistry() SIP_KEEPREFERENCE;

  static QgsCalloutRegistry *calloutRegistry() SIP_KEEPREFERENCE;

  static QgsLayoutItemRegistry *layoutItemRegistry() SIP_KEEPREFERENCE;

  static QgsAnnotationItemRegistry *annotationItemRegistry() SIP_KEEPREFERENCE;

  static QgsGpsConnectionRegistry *gpsConnectionRegistry() SIP_KEEPREFERENCE;

  static QgsBabelFormatRegistry *gpsBabelFormatRegistry() SIP_KEEPREFERENCE;

  static QgsPluginLayerRegistry *pluginLayerRegistry() SIP_KEEPREFERENCE;

  static QgsClassificationMethodRegistry *
  classificationMethodRegistry() SIP_KEEPREFERENCE;

  static QgsBookmarkManager *bookmarkManager();

  static QgsTileDownloadManager *tileDownloadManager() SIP_SKIP;

  static QgsRecentStyleHandler *recentStyleHandler() SIP_KEEPREFERENCE;

  static QgsDatabaseQueryLog *databaseQueryLog() SIP_KEEPREFERENCE;

  static QgsStyleModel *defaultStyleModel();

  static QgsFontManager *fontManager() SIP_KEEPREFERENCE;

  static QgsSensorRegistry *sensorRegistry() SIP_KEEPREFERENCE;

  static QgsPlotRegistry *plotRegistry() SIP_KEEPREFERENCE;

  static QgsMessageLog *messageLog();

  static QgsAuthManager *authManager();

  static QgsAuthConfigurationStorageRegistry *
  authConfigurationStorageRegistry();

  static QgsProcessingRegistry *processingRegistry();

  static QgsPageSizeRegistry *pageSizeRegistry() SIP_KEEPREFERENCE;

  static QgsAnnotationRegistry *annotationRegistry() SIP_SKIP;

  static QgsApplicationThemeRegistry *
  applicationThemeRegistry() SIP_KEEPREFERENCE;

  static QgsActionScopeRegistry *actionScopeRegistry() SIP_KEEPREFERENCE;

  static QgsConnectionRegistry *connectionRegistry();

  static QgsRuntimeProfiler *profiler();

  static QgsNumericFormatRegistry *numericFormatRegistry() SIP_KEEPREFERENCE;

  static QgsFieldFormatterRegistry *fieldFormatterRegistry() SIP_KEEPREFERENCE;

  static Qgs3DRendererRegistry *renderer3DRegistry() SIP_KEEPREFERENCE;

  static Qgs3DSymbolRegistry *symbol3DRegistry() SIP_KEEPREFERENCE;

  static QgsScaleBarRendererRegistry *
  scaleBarRendererRegistry() SIP_KEEPREFERENCE;

  static QgsLabelingEngineRuleRegistry *
  labelingEngineRuleRegistry() SIP_KEEPREFERENCE;

  static QgsProjectStorageRegistry *projectStorageRegistry() SIP_KEEPREFERENCE;

  static QgsLayerMetadataProviderRegistry *
  layerMetadataProviderRegistry() SIP_KEEPREFERENCE;

  static QgsExternalStorageRegistry *
  externalStorageRegistry() SIP_KEEPREFERENCE;

  static QgsProfileSourceRegistry *profileSourceRegistry() SIP_KEEPREFERENCE;

  static QgsLocalizedDataPathRegistry *
  localizedDataPathRegistry() SIP_KEEPREFERENCE;

  static QString nullRepresentation();

  static void setNullRepresentation(const QString &nullRepresentation);

  static QVariantMap customVariables();

  static void setCustomVariables(const QVariantMap &customVariables);

  static void setCustomVariable(const QString &name, const QVariant &value);

  static QStringList temporarilyTrustedProjectsFolders();

  static void setTemporarilyTrustedProjectsFolders(
      const QStringList &trustedProjectsFolders);

  static QStringList temporarilyUntrustedProjectsFolders();

  static void setTemporarilyUntrustedProjectsFolders(
      const QStringList &untrustedProjectsFolders);

  static int scaleIconSize(int standardSize,
                           bool applyDevicePixelRatio = false);

  int maxConcurrentConnectionsPerPool() const;

  static void setTranslation(const QString &translation);

  QString translation() const;

  void collectTranslatableObjects(QgsTranslationContext *translationContext);
 
#ifndef SIP_RUN
  static const QgsSettingsEntryString *settingsLocaleUserLocale;
  static const QgsSettingsEntryBool *settingsLocaleOverrideFlag;
  static const QgsSettingsEntryString *settingsLocaleGlobalLocale;
  static const QgsSettingsEntryBool *settingsLocaleShowGroupSeparator;
  static const QgsSettingsEntryStringList *settingsSearchPathsForSVG;

  static const QgsSettingsEntryInteger
      *settingsConnectionPoolMaximumConcurrentConnections;
#endif
 
#ifdef SIP_RUN
  SIP_IF_FEATURE(ANDROID)
  // dummy method to workaround sip generation issue
  bool x11EventFilter(XEvent *event);
  SIP_END
#endif
 
signals:
  void preNotify(QObject *receiver, QEvent *event, bool *done) SIP_SKIP;

  void customVariablesChanged();

  void nullRepresentationChanged();

  void requestForTranslatableObjects(QgsTranslationContext *translationContext);

  void localeChanged();

  void themeChanged();
 
private:
  static void copyPath(const QString &src, const QString &dst);
  static QObject *ABISYM(mFileOpenEventReceiver);
 
  static bool ABISYM(mInitialized);

  static bool ABISYM(mRunningFromBuildDir);

  static int ABISYM(sMaxThreads);
 
  QMap<QString, QIcon> mIconCache;
  QMap<Cursor, QCursor> mCursorCache;
 
  std::unique_ptr<QTranslator> mQgisTranslator;
  std::unique_ptr<QTranslator> mQtTranslator;
  std::unique_ptr<QTranslator> mQtBaseTranslator;
 
  std::unique_ptr<QgsDataItemProviderRegistry> mDataItemProviderRegistry;
  QgsAuthManager *mAuthManager = nullptr;
 
  struct ApplicationMembers;
 
  // Applications members which belong to an instance of QgsApplication
  std::unique_ptr<ApplicationMembers> mApplicationMembers;
  // ... but in case QgsApplication is never instantiated (eg with custom
  // designer widgets), we fall back to static members
  static ApplicationMembers *sApplicationMembers;
 
  static QgsAuthManager *sAuthManager;
 
  static ApplicationMembers *members();
 
  static void invalidateCaches();

  void installTranslators() SIP_SKIP;
 
  QStringList mTemporarilyTrustedProjectFolders;
  QStringList mTemporarilyUntrustedProjectFolders;
 
  friend class TestQgsApplication;
};
 
// clazy:excludeall=qstring-allocations
 
#endif