vtkPVPluginTracker.h

Go to the documentation of this file.

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

#include "vtkCommand.h" // needed for vtkCommand
#include "vtkObject.h"
#include "vtkRemotingCoreModule.h" // needed for exports
#include "vtkSmartPointer.h"       // needed for vtkSmartPointer

#include <vector> // for std::vector

class vtkPVPlugin;
class vtkPVXMLElement;

typedef bool (*vtkPluginSearchFunction)(const char*);
typedef void (*vtkPluginListFunction)(const char* appname, std::vector<std::string>& names);

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

  static vtkPVPluginTracker* GetInstance();

  void RegisterPlugin(vtkPVPlugin*);


  void LoadPluginConfigurationXMLs(const char* appname);
  void LoadPluginConfigurationXML(const char* filename, bool forceLoad = false);
  void LoadPluginConfigurationXML(vtkPVXMLElement*, bool forceLoad = false);
  void LoadPluginConfigurationXMLFromString(const char* xmlcontents, bool forceLoad = false);

  unsigned int GetNumberOfPlugins();

  vtkPVPlugin* GetPlugin(unsigned int index);


  const char* GetPluginName(unsigned int index);
  const char* GetPluginFileName(unsigned int index);
  bool GetPluginLoaded(unsigned int index);
  bool GetPluginAutoLoad(unsigned int index);
  bool GetPluginDelayedLoad(unsigned int index);
  std::vector<std::string> GetPluginXMLs(unsigned int index);
  std::string GetPluginVersion(unsigned int index);
  std::string GetPluginDescription(unsigned int index);


  static void RegisterStaticPluginSearchFunction(vtkPluginSearchFunction function);
  static void RegisterStaticPluginListFunction(vtkPluginListFunction function);

  enum
  {
    RegisterAvailablePluginEvent = vtkCommand::UserEvent + 91
  };

protected:
  vtkPVPluginTracker();
  ~vtkPVPluginTracker() override;

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

  class vtkPluginsList;
  vtkPluginsList* PluginsList;

  void LoadPluginConfigurationXMLConf(std::string const& exe_dir, std::string const& conf);
  void LoadPluginConfigurationXMLHinted(vtkPVXMLElement*, const char* hint, bool forceLoad);
};

#endif