File indexing completed on 2024-04-14 03:48:01

 // SPDX-License-Identifier: LGPL-2.1-or-later
 //
 // SPDX-FileCopyrightText: 2006-2008 Torsten Rahn <tackat@kde.org>
 // SPDX-FileCopyrightText: 2009 Jens-Michael Hoffmann <jensmh@gmx.de>
 //
 
 #ifndef MARBLE_PLUGINMANAGER_H
 #define MARBLE_PLUGINMANAGER_H
 
 #include <QObject>
 #include <QList>
 #include "marble_export.h"
 
 
 namespace Marble
 {
 
 class RenderPlugin;
 class PositionProviderPlugin;
 class PluginManagerPrivate;
 class SearchRunnerPlugin;
 class ReverseGeocodingRunnerPlugin;
 class RoutingRunnerPlugin;
 class ParseRunnerPlugin;
 
 /**
  * @short The class that handles Marble's plugins.
  *
  * Ownership policy for plugins:
  *
  * On every invocation of createNetworkPlugins and
  * createFloatItems the PluginManager creates new objects and transfers
  * ownership to the calling site. In order to create
  * the objects, the PluginManager internally has a list of the plugins
  * which are owned by the PluginManager and destroyed by it.
  *
  */
 
 class MARBLE_EXPORT PluginManager : public QObject
 {
     Q_OBJECT
 
  public:
     explicit PluginManager( QObject* parent = nullptr );
 
     ~PluginManager() override;
 
     /**
      * @brief Returns all available RenderPlugins.
      *
      * Ownership of the items remains in PluginManager.
      * In order to use the RenderPlugins, first create new instances using
      * RenderPlugin::newInstance().
      */
     QList<const RenderPlugin *> renderPlugins() const;
 
     /**
      * @brief Add a RenderPlugin manually to the list of known plugins. Normally you
      * don't need to call this method since all plugins are loaded automatically.
      * @param plugin The plugin to add. Ownership retains with the caller.
      */
     void addRenderPlugin( const RenderPlugin *plugin );
 
     /**
      * @brief Returns all available PositionProviderPlugins.
      *
      * Ownership of the items remains in PluginManager.
      * In order to use the PositionProviderPlugins, first create new instances using
      * PositionProviderPlugin::newInstance().
      */
     QList<const PositionProviderPlugin *> positionProviderPlugins() const;
 
     /**
      * @brief Add a PositionProviderPlugin manually to the list of known plugins. Normally you
      * don't need to call this method since all plugins are loaded automatically.
      * @param plugin The plugin to add. Ownership retains with the caller.
      */
     void addPositionProviderPlugin( const PositionProviderPlugin *plugin );
 
     /**
      * Returns all search runner plugins.
      * @note: Runner plugins are owned by the PluginManager, do not delete them.
      */
     QList<const SearchRunnerPlugin *> searchRunnerPlugins() const;
 
     /**
      * @brief Add a SearchRunnerPlugin manually to the list of known plugins. Normally you
      * don't need to call this method since all plugins are loaded automatically.
      * @param plugin The plugin to add. Ownership retains with the caller.
      */
     void addSearchRunnerPlugin( const SearchRunnerPlugin *plugin );
 
     /**
      * Returns all reverse geocoding runner plugins.
      * @note: The runner plugins are owned by the PluginManager, do not delete them.
      */
     QList<const ReverseGeocodingRunnerPlugin *> reverseGeocodingRunnerPlugins() const;
 
     /**
      * @brief Add a ReverseGeocodingRunnerPlugin manually to the list of known plugins. Normally you
      * don't need to call this method since all plugins are loaded automatically.
      * @param plugin The plugin to add. Ownership retains with the caller.
      */
     void addReverseGeocodingRunnerPlugin( const ReverseGeocodingRunnerPlugin *plugin );
 
     /**
      * Returns all routing runner plugins.
      * @note: The runner plugins are owned by the PluginManager, do not delete them.
      */
     QList<RoutingRunnerPlugin *> routingRunnerPlugins() const;
 
     /**
      * @brief Add a RoutingRunnerPlugin manually to the list of known plugins. Normally you
      * don't need to call this method since all plugins are loaded automatically.
      * @param plugin The plugin to add. Ownership retains with the caller.
      */
     void addRoutingRunnerPlugin( RoutingRunnerPlugin * plugin );
 
     /**
      * Returns all parse runner plugins.
      * @note: The runner plugins are owned by the PluginManager, do not delete them.
      */
     QList<const ParseRunnerPlugin *> parsingRunnerPlugins() const;
 
     /**
      * @brief Add a ParseRunnerPlugin manually to the list of known plugins. Normally you
      * don't need to call this method since all plugins are loaded automatically.
      * @param plugin The plugin to add. Ownership retains with the caller.
      */
     void addParseRunnerPlugin( const ParseRunnerPlugin *plugin );
 
     /**
      * @brief blacklistPlugin Prevent that a plugin is loaded from the given filename
      * @param filename The name of the file (excluding prefix and file extension) to blacklist. E.g.
      * to ignore "libWikipedia.so" on Linux and "Wikipedia.dll" on Windows, pass "Wikipedia"
      */
     static void blacklistPlugin(const QString &filename);
 
     /**
      * @brief whitelistPlugin Add a plugin to the whitelist of plugins. If the whitelist is not
      * empty, only whitelisted plugins are loaded. If a plugin is both whitelisted and blacklisted,
      * it will not be loaded
      * @param filename The name of the file (excluding prefix and file extension) to whitelist. E.g.
      * to ignore "libWikipedia.so" on Linux and "Wikipedia.dll" on Windows, pass "Wikipedia"
      */
     static void whitelistPlugin(const QString &filename);
 
 Q_SIGNALS:
     void renderPluginsChanged();
 
     void positionProviderPluginsChanged();
 
     void searchRunnerPluginsChanged();
 
     void reverseGeocodingRunnerPluginsChanged();
 
     void routingRunnerPluginsChanged();
 
     void parseRunnerPluginsChanged();
 
  private:
     Q_DISABLE_COPY( PluginManager )
 
 #ifdef Q_OS_ANDROID
     void installPluginsFromAssets() const;
 #endif
 
     PluginManagerPrivate  * const d;
 };
 
 }
 
 #endif