vtkPVPluginLoader.h

Go to the documentation of this file.

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

#include "vtkObject.h"
#include "vtkParaViewDeprecation.h" // for deprecation macro
#include "vtkRemotingCoreModule.h"  //needed for exports

#include <functional> // for std::function

class vtkPVPlugin;

class VTKREMOTINGCORE_EXPORT vtkPVPluginLoader : public vtkObject
{
public:
  static vtkPVPluginLoader* New();
  vtkTypeMacro(vtkPVPluginLoader, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  bool LoadPluginByName(const char* name, bool acceptDelayed = true);

  bool LoadPlugin(const char* filename) { return this->LoadPluginInternal(filename, false); }
  bool LoadPluginSilently(const char* filename) { return this->LoadPluginInternal(filename, true); }

  PARAVIEW_DEPRECATED_IN_5_14_0("Use LoadDelayedLoadPlugin instead")
  bool LoadDelayedLoadPlugin(
    const std::string& name, const std::vector<std::string>& xmls, const std::string& filename);

  bool LoadDelayedLoadPlugin(const std::string& name, const std::vector<std::string>& xmls,
    const std::string& filename, const std::string& version, const std::string& description);


  void LoadPluginConfigurationXMLFromString(const char* xmlcontents);
  void LoadPluginConfigurationXML(const char* configurationFile);

  void LoadPluginsFromPluginSearchPath();

  void LoadPluginsFromPluginConfigFile();

  void LoadPluginsFromPath(const char* path);


  vtkGetStringMacro(FileName);


  vtkGetStringMacro(PluginName);


  vtkGetStringMacro(PluginVersion);


  vtkGetStringMacro(ErrorString);


  vtkGetStringMacro(SearchPaths);


  vtkGetMacro(Loaded, bool);


  using PluginLoaderCallback = std::function<bool(const char*)>;
  static int RegisterLoadPluginCallback(PluginLoaderCallback callback);
  static void UnregisterLoadPluginCallback(int id);

  static void PluginLibraryUnloaded(const char* pluginname);

protected:
  vtkPVPluginLoader();
  ~vtkPVPluginLoader() override;

  bool LoadPluginInternal(const char* filename, bool no_errors);

  bool LoadPluginInternal(vtkPVPlugin* plugin);

  bool IsLoaded(const char* filename, bool acceptDelayed = false);

  vtkSetStringMacro(ErrorString);
  vtkSetStringMacro(PluginName);
  vtkSetStringMacro(PluginVersion);
  vtkSetStringMacro(FileName);
  vtkSetStringMacro(SearchPaths);

  char* ErrorString;
  char* PluginName;
  char* PluginVersion;
  char* FileName;
  char* SearchPaths;
  bool Loaded;

private:
  vtkPVPluginLoader(const vtkPVPluginLoader&) = delete;
  void operator=(const vtkPVPluginLoader&) = delete;
  static bool CallPluginLoaderCallbacks(const char* nameOrFile);
};

// Implementation of Schwartz counter idiom to ensure that the plugin library
// unloading doesn't happen before the ParaView application is finalized.
static class VTKREMOTINGCORE_EXPORT vtkPVPluginLoaderCleanerInitializer
{
public:
  vtkPVPluginLoaderCleanerInitializer();
  ~vtkPVPluginLoaderCleanerInitializer();
} vtkPVPluginLoaderCleanerInitializerInstance; // object here in header.

#endif