pqPluginManager.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause

#ifndef pqPluginManager_h
#define pqPluginManager_h

#include "pqCoreModule.h"
#include <QObject>
#include <QStringList>

class pqServer;
class vtkPVPlugin;
class vtkPVPluginsInformation;
class vtkSMPluginManager;

class PQCORE_EXPORT pqPluginManager : public QObject
{
  Q_OBJECT
  typedef QObject Superclass;

public:
  pqPluginManager(QObject* p = nullptr);
  ~pqPluginManager() override;

  void loadPluginsFromSettings();

  enum LoadStatus
  {
    LOADED,
    NOTLOADED,
    ALREADYLOADED
  };

  LoadStatus loadExtension(
    pqServer* session, const QString& plugin, QString* errorMsg = nullptr, bool remote = true);

  void loadExtensions(pqServer*);

  vtkPVPluginsInformation* loadedExtensions(pqServer* session, bool remote);

  QStringList pluginPaths(pqServer* session, bool remote);

  void addPluginConfigFile(pqServer* session, const QString& config, bool remote = true);

  void hidePlugin(const QString& lib, bool remote);
  bool isHidden(const QString& lib, bool remote);

  bool verifyPlugins(pqServer* session);

Q_SIGNALS:
  void pluginsUpdated();

  void requiredPluginsNotLoaded(pqServer*);

protected:
  void initialize(vtkSMPluginManager*);

protected Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
  void loadPluginsFromSettings(pqServer*);

  void onServerConnected(pqServer*);
  void onServerDisconnected(pqServer*);
  void updatePluginLists();

private:
  class pqInternals;
  pqInternals* Internals;

  static bool confirmEULA(vtkPVPlugin* plugin);
};

#endif