vtkSMReaderFactory.h

Go to the documentation of this file.

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

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

#include <string>
#include <vector>

class vtkStringList;
class vtkPVXMLElement;
class vtkSMProxy;
class vtkSMSession;

struct FileTypeDetailed
{
  std::string Description;
  std::vector<std::string> FilenamePatterns = {};
  std::string Group;
  std::string Name;
};

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

  void Initialize();

  void RegisterPrototype(const char* xmlgroup, const char* xmlname);

  bool CanReadFile(const char* filename, vtkSMSession* session);


  vtkGetStringMacro(ReaderName);


  vtkGetStringMacro(ReaderGroup);

  vtkStringList* GetPossibleReaders(const char* filename, vtkSMSession* session);

  vtkStringList* GetReaders(vtkSMSession* session);

  vtkStringList* GetReaders(const char* filename, vtkSMSession* session);

  static bool TestFileReadability(const char* filename, vtkSMSession* session);

  virtual const char* GetSupportedFileTypes(vtkSMSession* session);

  virtual std::vector<FileTypeDetailed> GetSupportedFileTypesDetailed(vtkSMSession* session);


  static bool CanReadFile(const char* filename, vtkSMProxy* reader);
  static bool CanReadFile(const char* filename, const char* readerxmlgroup,
    const char* readerxmlname, vtkSMSession* session);

  unsigned int GetNumberOfRegisteredPrototypes();

  virtual void UpdateAvailableReaders();


  void AddGroup(const char* groupName);
  void RemoveGroup(const char* groupName);
  void GetGroups(vtkStringList* groups);

  static void AddReaderToWhitelist(const char* readerxmlgroup, const char* readerxmlname);

  static const std::string SUPPORTED_TYPES_DESCRIPTION;

  static const std::string ALL_FILES_DESCRIPTION;

protected:
  vtkSMReaderFactory();
  ~vtkSMReaderFactory() override;

  // To support legacy configuration files.
  void RegisterPrototype(
    const char* xmlgroup, const char* xmlname, const char* extensions, const char* description);

  static bool GetFilenameIsDirectory(const char* fname, vtkSMSession* session);

  vtkSetStringMacro(ReaderName);
  vtkSetStringMacro(ReaderGroup);

  char* ReaderName;
  char* ReaderGroup;
  vtkStringList* Readers;

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

  class vtkInternals;
  vtkInternals* Internals;
};

#endif