vtkResourceFileLocator.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkResourceFileLocator_h
#define vtkResourceFileLocator_h

#include "vtkCommonMiscModule.h" // For export macro
#include "vtkDeprecation.h"      // For VTK_DEPRECATED_IN_9_6_0
#include "vtkObject.h"

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

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


  vtkSetMacro(LogVerbosity, int);
  vtkGetMacro(LogVerbosity, int);

  virtual std::string Locate(const std::string& anchor, const std::string& landmark,
    const std::string& defaultDir = std::string());

  virtual std::string Locate(const std::string& anchor,
    const std::vector<std::string>& landmark_prefixes, const std::string& landmark,
    const std::string& defaultDir = std::string());

  static VTK_FILEPATH std::string GetLibraryPathForAddress(const void* ptr);

  static VTK_FILEPATH std::string GetCurrentExecutablePath();


  VTK_DEPRECATED_IN_9_6_0("Use GetLibraryPathForAddress() instead")
  static VTK_FILEPATH std::string GetLibraryPathForSymbolUnix(const char* symbolname);
  VTK_DEPRECATED_IN_9_6_0("Use GetLibraryPathForAddress() instead")
  static VTK_FILEPATH std::string GetLibraryPathForSymbolWin32(const void* fptr);

protected:
  vtkResourceFileLocator();
  ~vtkResourceFileLocator() override;

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

  int LogVerbosity;
};

#define vtkGetLibraryPathForSymbol(function)                                                       \
  vtkResourceFileLocator::GetLibraryPathForAddress(reinterpret_cast<const void*>(&function))

VTK_ABI_NAMESPACE_END
#endif