vtkSMPluginManager.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSMPluginManager_h
#define vtkSMPluginManager_h

#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMObject.h"

class vtkPVPluginsInformation;
class vtkSMSession;

class VTKREMOTINGSERVERMANAGER_EXPORT vtkSMPluginManager : public vtkSMObject
{
public:
  static vtkSMPluginManager* New();
  vtkTypeMacro(vtkSMPluginManager, vtkSMObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  void RegisterSession(vtkSMSession*);
  void UnRegisterSession(vtkSMSession*);


  vtkGetObjectMacro(LocalInformation, vtkPVPluginsInformation);
  vtkPVPluginsInformation* GetRemoteInformation(vtkSMSession*);


  const char* GetLocalPluginSearchPaths();
  const char* GetRemotePluginSearchPaths(vtkSMSession*);


  bool LoadRemotePlugin(const char* plugin, vtkSMSession*);
  bool LoadLocalPlugin(const char* plugin);


  void LoadPluginConfigurationXMLFromString(
    const char* xmlcontents, vtkSMSession* session, bool remote);
  void LoadPluginConfigurationXML(
    const char* configurationFile, vtkSMSession* session, bool remote);

  bool FulfillPluginRequirements(vtkSMSession* session, bool onlyCheck = false);

  enum
  {
    PluginLoadedEvent = 100000,
    LocalPluginLoadedEvent,
    RemotePluginLoadedEvent
  };

protected:
  vtkSMPluginManager();
  ~vtkSMPluginManager() override;

  bool InLoadPlugin;
  void OnPluginRegistered();
  void OnPluginAvailable();
  void UpdateLocalPluginInformation();

  bool FulfillPluginClientServerRequirements(vtkSMSession* session,
    const std::map<std::string, unsigned int>& inputMap, vtkPVPluginsInformation* inputPluginInfo,
    const std::map<std::string, unsigned int>& outputMap, vtkPVPluginsInformation* outputPluginInfo,
    bool inputClient, bool onlyCheck);

  vtkPVPluginsInformation* LocalInformation;

private:
  vtkSMPluginManager(const vtkSMPluginManager&) = delete;
  void operator=(const vtkSMPluginManager&) = delete;

  class vtkInternals;
  vtkInternals* Internals;
};

#endif